Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > GenericPlatform

Light Theme

Dark Theme

GenericPlatform

Windows

MacOS

Linux

Classes

	Name	Description
	FBlackListEntry	One entry in the Hardware.ini file
	FCPUTime	Contains CPU utilization data.
	FCrashStackFrame	Portable stack frame
	FCustomChunk
	FCustomChunkMapping
	FFileStatData	Contains the information that's returned from stat'ing a file or directory
	FGenericCrashContext	Contains a runtime crash's properties that are common for all platforms.
	FGenericMemoryWarningContext
	FGenericPlatformAffinity
	FGenericPlatformAtomics	Generic implementation...you are required to implement at least FPlatformAtomics::InterlockedCompareExchange but they are listed here to provide a base implementation in terms of FPlatformAtomics::InterlockedCompareExchange and easy copy-paste
	FGenericPlatformChunkInstall	Generic implementation of chunk based install
	FGenericPlatformMallocCrash	Simple pooled memory allocator that uses preallocated memory.
	FGenericPlatformMath	Generic implementation for most platforms
	FGenericPlatformMemory	Generic implementation for most platforms, these tend to be unused and unimplemented.
	FGenericPlatformMemoryConstants	Struct used to hold common memory constants for all platforms.
	FGenericPlatformMemoryStats	Struct used to hold common memory stats for all platforms.
	FGenericPlatformMisc	Generic implementation for most platforms
	FGenericPlatformOutputDevices	Generic implementation for most platforms
	FGenericPlatformProcess	Generic implementation for most platforms, these tend to be unused and unimplemented
	FGenericPlatformProperties	Base class for platform properties.
	FGenericPlatformStackWalk	Generic implementation for most platforms
	FGenericPlatformStricmp	Optimized locale and CRT independent case-insensitive string comparisons
	FGenericPlatformString	Generic string implementation for most platforms
	FGenericPlatformSymbolData	Debug symbol information
	FGenericPlatformSymbolDatabase	Container for debug symbols corresponding to a single binary file
	FGenericPlatformSymbolDatabaseKeyFuncs
	FGenericPlatformSymbolication
	FGenericPlatformSymbolInfo	File & line info for a debug symbol region
	FGenericPlatformTime	Generic implementation for most platforms
	FGenericPlatformTLS	It should be possible to provide a generic implementation as long as a threadID is provided.
	FGenericPlatformTypes	Generic types for almost all compilers and platforms
	FGenericStackBasedMallocCrash
	FGenericWidePlatformString	Standard implementation
	FGPUDriverInfo	Video driver details
	FGPUHardware
	FInt128	Helper struct used to hold 128-bit values, internally represented as two 64-bit integers.
	FMicrosoftPlatformString	Microsoft specific implementation
	FMultiInt	TSize integer values separated by '.' e.g. "120.210.11.22" made to compare different GPU driver versions handles whitespace if there are to too many numbers we take the left most ones comparison operators (for driver comparison)
	FProgramCounterSymbolInfo	Symbol information associated with a program counter. ANSI version.
	FProgramCounterSymbolInfoEx	Symbol information associated with a program counter.
	FPtrInfo	Describes a pointer.
	FSessionContext	Fixed size structure that holds session specific state.
	FSHA256Signature	Holds a computed SHA256 hash.
	FSharedCrashContext	Fixed size struct holds crash information and session specific state.
	FStackWalkModuleInfo	This is used to capture all of the module information needed to load pdb's.
	FStandardPlatformString	Standard implementation
	FSystemWideCriticalSectionNotImplemented	Platforms that don't need a working FSystemWideCriticalSection can just typedef this one
	FThreadStackFrames	Portable thread stack frame
	FUserSettingsContext	Additional user settings to be communicated to crash reporting client.
	IFileHandle	File handle interface.
	IPhysicalPlatformFile	Common base for physical platform File I/O Interface
	IPlatformChunkInstall	Interface for platform specific chunk based install
	IPlatformChunkInstallModule	Platform Chunk Install Module Interface
	IPlatformFile	File I/O Interface
	SelectIntPointerType	Utility for automatically setting up the pointer-sized integer type.
	TCallTraits	TCallTraits
	TFunction	TFunction See the class definition for intended usage.
	TFunctionRef	TFunctionRef See the class definition for intended usage.
	TGenericPlatformRWLock	TGenericPlatformRWLock - Read/Write Mutex
	TProcHandle	Generic implementation for the process handle.

