UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Static Public Member Functions | List of all members
FGenericPlatformProperties Struct Reference

#include <GenericPlatformProperties.h>

+ Inheritance diagram for FGenericPlatformProperties:

Static Public Member Functions

static constexpr UE_FORCEINLINE_HINT const char * GetPhysicsFormat ()
 
static constexpr UE_FORCEINLINE_HINT bool HasEditorOnlyData ()
 
static const char * IniPlatformName ()
 
static constexpr UE_FORCEINLINE_HINT bool IsGameOnly ()
 
static constexpr UE_FORCEINLINE_HINT bool IsServerOnly ()
 
static constexpr UE_FORCEINLINE_HINT bool IsClientOnly ()
 
static constexpr UE_FORCEINLINE_HINT bool IsMonolithicBuild ()
 
static constexpr UE_FORCEINLINE_HINT bool IsProgram ()
 
static constexpr UE_FORCEINLINE_HINT bool IsLittleEndian ()
 
static UE_FORCEINLINE_HINT const char * PlatformName ()
 
static UE_FORCEINLINE_HINT const char * PlatformVariantName ()
 
static constexpr UE_FORCEINLINE_HINT bool RequiresCookedData ()
 
static constexpr UE_FORCEINLINE_HINT bool HasSecurePackageFormat ()
 
static constexpr UE_FORCEINLINE_HINT bool RequiresUserCredentials ()
 
static UE_FORCEINLINE_HINT bool SupportsBuildTarget (EBuildTargetType TargetType)
 
static constexpr UE_FORCEINLINE_HINT bool SupportsAutoSDK ()
 
static constexpr UE_FORCEINLINE_HINT bool SupportsGrayscaleSRGB ()
 
static constexpr UE_FORCEINLINE_HINT bool SupportsMultipleGameInstances ()
 
static constexpr UE_FORCEINLINE_HINT bool SupportsWindowedMode ()
 
static constexpr UE_FORCEINLINE_HINT bool AllowsFramerateSmoothing ()
 
static constexpr UE_FORCEINLINE_HINT bool SupportsAudioStreaming ()
 
static constexpr UE_FORCEINLINE_HINT bool SupportsHighQualityLightmaps ()
 
static constexpr UE_FORCEINLINE_HINT bool SupportsLowQualityLightmaps ()
 
static constexpr UE_FORCEINLINE_HINT bool SupportsDistanceFieldShadows ()
 
static constexpr UE_FORCEINLINE_HINT bool SupportsDistanceFieldAO ()
 
static constexpr UE_FORCEINLINE_HINT bool SupportsTextureStreaming ()
 
static constexpr UE_FORCEINLINE_HINT bool SupportsMeshLODStreaming ()
 
static constexpr UE_FORCEINLINE_HINT bool SupportsMemoryMappedFiles ()
 
static constexpr UE_FORCEINLINE_HINT bool SupportsMemoryMappedAudio ()
 
static constexpr UE_FORCEINLINE_HINT bool SupportsMemoryMappedAnimation ()
 
static constexpr UE_FORCEINLINE_HINT int64 GetMemoryMappingAlignment ()
 
static constexpr UE_FORCEINLINE_HINT int GetMaxSupportedVirtualMemoryAlignment ()
 
static constexpr UE_FORCEINLINE_HINT bool SupportsRayTracing ()
 
static constexpr UE_FORCEINLINE_HINT bool SupportsLumenGI ()
 
static constexpr UE_FORCEINLINE_HINT bool SupportsHardwareLZDecompression ()
 
static constexpr UE_FORCEINLINE_HINT bool HasFixedResolution ()
 
static constexpr UE_FORCEINLINE_HINT bool SupportsMinimize ()
 
static constexpr UE_FORCEINLINE_HINT bool SupportsQuit ()
 
static constexpr UE_FORCEINLINE_HINT bool AllowsCallStackDumpDuringAssert ()
 
static constexpr UE_FORCEINLINE_HINT const char * GetZlibReplacementFormat ()
 
static constexpr UE_FORCEINLINE_HINT bool RequiresOriginalReleaseVersionForPatch ()
 

Detailed Description

Base class for platform properties.

These are shared between: the runtime platform - via FPlatformProperties the target platforms - via ITargetPlatform

Member Function Documentation

◆ AllowsCallStackDumpDuringAssert()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::AllowsCallStackDumpDuringAssert ( )
inlinestaticconstexpr

◆ AllowsFramerateSmoothing()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::AllowsFramerateSmoothing ( )
inlinestaticconstexpr

Whether this platform wants to allow framerate smoothing or not.

◆ GetMaxSupportedVirtualMemoryAlignment()

static constexpr UE_FORCEINLINE_HINT int FGenericPlatformProperties::GetMaxSupportedVirtualMemoryAlignment ( )
inlinestaticconstexpr

◆ GetMemoryMappingAlignment()

static constexpr UE_FORCEINLINE_HINT int64 FGenericPlatformProperties::GetMemoryMappingAlignment ( )
inlinestaticconstexpr

◆ GetPhysicsFormat()

static constexpr UE_FORCEINLINE_HINT const char * FGenericPlatformProperties::GetPhysicsFormat ( )
inlinestaticconstexpr

Gets the platform's physics format.

Returns
The physics format name.

◆ GetZlibReplacementFormat()

static constexpr UE_FORCEINLINE_HINT const char * FGenericPlatformProperties::GetZlibReplacementFormat ( )
inlinestaticconstexpr

◆ HasEditorOnlyData()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::HasEditorOnlyData ( )
inlinestaticconstexpr

Gets whether this platform has Editor-only data.

Returns
true if the platform has Editor-only data, false otherwise.

◆ HasFixedResolution()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::HasFixedResolution ( )
inlinestaticconstexpr

