1. Epic GamesDeveloper
  3. GenericPlatform

GenericPlatform

API > API/Runtime > API/Runtime/Core

Classes

  Type Name Description
Public struct FChunkInstallationStatusDetail    
Public struct FContextSwitchStats Different types of Context Switch stats  
Public struct FCPUTime Contains CPU utilization data.  
Public struct FCrashStackFrame Portable stack frame  
Public struct FCustomChunkMapping    
Public struct FDriverConfigEntryConstraints Represents an optional set of constraints that a driver configuration entry can include:  
Public struct FDriverDenyListEntry This corresponds to one DriverDenyList entry in the Hardware.ini configuration file.  
Public class FDriverVersion Represents a full driver version with multiple version numbers, e.g. 30.0.13023.4001.  
Public struct FFileJournalData Contains the information that's returned from FileJournalGetFileData for a file.  
Public struct FFileJournalFileHandle A handle used by the FileJournal API.  
Public struct FFileStatData Contains the information that's returned from stat'ing a file or directory  
Public class FFileSystemError Stores custom error messages from the engine along with an optional system error code that can provider more detailed infomation  
Public struct FForkedPageAllocation Contains shared/private information for a single page allocation from the kernel.  
Public struct FGenericCrashContext Contains a runtime crash's properties that are common for all platforms.  
Public struct FGenericMemoryWarningContext    
Public class FGenericPlatformAffinity    
Public struct FGenericPlatformAtomics DEPRECATED! UE atomics are not maintained and potentially will be physically deprecated.  
Public class FGenericPlatformChunkInstall Generic implementation of chunk based install  
Public class FGenericPlatformHostCommunication Generic implementation of IPlatformHostCommunication.  
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 FGenericWidePlatformString Standard implementation  
Public struct FGPUBreadcrumbCrashData GPU breadcrumbs.  
Public struct FGPUBreadcrumbsSharedContext Fixed size structure holding GPU breadcrumbs information, to be communicated to the crash reporting client.  
Public class FGPUDriverHelper    
Public struct FGPUDriverInfo    
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 struct FNamedChunkCompleteCallbackParam    
Public struct FPageFaultStats Different types of Page Fault stats  
Public struct FPlatformHostCommunicationAutoInit Helper RAII type for auto initializing instances derived from IPlatformHostCommunication.  
Public struct FPlatformProcessMemoryStats Generic implementation of the per-process memory stats.  
Public struct FProcessIOStats Different types of Input/Output stats  
Public struct FProcessorGroupDesc    
Public struct FProgramCounterSymbolInfo Symbol information associated with a program counter. ANSI version.  
Public struct FProgramCounterSymbolInfoEx    
Public struct FPtrInfo Describes a pointer.  
Public struct FSessionContext Fixed size structure that holds session specific state.  
Public struct FSHA256Signature Holds a computed SHA256 hash.  
Public struct FSharedCrashContext Fixed size struct holds crash information and session specific state.  
Public struct FStackWalkModuleInfo This is used to capture all of the module information needed to load pdb's.  
Public struct FStandardPlatformString IWYU pragma: begin_exports.  
Public struct FSuggestedDriverEntry This corresponds to one SuggestedDriverVersion entry in the Hardware.ini configuration file.  
Public class FSystemWideCriticalSectionNotImplemented Platforms that don't need a working FSystemWideCriticalSection can just typedef this one  
Public struct FThreadCallStack    
Public struct FThreadStackFrames Portable thread stack frame  
Public struct FUserSettingsContext Additional user settings to be communicated to crash reporting client.  
Public class IFileHandle File handle interface.  
Public class IPakFile Interface class for FPakFile to allow usage from modules that cannot have a compile dependency on FPakFile  
Public class IPhysicalPlatformFile Common base for physical platform File I/O Interface  
Public class IPlatformChunkInstall Interface for platform specific chunk based install  
Public class IPlatformChunkInstallManifest Platform Chunk Install Manifest Interface  
Public class IPlatformChunkInstallModule Platform Chunk Install Module Interface  
Public class IPlatformFile File I/O Interface  
Public class IPlatformHostCommunication Interface for communication between the game running on the target device and the connected host pc.  
Public class IPlatformHostSocket Interface for sockets supporting direct communication between the game running on the target device and a connected PC.  
Public class IWrappedFileHandle    
Public struct SelectIntPointerType Utility for automatically setting up the pointer-sized integer type.  
Public class TFunction TFunctionSee the class definition for intended usage.  
Public class TFunctionRef TFunctionRefSee the class definition for intended usage.  
Public class TGenericPlatformRWLock TGenericPlatformRWLock - Read/Write Mutex  
Public struct 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
FEngineDataResetDelegate Delegates for engine and game data set / reset
FEngineDataSetDelegate  
FFileJournalEntryHandle A handle used by the FileJournal API.
FFileJournalId A handle used by the FileJournal API.
FFileOpenResult Data structure returned by calls to IPlatformFile::OpenRead
FGameDataResetDelegate  
FGameDataSetDelegate  
FGenericPlatformSymbolDatabaseSet  
FOnNetworkConnectionChangedDelegate  
FPlatformChunkInstallDelegate Delegate called when a chunk either successfully installs or fails to install, bool is success
FPlatformChunkInstallMultiDelegate  
FPlatformMemoryConstants  
FPlatformNamedChunkCompleteDelegate Delegate called when a Named Chunk either successfully installs or fails to install
FPlatformNamedChunkCompleteMultiDelegate  
FPlatformNamedChunkInstallDelegate Deprecated delegate called when a Named Chunk either successfully installs or fails to install, bool is success
FPlatformNamedChunkInstallMultiDelegate  
IPlatformHostSocketPtr Type definition for shared pointers to instances of IPlatformHostSocket.
IPlatformHostSocketRef Type definition for shared references to instances of IPlatformHostSocket.
Type  
Type  

Enums

  Type Name Description
Public enum EAppMsgCategory Enumerates supported message dialog category types.  
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 EBuildConfiguration Available build configurations. Mirorred from UnrealTargetConfiguration.  
Public enum EBuildTargetType Enumerates build target types.  
Public enum EChunkInstallSpeed::Type    
Public enum EChunkLocation::Type    
Public enum EChunkPriority::Type    
Public enum EChunkProgressReportingType::Type    
Public enum EComparisonOp    
Public enum EContextSwitchFlags Flags for Context Switch stats to retrieve  
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 ECrashExitCodes Defines special exit codes used to diagnose abnormal terminations.  
Public enum ECrashHandlingType Controls behaviour for built in crash handling  
Public enum ECrashTrigger In development mode we can cause crashes in order to test reporting systems.  
Public enum EDeviceScreenOrientation Device orientations for screens. e.g. Landscape, Portrait, etc.  
Public enum EDirectoryVisitorFlags Enum for the DirectoryVisitor flags  
Public enum EDisplayColorGamut Display gamut, format, and chromacities.  
Public enum EDisplayOutputFormat Defines the type of format the backbuffer expects.  
Public enum EErrorReportMode::Type Enumerates supported error reporting modes.  
Public enum EFileJournalResult Results that can be returned from IPlatformFile FileJournal API.  
Public enum EHostProtocol Known custom communication protocols used by the engine.  
Public enum EInputOutputFlags Flags for Input/Output stats to retrieve  
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 EMemcpyCachePolicy    
Public enum EMobileHapticsType    
Public enum ENamedChunkType    
Public enum ENetworkConnectionStatus Possible connection states  
Public enum ENetworkConnectionType    
Public enum EPageFaultFlags Flags for page fault stats to retrieve  
Public enum EPlatformFileRead Enum for platform file read flags  
Public enum EPlatformFileWrite Enum for platform file write flags  
Public enum EPlatformMemorySizeBucket    
Public enum EProcessDiagnosticFlags    
Public enum EProcessResource::Type    
Public enum ESymlinkResult Enum for IsSymlink() results (added so this func can return ESymlinkResult::Unimplemented)  
Public enum EThreadCreateFlags    
Public enum EThreadPriority The list of enumerated thread priorities we support  
Public enum EUnattendedStatus Tristate to identify a session which is attended or unattended (ie. usually automated testing) Determination requires command line arguments - therefore if not available, status is unknown  

Functions

  Type Name Description  
Public function const TCHAR *    
Public function bool

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

 Compare two objects given the comparison operator.  
Public function EBuildTargetType    
Public function const TCHAR *    
Public function uint32    
Public function const TCHAR * Returns the string representation of the specified ENetworkConnection value.  
Public function const TCHAR *    
Public function const TCHAR * Returns the string representation of the specified EAppReturnType::Type value.  
Public function const TCHAR * Returns the string representation of the specified EBuildTargetType value.  
Public function const TCHAR *

LexToString ( EBuildConfiguration Configuration
)

 Returns the string representation of the specified EBuildConfiguration value.  
Public function const TCHAR *    
Public function bool

LexTryParseString ( EBuildConfiguration& OutConfiguration,
const TCHAR* Configuration
)

 Returns the string representation of the specified EBuildConfiguration value.  
Public function bool

LexTryParseString ( EBuildTargetType& OutType,
const TCHAR* Text
)

 Returns the string representation of the specified EBuildTarget value.  
Public function FGenericPlatformTypes::UTF8CHAR    
Public function FGenericPlatformTypes::UTF8CHAR &    
Public function bool    
Public function bool    
Public function bool    
Public function bool    
Public function bool    
Public function bool    
Public function bool    
Public function bool    
Public function bool    
Public function bool    
Public function FGenericPlatformTypes::UTF8CHAR &    
Public function decltype((FGenericPlatformTypes::UTF8CHAR &)(*(unsigned char *)&Ch %=(T &&) InValue))    
Public function EProcessDiagnosticFlags    
Public function IPlatformFile::EOpenReadFlags    
Public function EDirectoryVisitorFlags    
Public function EPlatformFileRead    
Public function EAsyncIOPriorityAndFlags    
Public function EThreadCreateFlags    
Public function EPlatformFileWrite    
Public function EContextSwitchFlags    
Public function EPageFaultFlags    
Public function EInputOutputFlags    
Public function decltype((FGenericPlatformTypes::UTF8CHAR &)(*(unsigned char *)&Ch &=(T &&) InValue))    
Public function FGenericPlatformTypes::UTF8CHAR &    
Public function EThreadCreateFlags &    
Public function EAsyncIOPriorityAndFlags &    
Public function EPlatformFileRead &    
Public function EPlatformFileWrite &    
Public function EProcessDiagnosticFlags &    
Public function EContextSwitchFlags &    
Public function EInputOutputFlags &    
Public function EPageFaultFlags &    
Public function EDirectoryVisitorFlags &    
Public function IPlatformFile::EOpenReadFlags &    
Public function FGenericPlatformTypes::UTF8CHAR &    
Public function decltype((FGenericPlatformTypes::UTF8CHAR &)(*(unsigned char *)&Ch *=(T &&) InValue))    
Public function decltype((FGenericPlatformTypes::UTF8CHAR &)(*(unsigned char *)&Ch/=(T &&) InValue))    
Public function FGenericPlatformTypes::UTF8CHAR &    
Public function EPageFaultFlags    
Public function EContextSwitchFlags    
Public function EInputOutputFlags    
Public function EProcessDiagnosticFlags    
Public function IPlatformFile::EOpenReadFlags    
Public function EDirectoryVisitorFlags    
Public function EPlatformFileRead    
Public function EAsyncIOPriorityAndFlags    
Public function EPlatformFileWrite    
Public function EThreadCreateFlags    
Public function EPlatformFileWrite &    
Public function EAsyncIOPriorityAndFlags &    
Public function EDirectoryVisitorFlags &    
Public function IPlatformFile::EOpenReadFlags &    
Public function EProcessDiagnosticFlags &    
Public function EContextSwitchFlags &    
Public function EPageFaultFlags &    
Public function EInputOutputFlags &    
Public function decltype((FGenericPlatformTypes::UTF8CHAR &)(*(unsigned char *)&Ch ^=(T &&) InValue))    
Public function FGenericPlatformTypes::UTF8CHAR &    
Public function EThreadCreateFlags &    
Public function EPlatformFileRead &    
Public function EDirectoryVisitorFlags    
Public function IPlatformFile::EOpenReadFlags    
Public function EProcessDiagnosticFlags    
Public function EPageFaultFlags    
Public function EInputOutputFlags    
Public function EContextSwitchFlags    
Public function EPlatformFileWrite    
Public function EPlatformFileRead    
Public function EThreadCreateFlags    
Public function EAsyncIOPriorityAndFlags    
Public function EDirectoryVisitorFlags &    
Public function EPageFaultFlags &    
Public function EProcessDiagnosticFlags &    
Public function IPlatformFile::EOpenReadFlags &    
Public function EPlatformFileWrite &    
Public function EPlatformFileRead &    
Public function EAsyncIOPriorityAndFlags &    
Public function EThreadCreateFlags &    
Public function FGenericPlatformTypes::UTF8CHAR &    
Public function decltype((FGenericPlatformTypes::UTF8CHAR &)(*(unsigned char *)&Ch =(T &&) InValue))  
Public function EInputOutputFlags &    
Public function EContextSwitchFlags &    
Public function EThreadCreateFlags    
Public function EAsyncIOPriorityAndFlags    
Public function EPlatformFileRead    
Public function EPlatformFileWrite    
Public function EDirectoryVisitorFlags    
Public function IPlatformFile::EOpenReadFlags    
Public function EProcessDiagnosticFlags    
Public function EPageFaultFlags    
Public function EContextSwitchFlags    
Public function EInputOutputFlags    
Public function FGenericPlatformTypes::UTF8CHAR    
Public function FGenericPlatformTypes::UTF8CHAR &    
Public function FGenericPlatformTypes::UTF8CHAR &    
Public function decltype((FGenericPlatformTypes::UTF8CHAR &)(*(unsigned char *)&Ch+=(T &&) InValue))    
Public function decltype((FGenericPlatformTypes::UTF8CHAR &)(*(unsigned char *)&Ch -=(T &&) InValue))    
Public function FGenericPlatformTypes::UTF8CHAR &    
Public function FGenericPlatformTypes::UTF8CHAR &    
Public function decltype((FGenericPlatformTypes::UTF8CHAR &)(*(unsigned char *)&Ch > >=(T &&) InValue))    
Public function EComparisonOp

ParseComparisonOp ( const TCHAR*& In
)

 Find the comparison operator in the input string, and advances the In pointer to point to the first character after the comparison operator.  
Public function Static FDateTime

ParseMonthDayYearDate ( const FString& DateString
)

    
Public function FString Generates a name for the disaster recovery service embedded in the CrashReporterClientEditor.  
Public function FString Generates a name for the disaster recovery session.  
Public function bool

RecoveryService::TokenizeSessionName ( const FString& SessionName,
FString* OutServerName,
int32* SeqNum,
FString* ProjName,
FDateTime* DateTime
)

 Tokenize the session name into its components.  

Variables

  Type Name Description
Public variable FFileJournalEntryHandle FileJournalEntryHandleInvalid  
Public variable const FFileJournalFileHandle FileJournalFileHandleInvalid  
Public variable FFileJournalId FileJournalIdInvalid  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page