Constants

Name	Description
EBuildConfigurations::Debug
EBuildConfigurations::DebugGame
EBuildConfigurations::Development
EBuildConfigurations::Shipping
EBuildConfigurations::Test
EBuildConfigurations::Unknown
EBuildTargets::Editor
EBuildTargets::Game
EBuildTargets::Server
EBuildTargets::Unknown

Typedefs

Name	Description
FGenericPlatformSymbolDatabaseSet
FPlatformChunkInstallCompleteDelegate	Deprecated delegate
FPlatformChunkInstallDelegate	Delegate called when a chunk either successfully installs or fails to install, bool is success
FPlatformChunkInstallMultiDelegate
FPlatformMemoryConstants
Type
Type

Enums

	Name	Description
	EAppMsgType::Type	Enumerates supported message dialog button types.
	EAppReturnType::Type	Enumerates message dialog return types.
	EAsyncIOPriorityAndFlags	Enum for async IO priorities.
	EBuildConfiguration	Available build configurations. Mirorred from UnrealTargetConfiguration.
	EBuildTargetType	Enumerates build target types.
	EChunkInstallSpeed::Type
	EChunkLocation::Type
	EChunkPriority::Type
	EChunkProgressReportingType::Type
	EComparisonOp	Used to compare driver versions in Hardware.ini
	EConvertibleLaptopMode	Enumerates the modes a convertible laptop can be in.
	ECrashContextType
	ECrashDescVersions	Enumerates crash description versions.
	ECrashDumpMode	Enumerates crash dump modes.
	ECrashExitCodes	Defines special exit codes used to diagnose abnormal terminations.
	ECrashTrigger	In development mode we can cause crashes in order to test reporting systems.
	ECustomChunkType
	EDeviceScreenOrientation	Device orientations for screens. e.g. Landscape, Portrait, etc.
	EErrorReportMode::Type	Enumerates supported error reporting modes.
	ELaunchVerb::Type	Not all platforms have different opening semantics, but Windows allows you to specify a specific verb when opening a file.
	EMobileHapticsType
	ENetworkConnectionType
	EPlatformFileRead	Enum for platform file read flags
	EPlatformFileWrite	Enum for platform file write flags
	EPlatformMemorySizeBucket
	EProcessResource::Type
	EThreadCreateFlags
	EThreadPriority	The list of enumerated thread priorities we support

Functions

	Name	Description
