GenericPlatform

Classes

Name

Description

Public struct

FBlackListEntry

One entry in the Hardware.ini file

Public struct

FChunkTagID

Public struct

FCPUTime

Contains CPU utilization data.

Public struct

FCrashStackFrame

Portable stack frame

Public struct

FFileStatData

Contains the information that's returned from stat'ing a file or directory

Public struct

FGenericCrashContext

Contains a runtime crash's properties that are common for all platforms.

Public struct

FGenericMemoryWarningContext

Public class

FGenericPlatformAffinity

Public struct

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

Public class

FGenericPlatformChunkInstall

Generic implementation of chunk based install

Public struct

FGenericPlatformMallocCrash

Simple pooled memory allocator that uses preallocated memory.

Public struct

FGenericPlatformMath

Generic implementation for most platforms

Public struct

FGenericPlatformMemory

Generic implementation for most platforms, these tend to be unused and unimplemented.

Public struct

FGenericPlatformMemoryConstants

Struct used to hold common memory constants for all platforms.

Public struct

FGenericPlatformMemoryStats

Struct used to hold common memory stats for all platforms.

Public struct

FGenericPlatformMisc

Generic implementation for most platforms

Public struct

FGenericPlatformOutputDevices

Generic implementation for most platforms

Public struct

FGenericPlatformProcess

Generic implementation for most platforms, these tend to be unused and unimplemented

Public struct

FGenericPlatformProperties

Base class for platform properties.

Public struct

FGenericPlatformStackWalk

Generic implementation for most platforms

Public struct

FGenericPlatformStricmp

Optimized locale and CRT independent case-insensitive string comparisons

Public struct

FGenericPlatformString

Generic string implementation for most platforms

Public struct

FGenericPlatformSymbolData

Debug symbol information

Public struct

FGenericPlatformSymbolDatabase

Container for debug symbols corresponding to a single binary file

Public struct

FGenericPlatformSymbolDatabaseKeyFuncs

Public struct

FGenericPlatformSymbolication

Public struct

FGenericPlatformSymbolInfo

File & line info for a debug symbol region

Public struct

FGenericPlatformTime

Generic implementation for most platforms

Public struct

FGenericPlatformTLS

It should be possible to provide a generic implementation as long as a threadID is provided.

Public struct

FGenericPlatformTypes

Generic types for almost all compilers and platforms

Public struct

FGenericStackBasedMallocCrash

Public struct

FGPUDriverInfo

Video driver details

Public struct

FGPUHardware

Public struct

FInt128

Helper struct used to hold 128-bit values, internally represented as two 64-bit integers.

Public struct

FMicrosoftPlatformString

Microsoft specific implementation

Public class

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)

Public struct

FProgramCounterSymbolInfo

Symbol information associated with a program counter. ANSI version.

Public struct

FProgramCounterSymbolInfoEx

Symbol information associated with a program counter.

Public struct

FPtrInfo

Describes a pointer.

Public struct

FSHA256Signature

Holds a computed SHA256 hash.

Public struct

FStackWalkModuleInfo

This is used to capture all of the module information needed to load pdb's.

Public class

FSystemWideCriticalSectionNotImplemented

Platforms that don't need a working FSystemWideCriticalSection can just typedef this one

Public class

IFileHandle

File handle interface.

Public class

IPhysicalPlatformFile

Common base for physical platform File I/O Interface

Public class

IPlatformChunkInstall

Interface for platform specific chunk based install

Public class

IPlatformChunkInstallModule

Platform Chunk Install Module Interface

Public class

IPlatformFile

File I/O Interface

Public struct

SelectIntPointerType

Utility for automatically setting up the pointer-sized integer type.

Public struct

TCallTraits

TCallTraits

Public class

TFunction

TFunction

See the class definition for intended usage.

Public class

TFunctionRef

TFunctionRef

See the class definition for intended usage.

Public class

TGenericPlatformRWLock

TGenericPlatformRWLock - Read/Write Mutex

Public class

TMemoryPool

Class for managing allocations of the size no larger than BlockSize.

Public struct

TProcHandle

Generic implementation for the process handle.

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

Enums

Name

Description

Public enum

EAppMsgType::Type

Enumerates supported message dialog button types.

Public enum

EAppReturnType::Type

Enumerates message dialog return types.

Public enum

EAsyncIOPriorityAndFlags

Enum for async IO priorities.

Public enum

EBuildConfigurations::Type

Enumerates build configurations.

Public enum

EBuildTargets::Type

Enumerates build targets.

Public enum

EChunkInstallSpeed::Type

Public enum

EChunkLocation::Type

Public enum

EChunkPriority::Type

Public enum

EChunkProgressReportingType::Type

Public enum

EComparisonOp

Used to compare driver versions in Hardware.ini

Public enum

EConvertibleLaptopMode

Enumerates the modes a convertible laptop can be in.

Public enum

ECrashContextType

Public enum

ECrashDescVersions

Enumerates crash description versions.

Public enum

ECrashDumpMode

Enumerates crash dump modes.

Public enum

EDeviceScreenOrientation

Device orientations for screens. e.g. Landscape, Portrait, etc.

Public enum

EErrorReportMode::Type

Enumerates supported error reporting modes.

Public enum

ELaunchVerb::Type

Not all platforms have different opening semantics, but Windows allows you to specify a specific verb when opening a file.

Public enum

EMobileHapticsType

Public enum

ENetworkConnectionType

Public enum

EPlatformFileRead

Enum for platform file read flags

Public enum

EPlatformFileWrite

Enum for platform file write flags

Public enum

EPlatformMemorySizeBucket

Platform-dependent "bucket" for memory size, where Default is the normal, or possibly the largest.

Public enum

EProcessResource::Type

Public enum

EThreadPriority

The list of enumerated thread priorities we support

Functions

Name Description

Public function

bool

 

Compare

(
    const T& A,
    EComparisonOp Op,
    const T& B
)

General comparison with the comparison operator given as enum

Public function

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"

Public function

const TCHAR ...

 

LexToString

(
    EBuildConfigurations::Type Configur...
)

Public function

const TCHAR ...

 

LexToString

(
    ENetworkConnectionType Target
)

Returns the string representation of the specified ENetworkConnection value.

Public function

constexpr bo...

 

operator!

Public function

constexpr bo...

 

operator!

(
    EPlatformFileRead E
)

Public function

constexpr bo...

 

operator!

(
    EPlatformFileWrite E
)

Public function

constexpr EA ...

 

operator&

Public function

constexpr EP ...

 

operator&

(
    EPlatformFileRead Lhs,
    EPlatformFileRead Rhs
)

Public function

constexpr EP ...

 

operator&

(
    EPlatformFileWrite Lhs,
    EPlatformFileWrite Rhs
)

Public function

EAsyncIOPrio ...

 

operator&=

Public function

EPlatformFil ...

 

operator&=

(
    EPlatformFileRead & Lhs,
    EPlatformFileRead Rhs
)

Public function

EPlatformFil ...

 

operator&=

(
    EPlatformFileWrite & Lhs,
    EPlatformFileWrite Rhs
)

Public function

constexpr EP ...

 

operator^

(
    EPlatformFileWrite Lhs,
    EPlatformFileWrite Rhs
)

Public function

constexpr EP ...

 

operator^

(
    EPlatformFileRead Lhs,
    EPlatformFileRead Rhs
)

Public function

constexpr EA ...

 

operator^

Public function

EAsyncIOPrio ...

 

operator^=

Public function

EPlatformFil ...

 

operator^=

(
    EPlatformFileRead & Lhs,
    EPlatformFileRead Rhs
)

Public function

EPlatformFil ...

 

operator^=

(
    EPlatformFileWrite & Lhs,
    EPlatformFileWrite Rhs
)

Public function

constexpr EA ...

 

operator|

Public function

constexpr EP ...

 

operator|

(
    EPlatformFileRead Lhs,
    EPlatformFileRead Rhs
)

Public function

constexpr EP ...

 

operator|

(
    EPlatformFileWrite Lhs,
    EPlatformFileWrite Rhs
)

Public function

EAsyncIOPrio ...

 

operator|=

Public function

EPlatformFil ...

 

operator|=

(
    EPlatformFileRead & Lhs,
    EPlatformFileRead Rhs
)

Public function

EPlatformFil ...

 

operator|=

(
    EPlatformFileWrite & Lhs,
    EPlatformFileWrite Rhs
)

Public function

constexpr EA ...

 

operator~

Public function

constexpr EP ...

 

operator~

(
    EPlatformFileRead E
)

Public function

constexpr EP ...

 

operator~

(
    EPlatformFileWrite E
)

Public function

EComparisonO ...

 

ParseComparisonOp

(
    const TCHAR *& In
)

Find the comparison enum based on input text