Navigation
API > API/Runtime > API/Runtime/Core
Base class for platform properties.
These are shared between: the runtime platform - via FPlatformProperties the target platforms - via ITargetPlatform
| Name | FGenericPlatformProperties |
| Type | struct |
| Header File | /Engine/Source/Runtime/Core/Public/GenericPlatform/GenericPlatformProperties.h |
| Include Path | #include "GenericPlatform/GenericPlatformProperties.h" |
Syntax
struct FGenericPlatformProperties
Functions
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool AllowsCallStackDumpDuringAssert() |
Whether the platform allows the call stack to be dumped during an assert. | GenericPlatform/GenericPlatformProperties.h | |
static bool AllowsFramerateSmoothing() |
Whether this platform wants to allow framerate smoothing or not. | GenericPlatform/GenericPlatformProperties.h | |
static int GetMaxSupportedVirtualMemoryAlignment() |
Guaranteed virtual memory alignment on a given platform, regardless of a specific device. | GenericPlatform/GenericPlatformProperties.h | |
static int64 GetMemoryMappingAlignment() |
GenericPlatform/GenericPlatformProperties.h | ||
static const char * GetPhysicsFormat() |
Gets the platform's physics format. | GenericPlatform/GenericPlatformProperties.h | |
static const char * GetZlibReplacementFormat() |
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 | GenericPlatform/GenericPlatformProperties.h | |
static bool HasEditorOnlyData() |
Gets whether this platform has Editor-only data. | GenericPlatform/GenericPlatformProperties.h | |
static bool HasFixedResolution() |
Gets whether user settings should override the resolution or not | GenericPlatform/GenericPlatformProperties.h | |
static bool HasSecurePackageFormat() |
Checks whether shipped data on this platform is secure, and doesn't require extra encryption/signing to protect it. | GenericPlatform/GenericPlatformProperties.h | |
static const char * IniPlatformName () |
Gets the name of this platform when loading INI files. | GenericPlatform/GenericPlatformProperties.h | |
static bool IsClientOnly() |
Gets whether this is a client only (no capability to run the game without connecting to a server) platform. | GenericPlatform/GenericPlatformProperties.h | |
static bool IsGameOnly() |
Gets whether this is a game only platform. | GenericPlatform/GenericPlatformProperties.h | |
static bool IsLittleEndian() |
Gets whether this is a Little Endian platform. | GenericPlatform/GenericPlatformProperties.h | |
static bool IsMonolithicBuild() |
Gets whether this was a monolithic build or not | GenericPlatform/GenericPlatformProperties.h | |
static bool IsProgram() |
Gets whether this was a program or not | GenericPlatform/GenericPlatformProperties.h | |
static bool IsServerOnly() |
Gets whether this is a server only platform. | GenericPlatform/GenericPlatformProperties.h | |
static const char * PlatformName() |
Gets the name of this platformNote: MUST be implemented per platform. | GenericPlatform/GenericPlatformProperties.h | |
static const char * PlatformVariantName () |
Get the name of the hardware variant of the current platform. | GenericPlatform/GenericPlatformProperties.h | |
static bool RequiresCookedData() |
Checks whether this platform requires cooked data. | GenericPlatform/GenericPlatformProperties.h | |
static bool RequiresOriginalReleaseVersionForPatch() |
Whether the platform requires an original release version to make a patch. | GenericPlatform/GenericPlatformProperties.h | |
static bool RequiresUserCredentials() |
Checks whether this platform requires user credentials (typically server platforms). | GenericPlatform/GenericPlatformProperties.h | |
static bool SupportsAudioStreaming() |
Whether this platform supports streaming audio | GenericPlatform/GenericPlatformProperties.h | |
static bool SupportsAutoSDK() |
Returns true if platform supports the AutoSDK system | GenericPlatform/GenericPlatformProperties.h | |
static bool SupportsBuildTarget
(
EBuildTargetType TargetType |
Checks whether the specified build target is supported. | GenericPlatform/GenericPlatformProperties.h | |
static bool SupportsDistanceFieldAO() |
GenericPlatform/GenericPlatformProperties.h | ||
static bool SupportsDistanceFieldShadows() |
GenericPlatform/GenericPlatformProperties.h | ||
static bool SupportsGrayscaleSRGB() |
Gets whether this platform supports gray scale sRGB texture formats. | GenericPlatform/GenericPlatformProperties.h | |
static bool SupportsHardwareLZDecompression() |
GenericPlatform/GenericPlatformProperties.h | ||
static bool SupportsHighQualityLightmaps() |
GenericPlatform/GenericPlatformProperties.h | ||
static bool SupportsLowQualityLightmaps() |
GenericPlatform/GenericPlatformProperties.h | ||
static bool SupportsLumenGI() |
GenericPlatform/GenericPlatformProperties.h | ||
static bool SupportsMemoryMappedAnimation() |
GenericPlatform/GenericPlatformProperties.h | ||
static bool SupportsMemoryMappedAudio() |
GenericPlatform/GenericPlatformProperties.h | ||
static bool SupportsMemoryMappedFiles() |
GenericPlatform/GenericPlatformProperties.h | ||
static bool SupportsMeshLODStreaming() |
GenericPlatform/GenericPlatformProperties.h | ||
static bool SupportsMinimize() |
GenericPlatform/GenericPlatformProperties.h | ||
static bool SupportsMultipleGameInstances() |
Checks whether this platforms supports running multiple game instances on a single device. | GenericPlatform/GenericPlatformProperties.h | |
static bool SupportsQuit() |
Whether the platform allows an application to quit to the OS. | GenericPlatform/GenericPlatformProperties.h | |
static bool SupportsRayTracing() |
GenericPlatform/GenericPlatformProperties.h | ||
static bool SupportsTextureStreaming() |
GenericPlatform/GenericPlatformProperties.h | ||
static bool SupportsWindowedMode() |
Gets whether this platform supports windowed mode rendering. | GenericPlatform/GenericPlatformProperties.h |