FDataDrivenPlatformInfo

Information about a platform loaded from disk.

Choose your operating system:

Windows

macOS

Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Misc/DataDrivenPlatformInfoRegistry.h

Include

#include "Misc/DataDrivenPlatformInfoRegistry.h"

Syntax

struct FDataDrivenPlatformInfo

Remarks

Information about a platform loaded from disk.

Variables

Name Description

Public variable

TArray< FString...

 

AdditionalRestrictedFolders

List of additional restricted folders

Public variable

FString

 

AutoSDKPath

Path under CarefullyRedist for the SDK.

Public variable

bool

 

bCanChangeGamepadType

Public variable

bool

 

bCanUseCrashReporter

Whether or not the platform can use Crash Reporter

Public variable

bool

 

bDefaultInputStandardKeyboard

True if this platform handles input via standard keyboard layout by default, translates to PC platform.

Public variable

bool

 

bEnabledForUse

Enabled for use

Public variable

bool

 

bHasCompiledTargetSupport

Whether or not this editor/program has compiled in support for this platform (by looking for TargetPlatform style DLLs, without loading them)

Public variable

bool

 

bHasDedicatedGamepad

True if this platform has a non-generic gamepad specifically associated with it.

Public variable

bool

 

bInputSupportConfigurable

Input-related settings.

Public variable

bool

 

bIsConfidential

Is this platform confidential

Public variable

bool

 

bIsFakePlatform

Some platforms are here just for IniParentChain needs and are not concrete platforms

Public variable

bool

 

bSupportsGamepad

Public variable

bool

 

bSupportsMouseAndKeyboard

Public variable

bool

 

bSupportsTouch

Public variable

bool

 

bUATClosesAfterLaunch

Whether UAT closes immediately after launching on this platform, or if it sticks around to read output from the running process

Public variable

bool

 

bUsesHostCompiler

Whether code projects for this platform require the host platform compiler to be installed.

Public variable

FString

 

DefaultInputType

Public variable

bool

 

Freezing_b32Bit

Public variable

bool

 

Freezing_bAlignBases

Public variable

bool

 

Freezing_bForce64BitMemoryImagePointers

Public variable

bool

 

Freezing_bWithRayTracing

Public variable

uint32

 

Freezing_MaxFieldAlignment

MemoryFreezing information, matches FPlatformTypeLayoutParameters - defaults are clang, noneditor.

Public variable

FGuid

 

GlobalIdentifier

GUID to represent this platform forever.

Public variable

FString

 

HardwareCompressionFormat

The compression format that this platform wants; overrides game unless bForceUseProjectCompressionFormat

Public variable

FPlatformIconPa...

 

IconPaths

Information about where to find the platform icons (for use by FEditorStyle)

Public variable

TArray< FString...

 

IniParentChain

Cached list of ini parents

Public variable

FName

 

IniPlatformName

Copy of the platform name, same as the Key into GetAllPlatformInfos()

Public variable

FName

 

PlatformGroupName

An identifier to group similar platforms together, such as "Mobile" and "Console".

Public variable

FName

 

PlatformSubMenu

Submenu name to group similar platforms together in menus, such as "Linux" and "LinuxArm64".

Public variable

FString

 

SDKTutorial

Tutorial path for tutorial to install SDK

Public variable

FString

 

TargetSettingsIniSectionName

The name of the ini section to use to load target platform settings (used at runtime and cooktime)

Public variable

FName

 

UBTPlatformName

An identifier that corresponds to UBT's UnrealTargetPlatform enum (and by proxy, FGenericPlatformMisc::GetUBTPlatform()), as well as the directory Binaries are placed under

Public variable

FString

 

UBTPlatformString

Functions

Name Description

Public function Const

const FStrin...

 

GetIconPath

(
    const EPlatformIconSize InIconSize
)

Get the path to the icon on disk (for FEditorStyle) for the given icon type for this platform

Public function Const

FName

 

GetIconStyleName

(
    const EPlatformIconSize InIconSize
)

Get the icon name (for FEditorStyle) used by the given icon type for this platform