FGenericPlatformProperties Struct Reference

#include <GenericPlatformProperties.h>

Inheritance diagram for FGenericPlatformProperties:

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

Detailed Description

Base class for platform properties.

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

Definition at line 16 of file GenericPlatformProperties.h.

Member Function Documentation

AllowsCallStackDumpDuringAssert()

static FORCEINLINE bool FGenericPlatformProperties::AllowsCallStackDumpDuringAssert ( )

inlinestatic

Definition at line 294 of file GenericPlatformProperties.h.

Here is the call graph for this function:

AllowsFramerateSmoothing()

static FORCEINLINE bool FGenericPlatformProperties::AllowsFramerateSmoothing ( )

inlinestatic

Whether this platform wants to allow framerate smoothing or not.

Definition at line 194 of file GenericPlatformProperties.h.

GetMemoryMappingAlignment()

static FORCEINLINE int64 FGenericPlatformProperties::GetMemoryMappingAlignment ( )

inlinestatic

Definition at line 249 of file GenericPlatformProperties.h.

GetPhysicsFormat()

static FORCEINLINE const char * FGenericPlatformProperties::GetPhysicsFormat ( )

inlinestatic

Gets the platform's physics format.

Returns

The physics format name.

Definition at line 23 of file GenericPlatformProperties.h.

GetZlibReplacementFormat()

static FORCEINLINE const char * FGenericPlatformProperties::GetZlibReplacementFormat ( )

inlinestatic

Definition at line 301 of file GenericPlatformProperties.h.

HasEditorOnlyData()

static FORCEINLINE bool FGenericPlatformProperties::HasEditorOnlyData ( )

inlinestatic

Gets whether this platform has Editor-only data.

Returns

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

Definition at line 33 of file GenericPlatformProperties.h.

Here is the caller graph for this function:

HasFixedResolution()

static FORCEINLINE bool FGenericPlatformProperties::HasFixedResolution ( )

inlinestatic

Gets whether user settings should override the resolution or not

Definition at line 277 of file GenericPlatformProperties.h.

HasSecurePackageFormat()

static FORCEINLINE bool FGenericPlatformProperties::HasSecurePackageFormat ( )

inlinestatic

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.

Definition at line 127 of file GenericPlatformProperties.h.

IniPlatformName()

static 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 FORCEINLINE bool FGenericPlatformProperties::IsClientOnly ( )

inlinestatic

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.

Definition at line 72 of file GenericPlatformProperties.h.

IsGameOnly()

static FORCEINLINE bool FGenericPlatformProperties::IsGameOnly ( )

inlinestatic

Gets whether this is a game only platform.

Returns

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

Definition at line 52 of file GenericPlatformProperties.h.

IsLittleEndian()

static FORCEINLINE bool FGenericPlatformProperties::IsLittleEndian ( )

inlinestatic

Gets whether this is a Little Endian platform.

Returns

true if the platform is Little Endian, false otherwise.

Definition at line 98 of file GenericPlatformProperties.h.

IsMonolithicBuild()

static FORCEINLINE bool FGenericPlatformProperties::IsMonolithicBuild ( )

inlinestatic

Gets whether this was a monolithic build or not

Definition at line 80 of file GenericPlatformProperties.h.

IsProgram()

static FORCEINLINE bool FGenericPlatformProperties::IsProgram ( )

inlinestatic

Gets whether this was a program or not

Definition at line 88 of file GenericPlatformProperties.h.

Here is the caller graph for this function:

IsServerOnly()

static FORCEINLINE bool FGenericPlatformProperties::IsServerOnly ( )

inlinestatic

Gets whether this is a server only platform.

Returns

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

Definition at line 62 of file GenericPlatformProperties.h.

PlatformName()

static FORCEINLINE const char * FGenericPlatformProperties::PlatformName ( )

static

Gets the name of this platform

Note: MUST be implemented per platform.

Returns

Platform Name.

RequiresCookedData()

static FORCEINLINE bool FGenericPlatformProperties::RequiresCookedData ( )

inlinestatic

Checks whether this platform requires cooked data.

Returns

true if cooked data is required, false otherwise.

Definition at line 117 of file GenericPlatformProperties.h.

Here is the call graph for this function:

RequiresOriginalReleaseVersionForPatch()

static FORCEINLINE bool FGenericPlatformProperties::RequiresOriginalReleaseVersionForPatch ( )

inlinestatic

Definition at line 307 of file GenericPlatformProperties.h.

RequiresUserCredentials()

static FORCEINLINE bool FGenericPlatformProperties::RequiresUserCredentials ( )

inlinestatic

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

Returns

true if this platform requires user credentials, false otherwise.

Definition at line 137 of file GenericPlatformProperties.h.

SupportsAudioStreaming()

static FORCEINLINE bool FGenericPlatformProperties::SupportsAudioStreaming ( )

inlinestatic

Whether this platform supports streaming audio

Definition at line 202 of file GenericPlatformProperties.h.

SupportsAutoSDK()

static FORCEINLINE bool FGenericPlatformProperties::SupportsAutoSDK ( )

inlinestatic

Returns true if platform supports the AutoSDK system

Definition at line 156 of file GenericPlatformProperties.h.

SupportsBuildTarget()

static FORCEINLINE bool FGenericPlatformProperties::SupportsBuildTarget ( EBuildTargetType TargetType )

inlinestatic

Checks whether the specified build target is supported.

Parameters

TargetType

The build target to check.

Returns

true if the build target is supported, false otherwise.

Definition at line 148 of file GenericPlatformProperties.h.

SupportsDistanceFieldAO()

static FORCEINLINE bool FGenericPlatformProperties::SupportsDistanceFieldAO ( )

inlinestatic

Definition at line 222 of file GenericPlatformProperties.h.

SupportsDistanceFieldShadows()

static FORCEINLINE bool FGenericPlatformProperties::SupportsDistanceFieldShadows ( )

inlinestatic

Definition at line 217 of file GenericPlatformProperties.h.

SupportsGrayscaleSRGB()

static FORCEINLINE bool FGenericPlatformProperties::SupportsGrayscaleSRGB ( )

inlinestatic

Gets whether this platform supports gray scale sRGB texture formats.

Returns

true if gray scale sRGB texture formats are supported.

Definition at line 166 of file GenericPlatformProperties.h.

SupportsHardwareLZDecompression()

static FORCEINLINE bool FGenericPlatformProperties::SupportsHardwareLZDecompression ( )

inlinestatic

Definition at line 269 of file GenericPlatformProperties.h.

SupportsHighQualityLightmaps()

static FORCEINLINE bool FGenericPlatformProperties::SupportsHighQualityLightmaps ( )

inlinestatic

Definition at line 207 of file GenericPlatformProperties.h.

SupportsLowQualityLightmaps()

static FORCEINLINE bool FGenericPlatformProperties::SupportsLowQualityLightmaps ( )

inlinestatic

Definition at line 212 of file GenericPlatformProperties.h.

SupportsLumenGI()

static FORCEINLINE bool FGenericPlatformProperties::SupportsLumenGI ( )

inlinestatic

Definition at line 264 of file GenericPlatformProperties.h.

SupportsMemoryMappedAnimation()

static FORCEINLINE bool FGenericPlatformProperties::SupportsMemoryMappedAnimation ( )

inlinestatic

Definition at line 245 of file GenericPlatformProperties.h.

SupportsMemoryMappedAudio()

static FORCEINLINE bool FGenericPlatformProperties::SupportsMemoryMappedAudio ( )

inlinestatic

Definition at line 241 of file GenericPlatformProperties.h.

SupportsMemoryMappedFiles()

static FORCEINLINE bool FGenericPlatformProperties::SupportsMemoryMappedFiles ( )

inlinestatic

Definition at line 237 of file GenericPlatformProperties.h.

SupportsMeshLODStreaming()

static FORCEINLINE bool FGenericPlatformProperties::SupportsMeshLODStreaming ( )

inlinestatic

Definition at line 232 of file GenericPlatformProperties.h.

SupportsMinimize()

static FORCEINLINE bool FGenericPlatformProperties::SupportsMinimize ( )

inlinestatic

Definition at line 282 of file GenericPlatformProperties.h.

SupportsMultipleGameInstances()

static FORCEINLINE bool FGenericPlatformProperties::SupportsMultipleGameInstances ( )

inlinestatic

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

Returns

true if multiple instances are supported, false otherwise.

Definition at line 176 of file GenericPlatformProperties.h.

SupportsQuit()

static FORCEINLINE bool FGenericPlatformProperties::SupportsQuit ( )

inlinestatic

Definition at line 288 of file GenericPlatformProperties.h.

SupportsRayTracing()

static FORCEINLINE bool FGenericPlatformProperties::SupportsRayTracing ( )

inlinestatic

Definition at line 259 of file GenericPlatformProperties.h.

SupportsTextureStreaming()

static FORCEINLINE bool FGenericPlatformProperties::SupportsTextureStreaming ( )

inlinestatic

Definition at line 227 of file GenericPlatformProperties.h.

SupportsVirtualTextureStreaming()

static FORCEINLINE bool FGenericPlatformProperties::SupportsVirtualTextureStreaming ( )

inlinestatic

Definition at line 254 of file GenericPlatformProperties.h.

SupportsWindowedMode()

static FORCEINLINE bool FGenericPlatformProperties::SupportsWindowedMode ( )

inlinestatic

Gets whether this platform supports windowed mode rendering.

Returns

true if windowed mode is supported.

Definition at line 186 of file GenericPlatformProperties.h.

---

The documentation for this struct was generated from the following file:

• C:/Users/lachl/Downloads/ArkServerAPI_NEW/ASA/AsaApi/AsaApi/Core/Public/API/UE/GenericPlatform/GenericPlatformProperties.h