FGenericPlatformProperties

Syntax

struct FGenericPlatformProperties

Remarks

Base class for platform properties.

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

Functions

Name Description

Public function Static

bool

 

AllowsCallStackDumpDuringAssert()

Whether the platform allows the call stack to be dumped during an assert.

Public function Static

bool

 

AllowsFramerateSmoothing()

Whether this platform wants to allow framerate smoothing or not.

Public function Static

const char &...

 

GetPhysicsFormat()

Gets the platform's physics format.

Public function 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

Public function Static

bool

 

HasEditorOnlyData()

Gets whether this platform has Editor-only data.

Public function Static

bool

 

HasFixedResolution()

Gets whether user settings should override the resolution or not

Public function Static

bool

 

HasSecurePackageFormat()

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

Public function Static

const char &...

 

IniPlatformName()

Gets the name of this platform when loading INI files.

Public function Static

bool

 

IsClientOnly()

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

Public function Static

bool

 

IsGameOnly()

Gets whether this is a game only platform.

Public function Static

bool

 

IsLittleEndian()

Gets whether this is a Little Endian platform.

Public function Static

bool

 

IsMonolithicBuild()

Gets whether this was a monolithic build or not

Public function Static

bool

 

IsProgram()

Gets whether this was a program or not

Public function Static

bool

 

IsServerOnly()

Gets whether this is a server only platform.

Public function Static

const char &...

 

PlatformName()

Gets the name of this platform

Note: MUST be implemented per platform.

Public function Static

bool

 

RequiresCookedData()

Checks whether this platform requires cooked data.

Public function Static

bool

 

RequiresUserCredentials()

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

Public function Static

bool

 

SupportsAudioStreaming()

Whether this platform supports streaming audio

Public function Static

bool

 

SupportsAutoSDK()

Returns true if platform supports the AutoSDK system

Public function Static

bool

 

SupportsBuildTarget

(
    EBuildTargets::Type BuildTarget
)

Checks whether the specified build target is supported.

Public function Static

bool

 

SupportsDistanceFieldAO()

Public function Static

bool

 

SupportsDistanceFieldShadows()

Public function Static

bool

 

SupportsGrayscaleSRGB()

Gets whether this platform supports gray scale sRGB texture formats.

Public function Static

bool

 

SupportsHighQualityLightmaps()

Public function Static

bool

 

SupportsLowQualityLightmaps()

Public function Static

bool

 

SupportsMinimize()

Public function Static

bool

 

SupportsMultipleGameInstances()

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

Public function Static

bool

 

SupportsQuit()

Whether the platform allows an application to quit to the OS.

Public function Static

bool

 

SupportsTessellation()

Gets whether this platform supports tessellation.

Public function Static

bool

 

SupportsTextureStreaming()

Public function Static

bool

 

SupportsWindowedMode()

Gets whether this platform supports windowed mode rendering.

References

Module

Core

Header

Runtime/Core/Public/GenericPlatform/GenericPlatformProperties.h