bool	Compare ( const T& A, EComparisonOp Op, const T& B )	General comparison with the comparison operator given as enum
bool	CompareStringOp ( const TCHAR* InOpWithMultiInt, const TCHAR* CurrentMultiInt )	Useful to express very simple math, later we might extend to express a range e.g. ">10 && <12.121"
EBuildTarget...	EBuildTargets::FromString ( const FString& Target )	EBuildConfigurations::FromString() is deprecated. Use LexFromString() instead.
const TCHAR ...	EBuildTargets::ToString ( EBuildTargetType Target )	EBuildTargets::FromString is deprecated. Use LexFromString() instead.
const TCHAR ...	LexToString ( ENetworkConnectionType Target )	Returns the string representation of the specified ENetworkConnection value.
const TCHAR ...	LexToString ( EAppReturnType::Type Value )	Returns the string representation of the specified EAppReturnType::Type value.
const TCHAR ...	LexToString ( EBuildConfiguration Configuration )	Returns the string representation of the specified EBuildConfiguration value.
const TCHAR ...	LexToString ( EPlatformMemorySizeBucket Bucket )
const TCHAR ...	LexToString ( EBuildTargetType Type )	Returns the string representation of the specified EBuildTargetType value.
bool	LexTryParseString ( EBuildConfiguration& OutConfigurat..., const TCHAR* Configuration )	Returns the string representation of the specified EBuildConfiguration value.
bool	LexTryParseString ( EBuildTargetType& OutType, const TCHAR* Text )	Returns the string representation of the specified EBuildTarget value.
constexpr bo...	operator! ( EThreadCreateFlags E )
constexpr bo...	operator! ( EAsyncIOPriorityAndFlags E )
constexpr bo...	operator! ( EPlatformFileRead E )
constexpr bo...	operator! ( EPlatformFileWrite E )
constexpr EA...	operator& ( EAsyncIOPriorityAndFlags Lhs, EAsyncIOPriorityAndFlags Rhs )
constexpr ET...	operator& ( EThreadCreateFlags Lhs, EThreadCreateFlags Rhs )
constexpr EP...	operator& ( EPlatformFileWrite Lhs, EPlatformFileWrite Rhs )
constexpr EP...	operator& ( EPlatformFileRead Lhs, EPlatformFileRead Rhs )
EAsyncIOPrio...	operator&= ( EAsyncIOPriorityAndFlags& Lhs, EAsyncIOPriorityAndFlags Rhs )
EPlatformFil...	operator&= ( EPlatformFileRead& Lhs, EPlatformFileRead Rhs )
EPlatformFil...	operator&= ( EPlatformFileWrite& Lhs, EPlatformFileWrite Rhs )
EThreadCreat...	operator&= ( EThreadCreateFlags& Lhs, EThreadCreateFlags Rhs )
constexpr EP...	operator^ ( EPlatformFileWrite Lhs, EPlatformFileWrite Rhs )
constexpr ET...	operator^ ( EThreadCreateFlags Lhs, EThreadCreateFlags Rhs )
constexpr EA...	operator^ ( EAsyncIOPriorityAndFlags Lhs, EAsyncIOPriorityAndFlags Rhs )
constexpr EP...	operator^ ( EPlatformFileRead Lhs, EPlatformFileRead Rhs )
EPlatformFil...	operator^= ( EPlatformFileWrite& Lhs, EPlatformFileWrite Rhs )
EPlatformFil...	operator^= ( EPlatformFileRead& Lhs, EPlatformFileRead Rhs )
EAsyncIOPrio...	operator^= ( EAsyncIOPriorityAndFlags& Lhs, EAsyncIOPriorityAndFlags Rhs )
EThreadCreat...	operator^= ( EThreadCreateFlags& Lhs, EThreadCreateFlags Rhs )
constexpr ET...	operator\| ( EThreadCreateFlags Lhs, EThreadCreateFlags Rhs )
constexpr EA...	operator\| ( EAsyncIOPriorityAndFlags Lhs, EAsyncIOPriorityAndFlags Rhs )
constexpr EP...	operator\| ( EPlatformFileRead Lhs, EPlatformFileRead Rhs )
constexpr EP...	operator\| ( EPlatformFileWrite Lhs, EPlatformFileWrite Rhs )
EThreadCreat...	operator\|= ( EThreadCreateFlags& Lhs, EThreadCreateFlags Rhs )
EPlatformFil...	operator\|= ( EPlatformFileRead& Lhs, EPlatformFileRead Rhs )
EPlatformFil...	operator\|= ( EPlatformFileWrite& Lhs, EPlatformFileWrite Rhs )
EAsyncIOPrio...	operator\|= ( EAsyncIOPriorityAndFlags& Lhs, EAsyncIOPriorityAndFlags Rhs )
constexpr ET...	operator~ ( EThreadCreateFlags E )
constexpr EA...	operator~ ( EAsyncIOPriorityAndFlags E )
constexpr EP...	operator~ ( EPlatformFileRead E )
constexpr EP...	operator~ ( EPlatformFileWrite E )
EComparisonO...	ParseComparisonOp ( const TCHAR*& In )	Find the comparison enum based on input text
FString	RecoveryService::GetRecoveryServerName()	Generates a name for the disaster recovery service embedded in the CrashReporterClientEditor.
FString	RecoveryService::MakeSessionName()	Generates a name for the disaster recovery session.
bool	RecoveryService::TokenizeSessionName ( const FString& SessionName, FString* OutServerName, int32* SeqNum, FString* ProjName, FDateTime* DateTime )	Tokenize the session name into its components.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss