GenericPlatformProperties.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "GenericPlatform/GenericPlatformMisc.h"
 
 
struct FGenericPlatformProperties
{
    static constexpr UE_FORCEINLINE_HINT const char* GetPhysicsFormat()
    {
        return "Chaos";
    }
 
    static constexpr UE_FORCEINLINE_HINT bool HasEditorOnlyData()
    {
        return WITH_EDITORONLY_DATA;
    }
 
    static const char* IniPlatformName();
 
    static constexpr UE_FORCEINLINE_HINT bool IsGameOnly()
    {
        return UE_GAME;
    }
 
    static constexpr UE_FORCEINLINE_HINT bool IsServerOnly()
    {
        return UE_SERVER;
    }
 
    static constexpr UE_FORCEINLINE_HINT bool IsClientOnly()
    {
        return !WITH_SERVER_CODE;
    }
 
    static constexpr UE_FORCEINLINE_HINT bool IsMonolithicBuild()
    {
        return IS_MONOLITHIC;
    }
 
    static constexpr UE_FORCEINLINE_HINT bool IsProgram()
    {
        return IS_PROGRAM;
    }
 
    static constexpr UE_FORCEINLINE_HINT bool IsLittleEndian()
    {
        return true;
    }
 
    static UE_FORCEINLINE_HINT const char* PlatformName();
 
    static UE_FORCEINLINE_HINT const char* PlatformVariantName()
    {
        return "";
    }
 
    static constexpr UE_FORCEINLINE_HINT bool RequiresCookedData()
    {
        return !HasEditorOnlyData();
    }
 
    static constexpr UE_FORCEINLINE_HINT bool HasSecurePackageFormat()
    {
        return false;
    }
 
    static constexpr UE_FORCEINLINE_HINT bool RequiresUserCredentials()
    {
        return false;
    }
 
    static UE_FORCEINLINE_HINT bool SupportsBuildTarget(EBuildTargetType TargetType)
    {
        return true;
    }
 
    static constexpr UE_FORCEINLINE_HINT bool SupportsAutoSDK()
    {
        return false;
    }
 
    static constexpr UE_FORCEINLINE_HINT bool SupportsGrayscaleSRGB()
    {
        return true;
    }
 
    static constexpr UE_FORCEINLINE_HINT bool SupportsMultipleGameInstances()
    {
        return false;
    }
 
    static constexpr UE_FORCEINLINE_HINT bool SupportsWindowedMode()
    {
        return false;
    }
 
    static constexpr UE_FORCEINLINE_HINT bool AllowsFramerateSmoothing()
    {
        return true;
    }
 
    static constexpr UE_FORCEINLINE_HINT bool SupportsAudioStreaming()
    {
        return false;
    }
 
    static constexpr UE_FORCEINLINE_HINT bool SupportsHighQualityLightmaps()
    {
        return true;
    }
 
    static constexpr UE_FORCEINLINE_HINT bool SupportsLowQualityLightmaps()
    {
        return true;
    }
 
    static constexpr UE_FORCEINLINE_HINT bool SupportsDistanceFieldShadows()
    {
        return true;
    }
 
    static constexpr UE_FORCEINLINE_HINT bool SupportsDistanceFieldAO()
    {
        return true;
    }
 
    static constexpr UE_FORCEINLINE_HINT bool SupportsTextureStreaming()
    {
        return true;
    }
 
    static constexpr UE_FORCEINLINE_HINT bool SupportsMeshLODStreaming()
    {
        return false;
    }
 
    static constexpr UE_FORCEINLINE_HINT bool SupportsMemoryMappedFiles()
    {
        return false;
    }
 
    static constexpr UE_FORCEINLINE_HINT bool SupportsMemoryMappedAudio()
    {
        return false;
    }
 
    static constexpr UE_FORCEINLINE_HINT bool SupportsMemoryMappedAnimation()
    {
        return false;
    }
 
    static constexpr UE_FORCEINLINE_HINT int64 GetMemoryMappingAlignment()
    {
        return 0;
    }
 
    // Guaranteed virtual memory alignment on a given platform, regardless of a specific device
    static constexpr UE_FORCEINLINE_HINT int GetMaxSupportedVirtualMemoryAlignment()
    {
        return 4096;
    }
    
    static constexpr UE_FORCEINLINE_HINT bool SupportsRayTracing()
    {
        return false;
    }
 
    static constexpr UE_FORCEINLINE_HINT bool SupportsLumenGI()
    {
        return true;
    }
 
    static constexpr UE_FORCEINLINE_HINT bool SupportsHardwareLZDecompression()
    {
        return false;
    }
 
    static constexpr UE_FORCEINLINE_HINT bool HasFixedResolution()
    {
        return true;
    }
 
    static constexpr UE_FORCEINLINE_HINT bool SupportsMinimize()
    {
        return false;
    }
 
    // Whether the platform allows an application to quit to the OS
    static constexpr UE_FORCEINLINE_HINT bool SupportsQuit()
    {
        return false;
    }
 
    // Whether the platform allows the call stack to be dumped during an assert
    static constexpr UE_FORCEINLINE_HINT bool AllowsCallStackDumpDuringAssert()
    {
        return IsProgram();
    }
 
    // If this platform wants to replace Zlib with a platform-specific version, set the name of the compression format 
    // plugin (matching its GetCompressionFormatName() function) in an override of this function
    static constexpr UE_FORCEINLINE_HINT const char* GetZlibReplacementFormat()
    {
        return nullptr;
    }
     
    // Whether the platform requires an original release version to make a patch
    static constexpr UE_FORCEINLINE_HINT bool RequiresOriginalReleaseVersionForPatch()
    {
        return false;
    }
};