Gets whether user settings should override the resolution or not

◆ HasSecurePackageFormat()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::HasSecurePackageFormat ( )
inlinestaticconstexpr

Checks whether shipped data on this platform is secure, and doesn't require extra encryption/signing to protect it.

Returns
true if packaged data is considered secure, false otherwise.

◆ IniPlatformName()

const char * FGenericPlatformProperties::IniPlatformName ( )
static

Gets the name of this platform when loading INI files. Defaults to PlatformName.

Note: MUST be implemented per platform.

Returns
Platform name.

◆ IsClientOnly()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::IsClientOnly ( )
inlinestaticconstexpr

Gets whether this is a client only (no capability to run the game without connecting to a server) platform.

Returns
true if this is a client only platform, false otherwise.

◆ IsGameOnly()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::IsGameOnly ( )
inlinestaticconstexpr

Gets whether this is a game only platform.

Returns
true if this is a game only platform, false otherwise.

◆ IsLittleEndian()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::IsLittleEndian ( )
inlinestaticconstexpr

Gets whether this is a Little Endian platform.

Returns
true if the platform is Little Endian, false otherwise.

◆ IsMonolithicBuild()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::IsMonolithicBuild ( )
inlinestaticconstexpr

Gets whether this was a monolithic build or not

◆ IsProgram()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::IsProgram ( )
inlinestaticconstexpr

Gets whether this was a program or not

◆ IsServerOnly()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::IsServerOnly ( )
inlinestaticconstexpr

Gets whether this is a server only platform.

Returns
true if this is a server only platform, false otherwise.

◆ PlatformName()

static UE_FORCEINLINE_HINT const char * FGenericPlatformProperties::PlatformName ( )
static

Gets the name of this platform

Note: MUST be implemented per platform.

Returns
Platform Name.

◆ PlatformVariantName()

static UE_FORCEINLINE_HINT const char * FGenericPlatformProperties::PlatformVariantName ( )
inlinestatic

Get the name of the hardware variant of the current platform.

Most platforms don't need to provide overrides for this member. This member is intended to be used by the few which come in different hardware flavours or which may operate in different runtime modes.

Returns
Name of the platform variant.

◆ RequiresCookedData()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::RequiresCookedData ( )
inlinestaticconstexpr

Checks whether this platform requires cooked data.

Returns
true if cooked data is required, false otherwise.

◆ RequiresOriginalReleaseVersionForPatch()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::RequiresOriginalReleaseVersionForPatch ( )
inlinestaticconstexpr

◆ RequiresUserCredentials()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::RequiresUserCredentials ( )
inlinestaticconstexpr

Checks whether this platform requires user credentials (typically server platforms).

Returns
true if this platform requires user credentials, false otherwise.

◆ SupportsAudioStreaming()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::SupportsAudioStreaming ( )
inlinestaticconstexpr

Whether this platform supports streaming audio

◆ SupportsAutoSDK()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::SupportsAutoSDK ( )
inlinestaticconstexpr

Returns true if platform supports the AutoSDK system

◆ SupportsBuildTarget()

static UE_FORCEINLINE_HINT bool FGenericPlatformProperties::SupportsBuildTarget ( EBuildTargetType  TargetType)
inlinestatic

Checks whether the specified build target is supported.

Parameters
TargetTypeThe build target to check.
Returns
true if the build target is supported, false otherwise.

◆ SupportsDistanceFieldAO()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::SupportsDistanceFieldAO ( )
inlinestaticconstexpr

◆ SupportsDistanceFieldShadows()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::SupportsDistanceFieldShadows ( )
inlinestaticconstexpr

◆ SupportsGrayscaleSRGB()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::SupportsGrayscaleSRGB ( )
inlinestaticconstexpr

Gets whether this platform supports gray scale sRGB texture formats.

Returns
true if gray scale sRGB texture formats are supported.

◆ SupportsHardwareLZDecompression()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::SupportsHardwareLZDecompression ( )
inlinestaticconstexpr

◆ SupportsHighQualityLightmaps()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::SupportsHighQualityLightmaps ( )
inlinestaticconstexpr

◆ SupportsLowQualityLightmaps()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::SupportsLowQualityLightmaps ( )
inlinestaticconstexpr

◆ SupportsLumenGI()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::SupportsLumenGI ( )
inlinestaticconstexpr

◆ SupportsMemoryMappedAnimation()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::SupportsMemoryMappedAnimation ( )
inlinestaticconstexpr

◆ SupportsMemoryMappedAudio()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::SupportsMemoryMappedAudio ( )
inlinestaticconstexpr

◆ SupportsMemoryMappedFiles()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::SupportsMemoryMappedFiles ( )
inlinestaticconstexpr

◆ SupportsMeshLODStreaming()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::SupportsMeshLODStreaming ( )
inlinestaticconstexpr

◆ SupportsMinimize()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::SupportsMinimize ( )
inlinestaticconstexpr

◆ SupportsMultipleGameInstances()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::SupportsMultipleGameInstances ( )
inlinestaticconstexpr

Checks whether this platforms supports running multiple game instances on a single device.

Returns
true if multiple instances are supported, false otherwise.

◆ SupportsQuit()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::SupportsQuit ( )
inlinestaticconstexpr

◆ SupportsRayTracing()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::SupportsRayTracing ( )
inlinestaticconstexpr

◆ SupportsTextureStreaming()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::SupportsTextureStreaming ( )
inlinestaticconstexpr

◆ SupportsWindowedMode()

static constexpr UE_FORCEINLINE_HINT bool FGenericPlatformProperties::SupportsWindowedMode ( )
inlinestaticconstexpr

Gets whether this platform supports windowed mode rendering.

Returns
true if windowed mode is supported.
The documentation for this struct was generated from the following files: