description: Stores a simple POD type to unaligned memory.

code: template<typename T> static void WriteUnaligned ( void * Ptr, const T & InValue )


className: FGenericPlatformMemory

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

module: Core

code: struct FGenericPlatformMemory


className: EMemoryPressureStatus

description: Memory pressure states, useful for platforms in which the available memory estimate may not take in to account memory reclaimable from closing inactive processes or resorting to swap.

code: enum EMemoryPressureStatus { Unknown, Nominal, Warning, Critical, }


className: FGenericPlatformMemoryConstants

description: Struct used to hold common memory constants for all platforms. These values don't change over the entire life of the executable.

code: struct FGenericPlatformMemoryConstants

AddressLimit

description: AddressLimit - Second parameter is estimate of the range of addresses expected to be returns by BinnedAllocFromOS().

BinnedAllocationGranularity

description: This is the "allocation granularity" in Binned malloc terms, i.e. BinnedMalloc will allocate the memory in increments of this value.

BinnedPageSize

description: The size of a "page" in Binned2 malloc terms, in bytes.

OsAllocationGranularity

description: Some platforms have advantages if memory is allocated in chunks larger than PageSize (e.g. VirtualAlloc() seems to have 64KB granularity as of now).

PageSize

description: The size of a physical page, in bytes.

TotalPhysicalGB

description: Approximate physical RAM in GB; 1 on everything except PC.

TotalVirtual

description: The amount of virtual memory, in bytes.


className: FPlatformSpecificStat

code: struct FPlatformSpecificStat

Name

type: const TCHAR ...


code: FPlatformSpecificStat &40; const TCHAR &42; InName, uint64 InValue &41;


code: uint64 GetAvailablePhysical ( bool bExcludeExtraDevMemory ) const


description: Called by FCsvProfiler::EndFrame to set platform specific CSV stats.

code: void SetEndFrameCsvStats() const


description: Default constructor, clears all variables.

code: FGenericPlatformMemoryStats()


className: FGenericPlatformMemoryStats

description: Struct used to hold common memory stats for all platforms. These values may change over the entire life of the executable.

code: struct FGenericPlatformMemoryStats : public [FGenericPlatformMemoryConstants](API\Runtime\Core\GenericPlatform\FGenericPlatformMemoryConstants)

AvailablePhysical

description: The amount of physical memory currently available, in bytes.

AvailableVirtual

description: The amount of virtual memory currently available, in bytes.

PeakUsedPhysical

description: The peak amount of physical memory used by the process, in bytes.

PeakUsedVirtual

description: The peak amount of virtual memory used by the process.

UsedPhysical

description: The amount of physical memory used by the process, in bytes.

UsedVirtual

description: Total amount of virtual memory used by the process.


description: Add an additional root directory

code: static void AddAdditionalRootDirectory ( const [FString](API\Runtime\Core\Containers\FString) & RootDir )


code: static [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddNetworkListener ( FOnNetworkConnectionChangedDelegate && InNewDelegate )


description:
Checks if platform wants to allow an audio thread on current device (note: does not imply it will, only if okay given other criteria met)
true if allowed, false if shouldn't use a separate audio thread

code: static bool AllowAudioThread()


className: AllowedDeviceOrientation

code: static EDeviceScreenOrientation AllowedDeviceOrientation = EDeviceScreenOrientation::Unknown;


description:
Checks if platform wants to allow the thread heartbeat hang detection
true if allows, false if shouldn't allow thread heartbeat hang detection

code: static bool AllowThreadHeartBeat()


description: Profiler enter background events. These are for timing backgrounding. Some platforms have a timeout for this

code: static void BeginEnterBackgroundEvent ( const TCHAR * Text )


description: Platform specific function for adding a named event that can be viewed in external tool

code: static void BeginNamedEvent ( const struct [FColor](API\Runtime\Core\Math\FColor) & Color, const TCHAR * Text )


code: static void BeginNamedEvent ( const struct [FColor](API\Runtime\Core\Math\FColor) & Color, const ANSICHAR * Text )


description: Indicates the start of a frame for named events

code: static void BeginNamedEventFrame()


description: Profiler color stack - this overrides the color for named events with undefined colors (e.g stat namedevents)

code: static void BeginProfilerColor ( const struct [FColor](API\Runtime\Core\Math\FColor) & Color )


className: bPromptForRemoteDebugOnEnsure

description: Whether the user should be prompted to allow for a remote debugger to be attached on an ensure

code: static bool bPromptForRemoteDebugOnEnsure = false;


className: bShouldPromptForRemoteDebugging

description: Whether the user should be prompted to allow for a remote debugger to be attached

code: static bool bShouldPromptForRemoteDebugging = false;


description: Function to store the current working directory for use withLaunchDir()

code: static void CacheLaunchDir()


description: Ensure that there enough space in the persistent download dir. Returns true if there is sufficient space. If there is insufficient space and bAttemptToUseUI is true, the function will return false and the user may be prompted to clear space

code: static bool CheckPersistentDownloadStorageSpaceAvailable ( uint64 BytesRequired, bool bAttemptToUseUI )


code: static void ChooseHDRDeviceAndColorGamut ( uint32 DeviceId, uint32 DisplayNitLevel, EDisplayOutputFormat & OutputDevice, EDisplayColorGamut & ColorGamut )


description: Copies text to the operating system clipboard.

code: static void ClipboardCopy ( const TCHAR * Str )


description: Pastes in text from the operating system clipboard.

code: static void ClipboardPaste ( class [FString](API\Runtime\Core\Containers\FString) & Dest )


description: Return the CloudDir. CloudDir can be per-user.


description: Create a new globally unique identifier.

code: static void CreateGuid ( struct [FGuid](API\Runtime\Core\Misc\FGuid) & Result )


description:
Handles Game Explorer, Firewall and FirstInstall commands, typically from the installer
false if the game cannot continue.

code: static bool CommandLineCommands()


className: CurrentNetworkConnectionStatus

code: static ENetworkConnectionStatus CurrentNetworkConnectionStatus = ENetworkConnectionStatus::Connected;


description: Platform specific function for adding a named custom stat that can be viewed in external tool

code: static void CustomNamedStat ( const TCHAR * Text, float Value, const TCHAR * Graph, const TCHAR * Unit )


code: static void CustomNamedStat ( const ANSICHAR * Text, float Value, const ANSICHAR * Graph, const ANSICHAR * Unit )


description:
Deletes the given section and its contained values in the platform specific key->value store Note: The key->value store is user-specific, but may be used to share data between different applications for the same user
bool true if the section was deleted, false if not found or couldn't delete

code: static bool DeleteStoredSection ( const [FString](API\Runtime\Core\Containers\FString) & InStoreId, const [FString](API\Runtime\Core\Containers\FString) & InSectionName )


description: Break into the debugger, if IsDebuggerPresent returns true, otherwise do nothing

code: static void DebugBreak()


description:
Deletes value for the given section and key in the platform specific key->value store Note: The key->value store is user-specific, but may be used to share data between different applications for the same user
bool true if the value was deleted correctly, false if not found or couldn't delete

code: static bool DeleteStoredValue ( const [FString](API\Runtime\Core\Containers\FString) & InStoreId, const [FString](API\Runtime\Core\Containers\FString) & InSectionName, const [FString](API\Runtime\Core\Containers\FString) & InKeyName )


description: Platform specific function for closing a named event that can be viewed in external tool

code: static void EndNamedEvent()


description: Get the engine directory

code: static const TCHAR * EngineDir()


description:
Platform-specific Exec function
bool true if command was processed, false if not

code: static bool Exec ( class [UWorld](API\Runtime\Engine\Engine\UWorld) * InWorld, const TCHAR * Cmd, [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Out )


code: static bool FileExistsInPlatformPackage ( const [FString](API\Runtime\Core\Containers\FString) & RelativePath )


code: static void EndEnterBackgroundEvent()


className: FStaticData

code: struct FStaticData

AdditionalRootDirectories

type: TArray<FString...

AdditionalRootDirectoriesLock

type: FRWLock

EngineDirectory

type: FString


description: Return the GamePersistentDownloadDir. On some platforms, returns the writable directory for downloaded data that persists across play sessions. This dir is always per-game.

code: static const TCHAR * GamePersistentDownloadDir()


description: Return the temporary directory

code: static const TCHAR * GameTemporaryDownloadDir()


code: static const TCHAR * GeneratedConfigDir()


description: Get additional directories which can be considered as root directories

code: static [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > GetAdditionalRootDirectories()


description: Deprecated* UseIPlatformChunkInstall::GetNamedChunksByTypeinstead

code: static [TArray](API\Runtime\Core\Containers\TArray)< [FCustomChunk](API\Runtime\Core\GenericPlatform\FCustomChunk) > GetAllLanguageChunks()


code: static [TArray](API\Runtime\Core\Containers\TArray)< [FCustomChunk](API\Runtime\Core\GenericPlatform\FCustomChunk) > GetAllOnDemandChunks()


description:
Returns the allowed orientation of the device. This is NOT the same as GetDeviceOrientation, which only returns Portrait, LandscapeLeft, PortraitUpsideDown or LandscapeRight. The allowed orientation limits what orientation your device can have. So if you set the allowed orientation to LandscapeLeft, GetDeviceOrientation will only ever return LandscapeLeft. But if you set the allowed orientation to LandscapeSensor, you are actually restricting the allowed orientations to LandscapeLeft OR LandscapeRight (depending on the sensor), so GetDeviceOrientation might return LandscapeLeft OR LandscapeRight.
An EDeviceScreenOrientation value.


description:
Gets the current battery level.
the battery level between 0 and 100.

code: static int GetBatteryLevel()


description:
Gets Blocking Input/Output stats covering the lifetime of the process
Whether or not stats were successfully retrieved

code: static bool GetBlockingIOStats ( [FProcessIOStats](API\Runtime\Core\GenericPlatform\FProcessIOStats) & OutStats, EInputOutputFlags Flags )


code: static int32 GetChunkIDFromPakchunkIndex ( int32 PakchunkIndex )


description: Parse CoreLimit from CommandLine or from the SetCoreLimit value. The real number of physical cores and logical cores must be provided so that CommandLine arguments can be translated.

code: static void GetConfiguredCoreLimits ( int32 PlatformNumPhysicalCores, int32 PlatformNumLogicalCores, bool & bOutFullyInitialized, int32 & OutPhysicalCoreLimit, int32 & OutLogicalCoreLimit, bool & bOutSetPhysicalCountToLogicalCount )


description:
Gets Context Switch stats covering the lifetime of the process
Whether or not stats were successfully retrieved

code: static bool GetContextSwitchStats ( [FContextSwitchStats](API\Runtime\Core\GenericPlatform\FContextSwitchStats) & OutStats, EContextSwitchFlags Flags )


description:
Gets the current mode of convertible laptops, i.e. Laptop or Tablet.
The laptop mode, or Unknown if not known, or NotSupported if not a convertible laptop.


description:
Uses cpuid instruction to get the CPU brand string
CPU brand string


description:
Returns the CPU chipset if known
CPU chipset string (or "Unknown")


description:
On x86(-64) platforms, uses cpuid instruction to get the CPU signature
CPU info bitfield     Bits 0-3    Stepping ID
    Bits 4-7    Model
    Bits 8-11   Family
    Bits 12-13  Processor type (Intel) / Reserved (AMD)
    Bits 14-15  Reserved
    Bits 16-19  Extended model
    Bits 20-27  Extended family
    Bits 28-31  Reserved

code: static uint32 GetCPUInfo()


description:
Uses cpuid instruction to get the vendor string
CPU vendor name


description: Gets the current crash handling type.


code: static [TArray](API\Runtime\Core\Containers\TArray)< [FCustomChunk](API\Runtime\Core\GenericPlatform\FCustomChunk) > GetCustomChunksByType ( ECustomChunkType DesiredChunkType )


description: This should be returned in IETF language tag form:


description: platform specific path separator.

code: static const TCHAR * GetDefaultPathSeparator()


description:
If you do not have permission to call this on one or more of your platforms, set GET_DEVICE_ID_UNAVAILABLE=1 in your build step to ensure that any calls that may be made to this API will simply return an empty string.
the unique string generated by this platform for this device, or an empty string if one is not available.


description: "DeviceMake|DeviceModel" if possible, and "CPUVendor|CPUBrand" otherwise, optionally returns "DeviceMake|DeviceModel|CPUChipset" if known


description:
Returns the current orientation of the device: will be either Portrait, LandscapeLeft, PortraitUpsideDown or LandscapeRight.
An EDeviceScreenOrientation value.


description:
Gets the default profile name. Used if there is no device profile specified
the default profile name.

code: static const TCHAR * GetDefaultDeviceProfileName()


description: Returns the current device temperature level. Level is a relative value that is platform dependent. Lower is cooler, higher is warmer. Level of -1 means Unimplemented.


description: Returns the device volume if the device is capable of returning that information. -1 : Unknown 0 : Muted 100 : Full Volume

code: static int32 GetDeviceVolume()


description: Retrieves information about the total number of bytes and number of free bytes for the specified disk path.

code: static bool GetDiskTotalAndFreeSpace ( const [FString](API\Runtime\Core\Containers\FString) & InPath, uint64 & TotalNumberOfBytes, uint64 & NumberOfFreeBytes )


description: Return the engine and project directory based from the executable. This function would return different results than EngineDir and Project dir if for example -basedir is set on cmd line and/or pak files are used

code: static bool GetEngineAndProjectAbsoluteDirsFromExecutable ( [FString](API\Runtime\Core\Containers\FString) & OutProjectDir, [FString](API\Runtime\Core\Containers\FString) & OutEngineDir )


description: Get a string description of the mode the engine was running in.

code: static const TCHAR * GetEngineMode()


description:
Retrieve a environment variable from the system
Value of the variable, or an empty string if not set.

code: static [FString](API\Runtime\Core\Containers\FString) GetEnvironmentVariable ( const TCHAR * VariableName )


description:
Note: This function is for Epic internal use only. Do not use.
an empty string if the account ID was not present or it failed to read it for any reason.


description: Get the name of the platform specific file manager (eg, Explorer on Windows, Finder on OS X)


code: static [FGPUDriverInfo](API\Runtime\Core\GenericPlatform\FGPUDriverInfo) GetGPUDriverInfo ( const [FString](API\Runtime\Core\Containers\FString) & DeviceDescription )


description:
Retrieve the Mac address of the current adapter as a hashed string (privacy). This generally relies onGetMacAddress()being implemented for the platform, if possible.
String representing the hashed Mac address, or empty string.


description:
Returns the currency code associated with the device's locale
the currency code associated with the device's locale


description:
Returns the currency symbol associated with the device's locale
the currency symbol associated with the device's locale


description:
Retrieve the Mac address of the current adapter. This is generally platform-dependent code that other platforms must implement.
array of bytes representing the Mac address, or empty array if unable to determine.

code: static [TArray](API\Runtime\Core\Containers\TArray)< uint8 > GetMacAddress()


description:
Retrieve the Mac address of the current adapter as a string. This generally relies onGetMacAddress()being implemented for the platform, if possible.
String representing the Mac address, or empty string.


description:
Note: This is NOT a user or machine fingerprint, as multiple logins on the same machine will not share the same ID, and it is not based on the hardware of the user. It is completely random and non-identifiable.
a string containing the LoginID, or empty if not available.


description: Get (or create) the unique ID used to identify this computer. This is sort of a misnomer, as there will actually be one per user account on the operating system. This is NOT based on a machine fingerprint.


description: Returns the maximum length of a path

code: static int32 GetMaxPathLength()


description: Retrieves the current maximum refresh rate supported by the platform

code: static int32 GetMaxRefreshRate()


description: Retrieves the maximum refresh rate supported by the platform


description: Returns the platform's maximum allowed value for rhi.SyncInterval

code: static int32 GetMaxSyncInterval()


description: For mobile devices, this function will return true if we wish to propagate the alpha to the backbuffer


description: Returns the current status for the network connection


description: Returns whether WiFi connection is currently active


description: Returns any platform-specific key-value data that needs to be sent to the network file server

code: static void GetNetworkFileCustomData ( [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > & OutCustomPlatformData )


description:
Determines the shader format for the platform
Returns the shader format to be used by that platform

code: static const TCHAR * GetNullRHIShaderFormat()


description: Deprecated* Use named chunks instead

code: static [TArray](API\Runtime\Core\Containers\TArray)< [FCustomChunk](API\Runtime\Core\GenericPlatform\FCustomChunk) > GetOnDemandChunksForPakchunkIndices ( const [TArray](API\Runtime\Core\Containers\TArray)< int32 > & PakchunkIndices )


description:
Gets a globally unique ID the represents a particular operating system install.
an opaque string representing the ID, or an empty string if the platform doesn't support one.


description: Gets a string representing the numeric OS version (as opposed to a translated OS version that GetOSVersions returns). The returned string should try to be brief and avoid newlines and symbols, but there's technically no restriction on the string it can return. If the implementation does not support this, it should return an empty string.


description: Gets the OS Version and OS Subversion.

code: static void GetOSVersions ( [FString](API\Runtime\Core\Containers\FString) & out_OSVersionLabel, [FString](API\Runtime\Core\Containers\FString) & out_OSSubVersionLabel )


description:
Gets Page Fault stats covering the lifetime of the process
Whether or not stats were successfully retrieved

code: static bool GetPageFaultStats ( [FPageFaultStats](API\Runtime\Core\GenericPlatform\FPageFaultStats) & OutStats, EPageFaultFlags Flags )


code: static int32 GetPakchunkIndexFromPakFile ( const [FString](API\Runtime\Core\Containers\FString) & InFilename )


description: Return the delimiter between paths in the PATH environment variable.

code: static const TCHAR * GetPathVarDelimiter()


description:
Returns the platform specific chunk based install interface
Returns the platform specific chunk based install implementation

code: static [IPlatformChunkInstall](API\Runtime\Core\GenericPlatform\IPlatformChunkInstall) * GetPlatformChunkInstall()


description: Return the name of the platform features module. Can be nullptr if there are no extra features for this platform

code: static const TCHAR * GetPlatformFeaturesModuleName()


description:
Returns the platform specific compression interface
Returns the platform specific compression interface

code: static IPlatformCompression * GetPlatformCompression()


description:
Returns the platform specific interface for communication with processes running on the host pc.
Returns the platform specific host communication interface.


description: Returns any platform specific warning messages we want printed on screen

code: static bool GetPlatformScreenWarnings ( [TArray](API\Runtime\Core\Containers\TArray)< [FText](API\Runtime\Core\Internationalization\FText) > & PlatformScreenWarnings )


description: Return the platform specific async IO system, or nullptr if the standard one should be used.

code: static FAsyncIOSystemBase * GetPlatformSpecificAsyncIOSystem()


description: Converts from a local user index to aFPlatformUserIdA platform-allocated opaque user id, or PLATFORMUSERID_NONE

code: static [FPlatformUserId](API\Runtime\Core\Misc\FPlatformUserId) GetPlatformUserForUserIndex ( int32 LocalUserIndex )


description:
Returns an array of the user's preferred languages in order of preference
An array of language IDs ordered from most preferred to least

code: static [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > GetPreferredLanguages()


description: primary GPU brand string


description: Returns non-zero if a performance-sensitive diagnostic, like a memory sanitizer, is detected for this process


description: a description of all the groups in the current system and their affinities

code: static const [FProcessorGroupDesc](API\Runtime\Core\GenericPlatform\FProcessorGroupDesc) & GetProcessorGroupDesc()


description:
Generates the SHA256 signature of the given data.
whether the hash was computed successfully

code: static bool GetSHA256Signature ( const void * Data, uint32 ByteSize, [FSHA256Signature](API\Runtime\Core\GenericPlatform\FSHA256Signature) & OutSignature )


description:
Get the value for the given section and key from the platform specific key->value store Note: The key->value store is user-specific, but may be used to share data between different applications for the same user
bool true if the entry was found (and OutValue contains the result), false if not

code: static bool GetStoredValue ( const [FString](API\Runtime\Core\Containers\FString) & InStoreId, const [FString](API\Runtime\Core\Containers\FString) & InSectionName, const [FString](API\Runtime\Core\Containers\FString) & InKeyName, [FString](API\Runtime\Core\Containers\FString) & OutValue )


description: Returns the last system error code in string form. NOTE: Only one return value is valid at a time!

code: static const TCHAR * GetSystemErrorMessage ( TCHAR * OutBuffer, int32 BufferCount, int32 Error )


description: Memory representing a true type or open type font provided by the platform as a default font for unreal to consume; empty array if the default font failed to load.

code: static [TArray](API\Runtime\Core\Containers\TArray)< uint8 > GetSystemFontBytes()


description: This should return either an Olson timezone (eg, "America/Los_Angeles") or an offset from GMT/UTC (eg, "GMT-8:00").


code: static const TCHAR * GetUBTPlatform()


code: static const TCHAR * GetUBTTargetName()


description:
Converts from aFPlatformUserIdto local user index
A valid logical index, or INDEX_NONE

code: static int32 GetUserIndexForPlatformUser ( [FPlatformUserId](API\Runtime\Core\Misc\FPlatformUserId) PlatformUser )


description:
Returns a unique string for advertising identification
the unique string generated by this platform for this device


description: Returns whether the platform wants to use a touch screen for virtual joysticks.

code: static bool GetUseVirtualJoysticks()


description: Return an ordered list of target platforms this runtime can support (ie Android_DXT, Android would mean that it prefers Android_DXT, but can use Android as well)

code: static void GetValidTargetPlatforms ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & TargetPlatformNames )


description: Returns whether the volume buttons are handled by the system


description: Returns whether WiFi connection is currently active

code: static bool HasActiveWiFiConnection()


description: Determines if a warning handler has been set

code: static bool HasMemoryWarningHandler()


description: whether this cpu supports certain required instructions or not

code: static bool HasNonoptionalCPUFeatures()


description: Returns whether the given platform feature is currently available (for instance, Metal is only available in IOS8 and with A7 devices)

code: static bool HasPlatformFeature ( const TCHAR * FeatureName )


description: Return true if the PersistentDownloadDir is available. On some platforms, a writable directory might not be available by default. Using this function allows handling that case early.


description: Whether the platform has a separate debug channel to stdout (eg. OutputDebugString on Windows). Used to suppress messages being output twice if both go to the same place.


description: Returns whether the platform has variable hardware (configurable/upgradeable system).

code: static bool HasVariableHardware()


code: static void HidePlatformStartupScreen()


description: Platform specific function for initializing storage of tagged memory buffers

code: static void InitTaggedStorage ( uint32 NumTags )


description: For platforms that support cache storage functionality, setting a directory for it when it's not available can result in errors. This method's purpose is to be overridden in such platforms, with logic that checks if said cache is available. In all other platforms without this constraint, it should return true by default.

code: static bool IsCacheStorageAvailable()


description:
Detects whether we're running in a 64-bit operating system.
true if we're running in a 64-bit operating system

code: static bool Is64bitOperatingSystem()


description:
Allows disabling ensure()s without rebuilding the binary, by either a commandline switch or a hotfix.
ensure is allowed

code: static bool IsEnsureAllowed()


description: Return true if a debugger is present

code: static bool IsDebuggerPresent()


description: Whether LocalPrint can be called from any thread without overlapping

code: static bool IsLocalPrintThreadSafe()


description: true if this build is meant for release to retail

code: static bool IsPackagedForDistribution()


description: Whether LowLevelOutputDebugString[f] can receive structured output as lines of JSON.


description: Returns true if this binary has been instrumented for collection of data needed for profile-guided optimization (PGO) This value is not expected to change during the run-time

code: static bool IsPGICapableBinary()


description: Returns true if PGI (profile-guided instrumentation, needed for PGO) is currently ongoing. Note that on some platforms can start and stop profile data collection.

code: static bool IsPGIActive()


description: Returns true if PGO is currently enabled

code: static bool IsPGOEnabled()


description: Returns whether or not the device has been registered to receive remote notifications.


description: Check to see if the platform is being viewed remotely. In such a mode we should aim to minimize screen refresh to get the best performance on the remote viewer

code: static bool IsRemoteSession()


description: Return if the game is running on cloud server

code: static bool IsRunningInCloud()


description: Returns whether the platform is running on battery power or not.

code: static bool IsRunningOnBattery()


description: return true if path is formatted validly

code: static bool IsValidAbsolutePathFormat ( const [FString](API\Runtime\Core\Containers\FString) & Path )


description: Get the directory the application was launched from (useful for commandline utilities)

code: static const TCHAR * LaunchDir()


description: Loads a text file relative to the package root on platforms that distribute apps in package formats. For other platforms, the path is relative to the root directory.

code: static [FString](API\Runtime\Core\Containers\FString) LoadTextFileFromPlatformPackage ( const [FString](API\Runtime\Core\Containers\FString) & RelativePath )


description: Prints string to the default output

code: static void LocalPrint ( const TCHAR * Str )


description: Sends a message to a remote tool, and debugger consoles

code: static void LowLevelOutputDebugString ( const TCHAR * Message )


code: static void LowLevelOutputDebugStringf ( const TCHAR * Format, ... )


description:
Show a message box if possible, otherwise print a message and return the default
Very strange convention...not really EAppReturnType, see implementation

code: static [EAppReturnType::Type](API\Runtime\Core\GenericPlatform\EAppReturnType__Type) MessageBoxExt ( [EAppMsgType::Type](API\Runtime\Core\GenericPlatform\EAppMsgType__Type) MsgType, const TCHAR * Text, const TCHAR * Caption )


description: Enforces strict memory load/store ordering across the memory barrier call.

code: static void MemoryBarrier()


description: whether to check for specific CPU compatibility or not


description: Platform-specific normalization of path E.g. on Linux/Unix platforms, replaces ~ with user home directory, so ~/.config becomes /home/joe/.config (or /Users/Joe/.config)

code: static void NormalizePath ( [FString](API\Runtime\Core\Containers\FString) & InPath )


code: static void NormalizePath ( FStringBuilderBase & InPath )


description: Return the number of hardware CPU cores

code: static int32 NumberOfCores()


description: Return the number of logical CPU cores


description: Return the number of worker threads we should spawn, based on number of cores


description: Return the number of worker threads we should spawn to service IO, NOT based on number of cores


description:
Has the OS execute a command and path pair (such as launch a browser)
whether the command was successful or not

code: static bool OsExecute ( const TCHAR * CommandType, const TCHAR * Command, const TCHAR * CommandLine )


code: static void ParseChunkIdPakchunkIndexMapping ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > ChunkIndexRedirects, [TMap](API\Runtime\Core\Containers\TMap)< int32, int32 > & OutMapping )


description: Called to dismiss splash screen

code: static void PlatformHandleSplashScreen ( bool ShowSplashScreen )


description: Called during appInit() after cmd line setup

code: static void PlatformPreInit()


description: Called during AppExit(). Log, Config still exist at this point, but not much else does.

code: static void PlatformTearDown()


code: static void Prefetch ( const void * Ptr )


code: static void Prefetch ( const void * Ptr, int32 Offset )


description: Deprecated* Must supply size when prefetching a block of data

code: static void PrefetchBlock ( const void * Ptr )


code: static void PrefetchBlock ( const void * Ptr, int32 NumBytes )


description: For mobile devices, this will crank up a haptic engine for the specified type to be played later with TriggerMobileHaptics If this is called again before Release, it will switch to this type

code: static void PrepareMobileHaptics ( EMobileHapticsType Type )


description: Return the project directory

code: static const TCHAR * ProjectDir()


code: static void PromptForRemoteDebugging ( bool bIsEnsure )


description: Pumps app messages only if there are essential keep-alive messages pending. This function called from time-sensitive parts of the code and should take minimal time if there are no essential messages waiting

code: static void PumpEssentialAppMessages()


code: static void PumpMessagesForSlowTask()


code: static void RaiseException ( uint32 ExceptionCode )


description: Requests permission to send remote notifications to the user's device.


description: For mobile devices, this will shutdown the haptics, allowing system to put it to reset as needed

code: static void ReleaseMobileHaptics()


code: static bool RemoveNetworkListener ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) Handle )


code: static bool RequestDeviceCheckToken ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > &)> QuerySucceededFunc, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(const [FString](API\Runtime\Core\Containers\FString) &, const [FString](API\Runtime\Core\Containers\FString) &)> QueryFailedFunc )


description: Requests application exit.

code: static void RequestExit ( bool Force, const TCHAR * CallSite )


description: Requests application exit with a specified return code. Name is different fromRequestExit()so overloads of just one of functions are possible.

code: static void RequestExitWithStatus ( bool Force, uint8 ReturnCode, const TCHAR * CallSite )


description: Requests application to restart appending the passed in CmdLine to the restart

code: static bool RestartApplicationWithCmdLine ( const char * CmdLine )


description: Get the application root directory.

code: static const TCHAR * RootDir()


description: Requests application to restart

code: static bool RestartApplication()


description: Change the allowed orientation of the device.

code: static void SetAllowedDeviceOrientation ( EDeviceScreenOrientation NewAllowedDeviceOrientation )


description: Installs handler for the unexpected (due to error) termination of the program, including, but not limited to, crashes.

code: static void SetCrashHandler ( void(*)(const [FGenericCrashContext](API\Runtime\Core\GenericPlatform\FGenericCrashContext) &[Context](API\Plugins\StateTreeModule\EStateTreeBindableStructSource)) CrashHandler )


code: static void SetBrightness ( float bBright )


description: Sets the type of crash handling done by the engine. Returns the new crash handling type. If disabling crash handling make sure an alternative is active since threads that crash will just disappear.

code: static ECrashHandlingType SetCrashHandlingType ( ECrashHandlingType Type )


description: Sets an environment variable to the local process's environment

code: static void SetEnvironmentVar ( const TCHAR * VariableName, const TCHAR * Value )


description: Change the orientation of the device.

code: static void SetDeviceOrientation ( EDeviceScreenOrientation NewDeviceOrientation )


description: Set/restore the Console Interrupt (Control-C, Control-Break, Close) handler.


code: static void SetLastError ( uint32 ErrorCode )


description: Updates the current status for the network connection

code: static void SetNetworkConnectionStatus ( ENetworkConnectionStatus NewNetworkConnectionStatus )


description: Set a handler to be called when there is a memory warning from the OS

code: static void SetMemoryWarningHandler ( void(*)(const [FGenericMemoryWarningContext](API\Runtime\Core\GenericPlatform\FGenericMemoryWarningContext) &[Context](API\Plugins\StateTreeModule\EStateTreeBindableStructSource)) Handler )


description: Deprecated* FPaths::SetOverrideGameDir() has been superseded by FPaths::SetOverrideProjectDir().

code: static void SetOverrideGameDir ( const [FString](API\Runtime\Core\Containers\FString) & InOverrideDir )


description: Allows a game/program/etc to control the game directory in a special place (for instance, monolithic programs that don't have .uprojects)

code: static void SetOverrideProjectDir ( const [FString](API\Runtime\Core\Containers\FString) & InOverrideDir )


code: static void SetShouldPromptForRemoteDebugging ( bool bInShouldPrompt )


code: static void SetShouldPromptForRemoteDebugOnEnsure ( bool bInShouldPrompt )


description:
Set the value for the given section and key in the platform specific key->value store Note: The key->value store is user-specific, but may be used to share data between different applications for the same user
bool true if the value was set correctly, false if not

code: static bool SetStoredValue ( const [FString](API\Runtime\Core\Containers\FString) & InStoreId, const [FString](API\Runtime\Core\Containers\FString) & InSectionName, const [FString](API\Runtime\Core\Containers\FString) & InKeyName, const [FString](API\Runtime\Core\Containers\FString) & InValue )


code: static bool SetStoredValues ( const [FString](API\Runtime\Core\Containers\FString) & InStoreId, const [FString](API\Runtime\Core\Containers\FString) & InSectionName, const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > & InKeyValues )


code: static void SetUBTTargetName ( const TCHAR * InTargetName )


description: Unix only function, but put a stub so we can call this for higher level code when we want to setup the Syscall Filters

code: static bool SetupSyscallFilters()


description: Sets the default output to UTF8

code: static void SetUTF8Output()


description: Set whether the volume buttons are handled by the system

code: static void SetVolumeButtonsHandledBySystem ( bool enabled )


description: Perform a mobile-style sharing of a URL. Will use native UI to display sharing target

code: static void ShareURL ( const [FString](API\Runtime\Core\Containers\FString) & URL, const [FText](API\Runtime\Core\Internationalization\FText) & Description, int32 LocationHintX, int32 LocationHintY )


description:
Allows platform at runtime to disable unsupported plugins
bool true if plugin should be disabled

code: static bool ShouldDisablePluginAtRuntime ( const [FString](API\Runtime\Core\Containers\FString) & PluginName )


description: Platform specific function for freeing storage of tagged memory buffers

code: static void ShutdownTaggedStorage()


description:
On platforms that support run-time PGI on/off, starts a new collection with a given file name.
true if everything was successful

code: static bool StartNewPGOCollection ( const [FString](API\Runtime\Core\Containers\FString) & AbsoluteFileName )


description: Stats logging for named event

code: template<typename CharType> static void StatNamedEvent ( const CharType * Text )


description:
On platforms that support run-time PGI on/off, stops the current collection and writes out the file (or completes its write). The filename must have been given to the StartNewPGICollection() at the start of collection (it is needed in advance since the collection process may stream to it).
true if everything was successful


description: Submits a crash report to a central server (release builds only)

code: static void SubmitErrorReport ( const TCHAR * InErrorHist, [EErrorReportMode::Type](API\Runtime\Core\GenericPlatform\EErrorReportMode__Type) InMode )


code: static bool SupportsDeviceCheckToken()


code: static bool SupportsForceTouchInput()


description: Platform can generate a full-memory crashdump during crash handling.

code: static bool SupportsFullCrashDumps()


description: Whether filehandles can be opened on one thread and read/written on another thread


description: Platform specific function for tagging a memory buffer with a label. Helps see memory access in profilers

code: static void TagBuffer ( const char * Label, uint32 Category, const void * Buffer, size_t BufferSize )


description: Frees any memory retained byFGenericPlatformMisc.

code: static void TearDown()


description: Ticks values that can be hotfixable in the config.

code: static void TickHotfixables()


description: Stats logging for named event

code: static void TickStatNamedEvents()


description: Requests unregistering from receiving remote notifications on the user's device.


description: Updates hotfixable ensure settings from config and commandline (config takes priority).


description:
Checks if platform wants to use a rendering thread on current device
true if allowed, false if shouldn't use a separate rendering thread

code: static bool UseRenderThread()


description: For mobile devices, this will kick the haptic type that was set in PrepareMobileHaptics. It can be called multiple times with only a single call to Prepare

code: static void TriggerMobileHaptics()


className: FGenericPlatformMisc

description: Generic implementation for most platforms

code: struct FGenericPlatformMisc


className: AbsoluteFileNameMaxLength

code: static constexpr SIZE_T AbsoluteFileNameMaxLength = 1024;


className: CachedAbsoluteFilename

code: static TCHAR CachedAbsoluteFilename = { 0 };


description: Returns the absolute log filename generated from the project properties and/or command line parameters. The returned value may change during the execution, may not exist yet or may be locked by another process. It depends if the function is called before the log file was successfully opened or after. The log file is open lazily.


code: static [FOutputDeviceError](API\Runtime\Core\Misc\FOutputDeviceError) * GetError()


code: static [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) * GetEventLog()


code: static [FFeedbackContext](API\Runtime\Core\Misc\FFeedbackContext) * GetFeedbackContext()


code: static [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) * GetLog()


code: static void GetPerChannelFileOverrides ( [TArray](API\Runtime\Core\Containers\TArray)< [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) * > & OutputDevices )


className: FGenericPlatformOutputDevices

code: struct FGenericPlatformOutputDevices


description: Adds a directory to search in when resolving implicitly loaded or filename-only DLLs.

code: static void AddDllDirectory ( const TCHAR * Directory )


className: Context

code: enum Context { LocalUser, RoamingUser, ApplicationSpecific, }


className: ApplicationSettingsContext

code: struct ApplicationSettingsContext

bIsEpic

type: bool

Location

type: Context


description: Add output devices which can vary depending on platform, configuration, command line parameters.

code: static void SetupOutputDevices()


description: Get application settings directory. NOTE: Only one return value is valid at a time!

code: static const TCHAR * ApplicationSettingsDir()


description: Get startup directory. NOTE: Only one return value is valid at a time!

code: static const TCHAR * BaseDir()


description: Checks if the platform can launch a uniform resource locator (i.e.http://www.epicgames.com/unreal).

code: static bool CanLaunchURL ( const TCHAR * URL )


description: Clean the shader working directory

code: static void CleanShaderWorkingDir()


description: ReadPipe

code: static void ClosePipe ( void * ReadPipe, void * WritePipe )


description: Cleans upFProcHandleafter we're done with it.

code: static void CloseProc ( [FProcHandle](API\Runtime\Core\Unix\FProcHandle) & ProcessHandle )


description: Get computer name. NOTE: Only one return value is valid at a time!

code: static const TCHAR * ComputerName()


description: Sleep thread until condition is satisfied.

code: static void ConditionalSleep ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool()> Condition, float SleepTime )


description: ReadPipe

code: static bool CreatePipe ( void *& ReadPipe, void *& WritePipe, bool bWritePipeLocal )


description:
Creates a new process and its primary thread. The new process runs the specified executable file in the security context of the calling process.
The process handle for use in other process functions

code: static [FProcHandle](API\Runtime\Core\Unix\FProcHandle) CreateProc ( const TCHAR * URL, const TCHAR * Parms, bool bLaunchDetached, bool bLaunchHidden, bool bLaunchReallyHidden, uint32 * OutProcessID, int32 PriorityModifier, const TCHAR * OptionalWorkingDirectory, void * PipeWriteChild, void * PipeReadChild )


description:
Creates a new process and its primary thread, with separate std pipes. The new process runs the specified executable file in the security context of the calling process.
The process handle for use in other process functions

code: static [FProcHandle](API\Runtime\Core\Unix\FProcHandle) CreateProc ( const TCHAR * URL, const TCHAR * Parms, bool bLaunchDetached, bool bLaunchHidden, bool bLaunchReallyHidden, uint32 * OutProcessID, int32 PriorityModifier, const TCHAR * OptionalWorkingDirectory, void * PipeWriteChild, void * PipeReadChild, void * PipeStdErrChild )


description:
Creates the platform-specific runnable thread. This should only be called fromFRunnableThread::Create.
The newly created thread

code: static [FRunnableThread](API\Runtime\Core\HAL\FRunnableThread) * CreateRunnableThread()


description: but it should only ever be called from TEventPool::GetEventFromPool()

code: static [FEvent](API\Runtime\Core\HAL\FEvent) * CreateSynchEvent ( bool bIsManualReset )


description:
Makes process run as a system service (daemon), i.e. detaches it from whatever user session it was initially run from.
true if successful, false otherwise.

code: static bool Daemonize()


description: Deletes an interprocess synchronization object.

code: static bool DeleteInterprocessSynchObject ( [FSemaphore](API\Runtime\Core\GenericPlatform\FGenericPlatformProcess\FSemaphore) * Object )


description: Output information about the currently active thread

code: static void DumpThreadInfo ( const TCHAR * MarkerName )


description: Executes a process as administrator, requesting elevation as necessary. This call blocks until the process has returned.

code: static bool ExecElevatedProcess ( const TCHAR * URL, const TCHAR * Params, int32 * OutReturnCode )


description: Executes a process, returning the return code, stdout, and stderr. This call blocks until the process has returned.

code: static bool ExecProcess ( const TCHAR * URL, const TCHAR * Params, int32 * OutReturnCode, [FString](API\Runtime\Core\Containers\FString) * OutStdOut, [FString](API\Runtime\Core\Containers\FString) * OutStdErr, const TCHAR * OptionalWorkingDirectory, bool bShouldEndWithParentProcess )


description:
Return the name of the currently running executable
Name of the currently running executable

code: static const TCHAR * ExecutableName ( bool bRemoveExtension )


description:
Return the path to the currently running executable
Path of the currently running executable

code: static const TCHAR * ExecutablePath()


description: Attempt to "explore" the folder specified by the provided file path

code: static void ExploreFolder ( const TCHAR * FilePath )


description: Deletes all the recycled sync events contained by the pools

code: static void FlushPoolSyncEvents()


description: Free a DLL.

code: static void FreeDllHandle ( void * DllHandle )


description: Returns the name of the object

code: const TCHAR &42; GetName&40;&41; const


className: Limits

code: enum Limits { MaxSemaphoreName = 128, }


description: Acquires an exclusive access (also known as Wait())

code: void Lock&40;&41;


className: EWaitAndForkResult

code: enum EWaitAndForkResult { Error, Parent, Child, }


description:
Tries to acquire and exclusive access for a specified amount of nanoseconds (also known as TryWait()).
false if was not able to lock within given time

code: bool TryLock &40; uint64 NanosecondsToWait &41;


description: Relinquishes an exclusive access (also known as Release())

code: void Unlock&40;&41;


description: Creates and initializes a new instance with the specified name.

code: FSemaphore &40; const FString & InName &41;


code: FSemaphore &40; const TCHAR &42; InName &41;


description: Virtual destructor.

code: virtual &126;FSemaphore&40;&41;


className: FSemaphore

description: Generic representation of a interprocess semaphore

code: struct FSemaphore

Name

type: TCHAR[MaxSemaph...

description: Name of the region


description:
The application must reside in the Engine's binaries directory. The returned path is relative to this executable's directory.For example, calling this method with "UE4" and EBuildConfiguration::Debug on Windows 64-bit will generate the path "../Win64/UnrealEditor-Win64-Debug.exe"
The generated application path.

code: static [FString](API\Runtime\Core\Containers\FString) GenerateApplicationPath ( const [FString](API\Runtime\Core\Containers\FString) & AppName, EBuildConfiguration BuildConfiguration )


description: Outputs the virtual memory usage, of the process with the specified PID

code: static bool GetApplicationMemoryUsage ( uint32 ProcessId, SIZE_T * OutMemoryUsage )


description: Returns the Name of process given by the PID. Returns Empty string "" if PID not found.

code: static [FString](API\Runtime\Core\Containers\FString) GetApplicationName ( uint32 ProcessId )


description:
Get application settings directory for a given context.
A string to the appropriate directory.

code: static [FString](API\Runtime\Core\Containers\FString) GetApplicationSettingsDir ( const [ApplicationSettingsContext](API\Runtime\Core\GenericPlatform\FGenericPlatformProcess\ApplicationSetti-) & Settings )


description: Used only by platforms with DLLs, this gives the subdirectory from binaries to find the executables

code: static const TCHAR * GetBinariesSubdirectory()


description:
Retrieves the current hardware CPU core
the current hardware core.

code: static uint32 GetCurrentCoreNumber()


description:
Retrieves the ProcessId of this process.
the ProcessId of this process.

code: static uint32 GetCurrentProcessId()


description: Get the current working directory (only really makes sense on desktop platforms)


description: Specifies the thread to use forUObjectreference collection


description: Get the list of registered directories to search in when resolving implicitly loaded or filename-only DLLs.

code: static void GetDllDirectories ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutDllDirectories )


description: Lookup the address of a DLL function.

code: static void * GetDllExport ( void * DllHandle, const TCHAR * ProcName )


description: Load a DLL.

code: static void * GetDllHandle ( const TCHAR * Filename )


description:
Retrieves the platform-specific bundle identifier or package name of the game
The game's bundle identifier or package name.


description: GetModulesDirectory

code: static const TCHAR * GetModuleExtension()


description: GetModulesDirectory

code: static const TCHAR * GetModulePrefix()


description: GetModuleExtension

code: static const [FString](API\Runtime\Core\Containers\FString) GetModulesDirectory()


description: Retrieves the termination status of the specified process.

code: static bool GetProcReturnCode ( [FProcHandle](API\Runtime\Core\Unix\FProcHandle) & ProcHandle, int32 * ReturnCode )


description: Get the active stack size for the currently running thread

code: static uint32 GetStackSize()


description: ReturnSynchEventToPool

code: static [FEvent](API\Runtime\Core\HAL\FEvent) * GetSynchEventFromPool ( bool bIsManualReset )


description: Returns true if the specified application is running

code: static bool IsApplicationRunning ( uint32 ProcessId )


code: static bool IsApplicationRunning ( const TCHAR * ProcName )


description: Checks if we're the first instance. An instance can become first if the previous first instance quits before it.

code: static bool IsFirstInstance()


description:
Returns true if the specified process is running
true if the process is still running

code: static bool IsProcRunning ( [FProcHandle](API\Runtime\Core\Unix\FProcHandle) & ProcessHandle )


description:
Attempt to launch the provided file name in its default external application. Similar to FPlatformProcess::LaunchURL, with the exception that if a default application isn't found for the file, the user will be prompted with an "Open With..." dialog.
true if the file is launched successfully, false otherwise.

code: static bool LaunchFileInDefaultExternalApplication ( const TCHAR * FileName, const TCHAR * Parms, [ELaunchVerb::Type](API\Runtime\Core\GenericPlatform\ELaunchVerb__Type) Verb, bool bPromptToOpenOnFailure )


description: Launch a uniform resource locator (i.e.http://www.epicgames.com/unreal). This is expected to return immediately as the URL is launched by another task. The URL param must already be a valid URL. If you're looking for code to properly escape a URL fragment, useFGenericPlatformHttp::UrlEncode.

code: static void LaunchURL ( const TCHAR * URL, const TCHAR * Parms, [FString](API\Runtime\Core\Containers\FString) * Error )


description:
Launch a uniform resource locator (i.e.http://www.epicgames.com/unreal). This is expected to return immediately as the URL is launched by another task. The URL param must already be a valid URL. The URL is passed through the filter parameter for an added measure of security if the URL is from and untrusted source. If you're looking for code to properly escape a URL fragment, useFGenericPlatformHttp::UrlEncode.
true if URL passed the filter and was launched, false if it was rejected by the filter.

code: static bool LaunchURLFiltered ( const TCHAR * URL, const TCHAR * Parms, [FString](API\Runtime\Core\Containers\FString) * Error, const [UE::Core::FURLRequestFilter](API\Runtime\Core\Misc\FURLRequestFilter) & Filter )


description: Allows a platform to override the threading configuration for reference collection

code: static void ModifyThreadAssignmentForUObjectReferenceCollector ( int32 & NumThreads, int32 & NumBackgroundThreads, [ENamedThreads::Type](API\Runtime\Core\Async\ENamedThreads__Type) & NormalThreadName, [ENamedThreads::Type](API\Runtime\Core\Async\ENamedThreads__Type) & BackgroundThreadName )


description:
Creates or opens an interprocess synchronization object.
Pointer to heap allocated semaphore object. Caller is responsible for deletion.

code: static [FSemaphore](API\Runtime\Core\GenericPlatform\FGenericPlatformProcess\FSemaphore) * NewInterprocessSynchObject ( const [FString](API\Runtime\Core\Containers\FString) & Name, bool bCreate, uint32 MaxLocks )


code: static [FSemaphore](API\Runtime\Core\GenericPlatform\FGenericPlatformProcess\FSemaphore) * NewInterprocessSynchObject ( const TCHAR * Name, bool bCreate, uint32 MaxLocks )


description:
Opens an existing process.
The process handle for use in other process functions

code: static [FProcHandle](API\Runtime\Core\Unix\FProcHandle) OpenProcess ( uint32 ProcessID )


description: Unsets a directory to look for DLL files. The same directory must be passed in as the Push call to validate

code: static void PopDllDirectory ( const TCHAR * Directory )


description: Set a directory to look for DLL files. NEEDS to have a Pop call when complete

code: static void PushDllDirectory ( const TCHAR * Directory )


description: CreatePipe

code: static [FString](API\Runtime\Core\Containers\FString) ReadPipe ( void * ReadPipe )


description: CreatePipe

code: static bool ReadPipeToArray ( void * ReadPipe, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Output )


description: GetSynchEventFromPool

code: static void ReturnSynchEventToPool ( [FEvent](API\Runtime\Core\HAL\FEvent) * Event )


description:
Sets the process limits.
true on success, false otherwise.

code: static bool SetProcessLimits ( [EProcessResource::Type](API\Runtime\Core\GenericPlatform\EProcessResource__Type) Resource, uint64 Limit )


description: Enables Real Time Mode on the current thread.

code: static void SetRealTimeMode()


code: static void SetShaderDir ( const TCHAR * Where )


description: Change the thread processor affinity

code: static void SetThreadAffinityMask ( uint64 AffinityMask )


description: Helper function to set thread name of the current thread.

code: static void SetThreadName ( const TCHAR * ThreadName )


description: Change the thread processor priority

code: static void SetThreadPriority ( EThreadPriority NewPriority )


description: Allow the platform to do anything it needs for audio thread

code: static void SetupAudioThread()


description: Allow the platform to do anything it needs for the RHI thread

code: static void SetupRHIThread()


description: Allow the platform to do anything it needs for game thread

code: static void SetupGameThread()


description:
Get the shader working directory
The path to the directory.

code: static const [FString](API\Runtime\Core\Containers\FString) ShaderWorkingDir()


description: Content saved to the game or engine directories should be rerouted to user directories instead

code: static bool ShouldSaveToUserDir()


description: Force skip calling FThreadStats::WaitForStats()

code: static bool SkipWaitForStats()


description: Sleep this thread for Seconds. 0.0 means release the current time slice to let other threads get some attention. Uses stats.

code: static void Sleep ( float Seconds )


description: Sleep this thread infinitely.

code: static void SleepInfinite()


description: Sleep this thread for Seconds. 0.0 means release the current time slice to let other threads get some attention.

code: static void SleepNoStats ( float Seconds )


description:
Gets whether this platform can use multiple threads.
true if the platform can use multiple threads, false otherwise.

code: static bool SupportsMultithreading()


description: Tears down allocated process resources.

code: static void TearDown()


description: Allow the platform to do anything it needs for render thread

code: static void SetupRenderThread()


description: Allow the platform to tear down the audio thread

code: static void TeardownAudioThread()


description: Terminates a process

code: static void TerminateProc ( [FProcHandle](API\Runtime\Core\Unix\FProcHandle) & ProcessHandle, bool KillTree )


description: Terminates a process tree

code: static void TerminateProcTreeWithPredicate ( [FProcHandle](API\Runtime\Core\Unix\FProcHandle) & ProcessHandle, [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool(uint32 ProcessId, const TCHAR *ApplicationName)> Predicate )


description: Get user directory. NOTE: Only one return value is valid at a time!

code: static const TCHAR * UserDir()


description: Get the user home directory. NOTE: Only one return value is valid at a time!

code: static const TCHAR * UserHomeDir()


description: Get user name. NOTE: Only one return value is valid at a time!

code: static const TCHAR * UserName ( bool bOnlyAlphaNumeric )


description: Get the user settings directory. NOTE: Only one return value is valid at a time!

code: static const TCHAR * UserSettingsDir()


description: Get the user temporary directory. NOTE: Only one return value is valid at a time!

code: static const TCHAR * UserTempDir()


description: WaitAndFork stalls the invoking process and forks child processes when signals are sent to it from an external source. Forked child processes will provide a return value ofEWaitAndForkResult::Child, while the parent process will not return until IsEngineExitRequested() is true (EWaitAndForkResult::Parent) or there was an error (EWaitAndForkResult::Error) The signal the parent process expects is platform-specific (i.e. SIGRTMIN+1 on Linux).


description: Waits for a process to stop

code: static void WaitForProc ( [FProcHandle](API\Runtime\Core\Unix\FProcHandle) & ProcessHandle )


description: ReadPipe

code: static bool WritePipe ( void * WritePipe, const [FString](API\Runtime\Core\Containers\FString) & Message, [FString](API\Runtime\Core\Containers\FString) * OutWritten )


description: ReadPipe

code: static bool WritePipe ( void * WritePipe, const uint8 * Data, const int32 DataLength, int32 * OutDataLength )


description: Tells the processor to pause for implementation-specific amount of time. Is used for spin-loops to improve the speed at which the code detects the release of the lock and power-consumption.

code: static void Yield()


description: Tells the processor to pause for at least the amount of cycles given. Is used for spin-loops to improve the speed at which the code detects the release of the lock and power-consumption.

code: static void YieldCycles ( uint64 Cycles )


description: Yield this thread so another may run for a while.

code: static void YieldThread()


className: FGenericPlatformProcess

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

code: struct FGenericPlatformProcess


description: Whether the platform allows the call stack to be dumped during an assert.


description: Whether this platform wants to allow framerate smoothing or not.

code: static bool AllowsFramerateSmoothing()


description:
Gets the platform's physics format.
The physics format name.

code: static const char * GetPhysicsFormat()


description: If this platform wants to replace Zlib with a platform-specific version, set the name of the compression format plugin (matching its GetCompressionFormatName() function) in an override of this function

code: static const char * GetZlibReplacementFormat()


description:
Gets whether this platform has Editor-only data.
true if the platform has Editor-only data, false otherwise.

code: static bool HasEditorOnlyData()


description: Gets whether user settings should override the resolution or not

code: static bool HasFixedResolution()


description:
Checks whether shipped data on this platform is secure, and doesn't require extra encryption/signing to protect it.
true if packaged data is considered secure, false otherwise.

code: static bool HasSecurePackageFormat()


description:
Note: MUST be implemented per platform.
Platform name.

code: static const char * IniPlatformName()


description:
Gets whether this is a client only (no capability to run the game without connecting to a server) platform.
true if this is a client only platform, false otherwise.

code: static bool IsClientOnly()


description:
Gets whether this is a server only platform.
true if this is a server only platform, false otherwise.

code: static bool IsServerOnly()


description:
Note: MUST be implemented per platform.
Platform Name.

code: static const char * PlatformName()


description:
Checks whether this platform requires cooked data.
true if cooked data is required, false otherwise.

code: static bool RequiresCookedData()


description:
Gets whether this is a game only platform.
true if this is a game only platform, false otherwise.

code: static bool IsGameOnly()


description:
Gets whether this is a Little Endian platform.
true if the platform is Little Endian, false otherwise.

code: static bool IsLittleEndian()


description: Gets whether this was a monolithic build or not

code: static bool IsMonolithicBuild()


description: Gets whether this was a program or not

code: static bool IsProgram()


description: Whether the platform requires an original release version to make a patch.


description:
Checks whether this platform requires user credentials (typically server platforms).
true if this platform requires user credentials, false otherwise.

code: static bool RequiresUserCredentials()


description: Whether this platform supports streaming audio

code: static bool SupportsAudioStreaming()


description: Returns true if platform supports the AutoSDK system

code: static bool SupportsAutoSDK()


description:
Checks whether the specified build target is supported.
true if the build target is supported, false otherwise.

code: static bool SupportsBuildTarget ( EBuildTargetType TargetType )


code: static bool SupportsDistanceFieldAO()


description:
Gets whether this platform supports gray scale sRGB texture formats.
true if gray scale sRGB texture formats are supported.

code: static bool SupportsGrayscaleSRGB()


code: static bool SupportsMemoryMappedFiles()


code: static bool SupportsMemoryMappedAudio()


code: static bool SupportsMeshLODStreaming()


description:
Checks whether this platforms supports running multiple game instances on a single device.
true if multiple instances are supported, false otherwise.


description: Whether the platform allows an application to quit to the OS.

code: static bool SupportsQuit()


code: static bool SupportsTextureStreaming()


description:
Gets whether this platform supports windowed mode rendering.
true if windowed mode is supported.

code: static bool SupportsWindowedMode()


className: FGenericPlatformProperties

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

code: struct FGenericPlatformProperties


description: Capture a stack backtrace for a specific thread.

code: static uint32 CaptureThreadStackBackTrace ( uint64 ThreadId, uint64 * BackTrace, uint32 MaxDepth, void * Context )


className: AccurateStackWalk

description: Default value (empty set of flags).

code: enum &123; AccurateStackWalk = 0 &125;


className: FastStackWalk

description: Used when preferring speed over more information. Platform-specific, may be ignored, or may result in non-symbolicated callstacks or missing some other information.

code: enum &123; FastStackWalk = (1 << 0) &125;


className: FlagsUsedWhenHandlingEnsure

description: This is a set of flags that will be passed when unwinding the callstack for ensure().

code: enum &123; FlagsUsedWhenHandlingEnsure = (FastStackWalk) &125;


className: EStackWalkFlags

code: struct EStackWalkFlags


description:
Gets the signature for every module loaded by the currently running process.
The number of modules copied into ModuleSignatures

code: static int32 GetProcessModuleSignatures ( [FStackWalkModuleInfo](API\Runtime\Core\GenericPlatform\FStackWalkModuleInfo) * ModuleSignatures, const int32 ModuleSignaturesSize )


description: Capture a stack backtrace and optionally use the passed in exception pointers.

code: static uint32 CaptureStackBackTrace ( uint64 * BackTrace, uint32 MaxDepth, void * Context )


description: Returns the number of modules loaded by the currently running process.

code: static int32 GetProcessModuleCount()


description:
Walks the stack and updates the Stack array with the symbol information for each line in the stack.
The stack of symbols to return.

code: static [TArray](API\Runtime\Core\Containers\TArray)< [FProgramCounterSymbolInfo](API\Runtime\Core\GenericPlatform\FProgramCounterSymbolInfo) > GetStack ( int32 IgnoreCount, int32 MaxDepth, void * Context )


description:
Gets the meta-data associated with all symbols of this target. This may include things that are needed to perform further offline processing of symbol information (eg, the source binary).
A map containing the meta-data (if any).

code: static [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [FString](API\Runtime\Core\Containers\FString) > GetSymbolMetaData()


description: Initializes options related to stack walking from ini, i.e. how detailed the stack walking should be, performance settings etc.

code: static void Init()


description:
Like InitStackWalking but initializes stack walking for another process.
True if successful, false otherwise.

code: static bool InitStackWalkingForProcess ( const [FProcHandle](API\Runtime\Core\Unix\FProcHandle) & Process )


description: Initializes stack traversal and symbol. Must be called before any other stack/symbol functions. Safe to reenter.

code: static bool InitStackWalking()


description:
UE4Editor_Core!FOutputDeviceWindowsErrorSerialize() (0xddf1bae5) + 620 bytes [.cpp:110] ModuleName!FunctionName (ProgramCounter) + offset bytes [StrippedFilepath:LineNumber]
true if the symbol was found, otherwise false

code: static bool ProgramCounterToHumanReadableString ( int32 CurrentCallDepth, uint64 ProgramCounter, ANSICHAR * HumanReadableString, SIZE_T HumanReadableStringSize, [FGenericCrashContext](API\Runtime\Core\GenericPlatform\FGenericCrashContext) * Context )


description: Same as above, but can be used with external applications since it doesn't re-initialize the active process.

code: static void ProgramCounterToSymbolInfoEx ( uint64 ProgramCounter, [FProgramCounterSymbolInfoEx](API\Runtime\Core\GenericPlatform\FProgramCounterSymbolInfoEx) & out_SymbolInfo )


description: The code assumes that the destination strings are big enough

code: static void ProgramCounterToSymbolInfo ( uint64 ProgramCounter, [FProgramCounterSymbolInfo](API\Runtime\Core\GenericPlatform\FProgramCounterSymbolInfo) & out_SymbolInfo )


description: The code assumes that HumanReadableString is large enough to contain the information.

code: static void StackWalkAndDump ( ANSICHAR * HumanReadableString, SIZE_T HumanReadableStringSize, void * ProgramCounter, void * Context )


code: static void StackWalkAndDump ( ANSICHAR * HumanReadableString, SIZE_T HumanReadableStringSize, int32 IgnoreCount, void * Context )


code: static void StackWalkAndDumpEx ( ANSICHAR * HumanReadableString, SIZE_T HumanReadableStringSize, int32 IgnoreCount, uint32 Flags, void * Context )


code: static void StackWalkAndDumpEx ( ANSICHAR * HumanReadableString, SIZE_T HumanReadableStringSize, void * ProgramCounter, uint32 Flags, void * Context )


code: static bool SymbolInfoToHumanReadableString ( const [FProgramCounterSymbolInfo](API\Runtime\Core\GenericPlatform\FProgramCounterSymbolInfo) & SymbolInfo, ANSICHAR * HumanReadableString, SIZE_T HumanReadableStringSize )


description: Same as above, but can be used with external applications.

code: static bool SymbolInfoToHumanReadableStringEx ( const [FProgramCounterSymbolInfoEx](API\Runtime\Core\GenericPlatform\FProgramCounterSymbolInfoEx) & SymbolInfo, [FString](API\Runtime\Core\Containers\FString) & out_HumanReadableString )


code: static void ThreadStackWalkAndDump ( ANSICHAR * HumanReadableString, SIZE_T HumanReadableStringSize, int32 IgnoreCount, uint32 ThreadId )


description: Returns true if non-monolithic builds should produce full callstacks in the log (and load all debug symbols)


className: FGenericPlatformStackWalk

description: Generic implementation for most platforms

code: struct FGenericPlatformStackWalk


code: static int32 Stricmp ( const ANSICHAR * String1, const ANSICHAR * String2 )


code: static int32 Stricmp ( const WIDECHAR * String1, const ANSICHAR * String2 )


code: static int32 Stricmp ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String1, const ANSICHAR * String2 )


code: static int32 Stricmp ( const UTF16CHAR * String1, const ANSICHAR * String2 )


code: static int32 Stricmp ( const UTF32CHAR * String1, const ANSICHAR * String2 )


code: static int32 Stricmp ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String1, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String2 )


code: static int32 Stricmp ( const WIDECHAR * String1, const WIDECHAR * String2 )


code: static int32 Stricmp ( const UTF16CHAR * String1, const UTF16CHAR * String2 )


code: static int32 Stricmp ( const UTF32CHAR * String1, const UTF32CHAR * String2 )


code: static int32 Stricmp ( const ANSICHAR * String1, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String2 )


code: static int32 Stricmp ( const ANSICHAR * String1, const WIDECHAR * String2 )


code: static int32 Stricmp ( const ANSICHAR * String1, const UTF16CHAR * String2 )


code: static int32 Stricmp ( const ANSICHAR * String1, const UTF32CHAR * String2 )


code: static int32 Strnicmp ( const ANSICHAR * String1, const ANSICHAR * String2, SIZE_T Count )


code: static int32 Strnicmp ( const WIDECHAR * String1, const ANSICHAR * String2, SIZE_T Count )


code: static int32 Strnicmp ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String1, const ANSICHAR * String2, SIZE_T Count )


code: static int32 Strnicmp ( const UTF16CHAR * String1, const ANSICHAR * String2, SIZE_T Count )


code: static int32 Strnicmp ( const UTF32CHAR * String1, const ANSICHAR * String2, SIZE_T Count )


code: static int32 Strnicmp ( const WIDECHAR * String1, const WIDECHAR * String2, SIZE_T Count )


code: static int32 Strnicmp ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String1, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String2, SIZE_T Count )


code: static int32 Strnicmp ( const UTF16CHAR * String1, const UTF16CHAR * String2, SIZE_T Count )


code: static int32 Strnicmp ( const UTF32CHAR * String1, const UTF32CHAR * String2, SIZE_T Count )


code: static int32 Strnicmp ( const ANSICHAR * String1, const WIDECHAR * String2, SIZE_T Count )


code: static int32 Strnicmp ( const ANSICHAR * String1, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String2, SIZE_T Count )


code: static int32 Strnicmp ( const ANSICHAR * String1, const UTF16CHAR * String2, SIZE_T Count )


code: static int32 Strnicmp ( const ANSICHAR * String1, const UTF32CHAR * String2, SIZE_T Count )


className: FGenericPlatformStricmp

description: Only considers ASCII character casing, i.e. C locale semantics

code: struct FGenericPlatformStricmp


description:
Tests whether a particular codepoint can be converted to the destination encoding.
True if Ch can be encoded as a DestEncoding.

code: template<typename DestEncoding, typename SourceEncoding> static constexpr bool CanConvertCodepoint ( SourceEncoding Codepoint )


description:
We'll say the encodings are compatible if they're both fixed-width and have the same size. This should be good enough and catches things like UCS2CHAR and WIDECHAR being equivalent. Specializations of this template can be provided for any other special cases. Same size is a minimum requirement.Converts the null-terminated Src string range from SourceEncoding to DestEncoding and writes it to the [Dest, Dest+DestSize) range, including a null terminator. If the Dest range is not big enough to hold the converted output, NULL is returned. In this case, nothing should be assumed about the contents of Dest.
A pointer to one past the last-written element.

code: template<typename SourceEncoding, typename DestEncoding> static DestEncoding * Convert ( DestEncoding * Dest, int32 DestSize, const SourceEncoding * Src )


description:
Converts the [Src, Src+SrcSize) string range from SourceEncoding to DestEncoding and writes it to the [Dest, Dest+DestSize) range. The Src range should contain a null terminator if a null terminator is required in the output. If the Dest range is not big enough to hold the converted output, NULL is returned. In this case, nothing should be assumed about the contents of Dest.
A pointer to one past the last-written element.

code: template<typename SourceEncoding, typename DestEncoding> static DestEncoding * Convert ( DestEncoding * Dest, int32 DestSize, const SourceEncoding * Src, int32 SrcSize )


description:
Returns the required buffer length for the null-terminated Src string when converted to the DestChar encoding. The returned length includes the space for the null terminator (equivalent to strlen+1).
The number of DestChar elements that Src will be converted into.

code: template<typename DestEncoding, typename SourceEncoding> static int32 ConvertedLength ( const SourceEncoding * Src )


description:
Returns the required buffer length for the [Src, Src+SrcSize) string when converted to the DestChar encoding. The Src range should contain a null terminator if a null terminator is required in the output.
The number of DestChar elements that Src will be converted into.

code: template<typename DestEncoding, typename SourceEncoding> static int32 ConvertedLength ( const SourceEncoding * Src, int32 SrcSize )


code: static const ANSICHAR * GetEncodingName()


description:
Returns the string representing the name of the given encoding type.
The name of the CharType as a TCHAR string.

code: template<typename Encoding> static const TCHAR * GetEncodingTypeName()


code: template<> const TCHAR * GetEncodingTypeName()


description: Unlike TAreEncodingsCompatible, this is not commutative. For example, ANSI is compatible with UTF-8, but UTF-8 is not compatible with ANSI.

code: template<typename SrcEncoding, typename DestEncoding> static constexpr bool IsCharEncodingCompatibleWith()


description: Tests whether you can simply (i.e. by assignment) encode code units from the source encoding as the destination encoding.

code: template<typename SourceEncoding, typename DestEncoding> static constexpr bool IsCharEncodingSimplyConvertibleTo()


description: Tests whether an encoding has fixed-width characters

code: template<typename Encoding> static constexpr bool IsFixedWidthEncoding()


className: IsUnicodeEncoded

description: True if the encoding type of the string is some form of unicode

code: static constexpr bool IsUnicodeEncoded = true;


code: static int32 Strncmp ( const ANSICHAR * String1, const ANSICHAR * String2, SIZE_T Count )


code: static int32 Strncmp ( const WIDECHAR * String1, const ANSICHAR * String2, SIZE_T Count )


code: static int32 Strncmp ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String1, const ANSICHAR * String2, SIZE_T Count )


code: static int32 Strncmp ( const ANSICHAR * String1, const WIDECHAR * String2, SIZE_T Count )


code: static int32 Strncmp ( const WIDECHAR * String1, const WIDECHAR * String2, SIZE_T Count )


code: static int32 Strncmp ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String1, const WIDECHAR * String2, SIZE_T Count )


code: static int32 Strncmp ( const ANSICHAR * String1, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String2, SIZE_T Count )


code: static int32 Strncmp ( const WIDECHAR * String1, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String2, SIZE_T Count )


code: static int32 Strncmp ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String1, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String2, SIZE_T Count )


className: FGenericPlatformString

description: Generic string implementation for most platforms

code: struct FGenericPlatformString : public [FGenericPlatformStricmp](API\Runtime\Core\GenericPlatform\FGenericPlatformStricmp)


className: FGenericPlatformSymbolDatabase

description: Container for debug symbols corresponding to a single binary file

code: struct FGenericPlatformSymbolDatabase

Symbols

type: TArray<FGeneri...


className: FGenericPlatformSymbolData

description: Debug symbol information

code: struct FGenericPlatformSymbolData


className: bAllowDuplicateKeys

code: enum { bAllowDuplicateKeys = 0 }


description: Calculates a hash index for a key.

code: static uint32 GetKeyHash ( [KeyInitType](API\Runtime\Core\GenericPlatform\FGenericPlatformSymbolDatabaseKe-\KeyInitType) Key )


description: The key used to index the given element.

code: static [KeyInitType](API\Runtime\Core\GenericPlatform\FGenericPlatformSymbolDatabaseKe-\KeyInitType) GetSetKey ( [ElementInitType](API\Runtime\Core\GenericPlatform\FGenericPlatformSymbolDatabaseKe-\ElementInitType) Element )


className: KeyInitType

code: typedef [TCallTraits](API\Runtime\Core\GenericPlatform\TCallTraits)< [FString](API\Runtime\Core\Containers\FString) >::ParamType KeyInitType


className: FGenericPlatformSymbolDatabaseKeyFuncs


description: True if the keys match.

code: static bool Matches ( [KeyInitType](API\Runtime\Core\GenericPlatform\FGenericPlatformSymbolDatabaseKe-\KeyInitType) A, [KeyInitType](API\Runtime\Core\GenericPlatform\FGenericPlatformSymbolDatabaseKe-\KeyInitType) B )


code: static bool LoadSymbolDatabaseForBinary ( [FString](API\Runtime\Core\Containers\FString) SourceFolder, [FString](API\Runtime\Core\Containers\FString) BinaryPath, [FString](API\Runtime\Core\Containers\FString) BinarySignature, [TOptional](API\Runtime\Core\IO\TOptional)< [FString](API\Runtime\Core\Containers\FString) > Architecture, [FGenericPlatformSymbolDatabase](API\Runtime\Core\GenericPlatform\FGenericPlatformSymbolDatabase) & OutDatabase )


code: static bool SaveSymbolDatabaseForBinary ( [FString](API\Runtime\Core\Containers\FString) TargetFolder, [FString](API\Runtime\Core\Containers\FString) Name, [FGenericPlatformSymbolDatabase](API\Runtime\Core\GenericPlatform\FGenericPlatformSymbolDatabase) & Database )


code: static bool SymbolInfoForAddress ( uint64 ProgramCounter, [FProgramCounterSymbolInfo](API\Runtime\Core\GenericPlatform\FProgramCounterSymbolInfo) & Info )


code: static bool SymbolInfoForStrippedSymbol ( [FGenericPlatformSymbolDatabase](API\Runtime\Core\GenericPlatform\FGenericPlatformSymbolDatabase) const & Database, uint64 ProgramCounter, uint64 ModuleOffset, [FString](API\Runtime\Core\Containers\FString) ModuleSignature, [FProgramCounterSymbolInfo](API\Runtime\Core\GenericPlatform\FProgramCounterSymbolInfo) & Info )


className: FGenericPlatformSymbolication

code: struct FGenericPlatformSymbolication


className: FGenericPlatformSymbolInfo

description: File & line info for a debug symbol region

code: struct FGenericPlatformSymbolInfo


description: Registers automatic updates of Game Thread CPU utilization

code: static void AutoUpdateGameThreadCPUTime ( double UpdateInterval )


description: structure that contains CPU utilization data.


description: the cpu processing time (kernel + user time of all threads) from the last update


description:
Gets the per-thread CPU processing time (kernel + user) from the last update
The per-thread CPU processing time from the last update


description: seconds per cycle.

code: static double GetSecondsPerCycle()


description: seconds per cycle.

code: static double GetSecondsPerCycle64()


description:
Gets current threads CPU Utilization
Current threads CPU Utilization


description:
Does per platform initialization of timing information and returns the current time. This function is called before the execution of main as GStartTime is statically initialized by it. The function also internally sets SecondsPerCycle, which is safe to do as static initialization order enforces complex initialization after the initial 0 initialization of the value.
current time

code: static double InitTiming()


className: LastIntervalCPUTimeInSeconds

code: static double LastIntervalCPUTimeInSeconds = 0.0;


description:
Returns a pretty-string for a time given in seconds. (I.e. "4:31 min", "2:16:30 hours", etc)
Time in a pretty formatted string

code: static [FString](API\Runtime\Core\Containers\FString) PrettyTime ( double Seconds )


code: static double SecondsPerCycle64 = 0.0;


className: SecondsPerCycle

code: static double SecondsPerCycle = 0.0;


description:
Get the system date
Date string

code: static TCHAR * StrDate ( TCHAR * Dest, SIZE_T DestSize )


description:
Get the system time
Time string

code: static TCHAR * StrTime ( TCHAR * Dest, SIZE_T DestSize )


description:
Returns a timestamp string built from the current date and time. NOTE: Only one return value is valid at a time!
timestamp string

code: static const TCHAR * StrTimestamp()


description: Returns the system time.

code: static void SystemTime ( int32 & Year, int32 & Month, int32 & DayOfWeek, int32 & Day, int32 & Hour, int32 & Min, int32 & Sec, int32 & MSec )


description: Converts cycles to milliseconds.

code: static float ToMilliseconds ( const uint32 Cycles )


description: Converts cycles to seconds.

code: static float ToSeconds ( const uint32 Cycles )


description: Converts cycles to milliseconds.

code: static double ToMilliseconds64 ( const uint64 Cycles )


description: Converts cycles to seconds.

code: static double ToSeconds64 ( const uint64 Cycles )


description: Updates CPU utilization, called through a delegate from the Core ticker.

code: static bool UpdateCPUTime ( float DeltaTime )


description: Updates current thread CPU utilization, calling is user defined per-thread (unused float parameter, is for FTicker compatibility).

code: static bool UpdateThreadCPUTime ( float )


description: Returns the UTC time.

code: static void UtcTime ( int32 & Year, int32 & Month, int32 & DayOfWeek, int32 & Day, int32 & Hour, int32 & Min, int32 & Sec, int32 & MSec )


className: FGenericPlatformTime

description: Generic implementation for most platforms

code: struct FGenericPlatformTime


className: InvalidTlsSlot

code: static const uint32 InvalidTlsSlot = 0xFFFFFFFF;


className: FGenericPlatformTLS

description: It should be possible to provide a generic implementation as long as a threadID is provided. We don't do that yet.

code: struct FGenericPlatformTLS


className: ANSICHAR

description: An ANSI character. 8-bit fixed-width representation of 7-bit characters.

code: typedef char ANSICHAR


description:
Return false if this is an invalid TLS slot
true if this looks like a valid slot

code: static bool IsValidTlsSlot ( uint32 SlotIndex )


description: A 16-bit character type. In-memory only. 16-bit representation. Should really be char16_t but making this the generic option is easier for compilers which don't fully support C++11 yet (i.e. MSVC).


description: A 32-bit character type. In-memory only. 32-bit representation. Should really be char32_t but making this the generic option is easier for compilers which don't fully support C++11 yet (i.e. MSVC).


description: 16-bit signed integer

code: typedef signed short int int16


description: 32-bit signed integer

code: typedef signed int int32


description: 64-bit signed integer

code: typedef signed long long int64


description: 8-bit signed integer

code: typedef signed char int8


className: PTRINT

description: Signed int. The same size as a pointer.


description: Unsigned int. The same size as a pointer.


className: TCHAR

description: A switchable character. In-memory only. Either ANSICHAR or WIDECHAR, depending on a licensee's requirements.


description: 16-bit unsigned integer

code: typedef unsigned short int uint16


description: 32-bit unsigned integer

code: typedef unsigned int uint32


description: 8-bit unsigned integer

code: typedef unsigned char uint8


description: 64-bit unsigned integer

code: typedef unsigned long long uint64


className: UPTRINT


description: An 8-bit character type. In-memory only. 8-bit representation. Should really be char8_t but making this the generic option is easier for compilers which don't fully support C++20 yet.

code: enum UTF8CHAR { }


description: Signed int. The same size as a pointer.


className: FGenericPlatformTypes

description: Generic types for almost all compilers and platforms

code: struct FGenericPlatformTypes

type: decltype(nullpt...


className: WIDECHAR

description: A wide character. In-memory only. ?-bit fixed-width representation of the platform's natural wide character set. Could be different sizes on different platforms.

code: typedef wchar_t WIDECHAR


description: Free

code: virtual void Free ( void * Original )


description:
Gets descriptive name for logging purposes.
pointer to human-readable malloc name

code: virtual const TCHAR * GetDescriptiveName()


description: Creates a new instance.

code: static [FGenericStackBasedMallocCrash](API\Runtime\Core\GenericPlatform\FGenericStackBasedMallocCrash) & Get ( [FMalloc](API\Runtime\Core\HAL\FMalloc) * MainMalloc )


description: Malloc

code: virtual void * Malloc ( SIZE_T Count, uint32 Alignment )


code: enum { MEMORYPOOL_SIZE = 256 * 1024 }


description: Realloc

code: virtual void * Realloc ( void * Original, SIZE_T Count, uint32 Alignment )


code: FGenericStackBasedMallocCrash ( [FMalloc](API\Runtime\Core\HAL\FMalloc) * MainMalloc )


className: FGenericStackBasedMallocCrash

code: struct FGenericStackBasedMallocCrash : public [FMalloc](API\Runtime\Core\HAL\FMalloc)


code: static double Atod ( const WIDECHAR * String )


code: static double Atod ( const ANSICHAR * String )


code: static double Atod ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String )


code: static float Atof ( const WIDECHAR * String )


code: static float Atof ( const ANSICHAR * String )


code: static float Atof ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String )


code: static int32 Atoi ( const WIDECHAR * String )


code: static int32 Atoi ( const ANSICHAR * String )


code: static int64 Atoi64 ( const WIDECHAR * String )


code: static int64 Atoi64 ( const ANSICHAR * String )


code: static int64 Atoi64 ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String )


code: static int32 Atoi ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String )


code: static int32 GetVarArgs ( WIDECHAR * Dest, SIZE_T DestSize, const WIDECHAR *& Fmt, va_list ArgPtr )


code: static int32 GetVarArgs ( ANSICHAR * Dest, SIZE_T DestSize, const ANSICHAR *& Fmt, va_list ArgPtr )


code: static int32 GetVarArgs ( [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Dest, SIZE_T DestSize, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) *& Fmt, va_list ArgPtr )


code: static WIDECHAR * Strcat ( WIDECHAR * Dest, SIZE_T DestCount, const WIDECHAR * Src )


code: static ANSICHAR * Strcat ( ANSICHAR * Dest, SIZE_T DestCount, const ANSICHAR * Src )


code: static [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Strcat ( [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Dest, SIZE_T DestCount, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Src )


code: static const WIDECHAR * Strchr ( const WIDECHAR * String, WIDECHAR C )


code: static const ANSICHAR * Strchr ( const ANSICHAR * String, ANSICHAR C )


code: static const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Strchr ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String, [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) C )


code: static int32 Strcmp ( const WIDECHAR * String1, const WIDECHAR * String2 )


code: static int32 Strcmp ( const ANSICHAR * String1, const ANSICHAR * String2 )


code: static int32 Strcmp ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String1, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String2 )


description: Unicode implementation

code: static WIDECHAR * Strcpy ( WIDECHAR * Dest, SIZE_T DestCount, const WIDECHAR * Src )


description: Ansi implementation

code: static ANSICHAR * Strcpy ( ANSICHAR * Dest, SIZE_T DestCount, const ANSICHAR * Src )


description: UTF8CHAR implementation.

code: static [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Strcpy ( [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Dest, SIZE_T DestCount, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Src )


code: static int32 Strlen ( const WIDECHAR * String )


code: static int32 Strlen ( const ANSICHAR * String )


code: static int32 Strlen ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String )


description: UCS2 implementation

code: static int32 Strlen ( const UCS2CHAR * String )


code: static int32 Strncmp ( const ANSICHAR * String1, const ANSICHAR * String2, SIZE_T Count )


code: static int32 Strncmp ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String1, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String2, SIZE_T Count )


code: static WIDECHAR * Strncpy ( WIDECHAR * Dest, const WIDECHAR * Src, SIZE_T MaxLen )


code: static ANSICHAR * Strncpy ( ANSICHAR * Dest, const ANSICHAR * Src, SIZE_T MaxLen )


code: static [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Strncpy ( [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Dest, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Src, SIZE_T MaxLen )


code: static int32 Strnlen ( const WIDECHAR * String, SIZE_T StringSize )


code: static int32 Strnlen ( const ANSICHAR * String, SIZE_T StringSize )


code: static int32 Strnlen ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String, SIZE_T StringSize )


code: static int32 Strnlen ( const UCS2CHAR * String, SIZE_T StringSize )


code: static const WIDECHAR * Strrchr ( const WIDECHAR * String, WIDECHAR C )


code: static const ANSICHAR * Strrchr ( const ANSICHAR * String, ANSICHAR C )


code: static const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Strrchr ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String, [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) C )


code: static const WIDECHAR * Strstr ( const WIDECHAR * String, const WIDECHAR * Find )


code: static const ANSICHAR * Strstr ( const ANSICHAR * String, const ANSICHAR * Find )


code: static const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Strstr ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Find )


code: static int32 Strtoi ( const WIDECHAR * Start, WIDECHAR ** End, int32 Base )


code: static int32 Strtoi ( const ANSICHAR * Start, ANSICHAR ** End, int32 Base )


code: static int32 Strtoi ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Start, [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) ** End, int32 Base )


code: static int64 Strtoi64 ( const ANSICHAR * Start, ANSICHAR ** End, int32 Base )


code: static int64 Strtoi64 ( const WIDECHAR * Start, WIDECHAR ** End, int32 Base )


code: static int64 Strtoi64 ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Start, [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) ** End, int32 Base )


code: static WIDECHAR * Strtok ( WIDECHAR * StrToken, const WIDECHAR * Delim, WIDECHAR ** Context )


code: static ANSICHAR * Strtok ( ANSICHAR * StrToken, const ANSICHAR * Delim, ANSICHAR ** Context )


code: static [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Strtok ( [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * StrToken, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Delim, [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) ** Context )


code: static uint64 Strtoui64 ( const WIDECHAR * Start, WIDECHAR ** End, int32 Base )


code: static uint64 Strtoui64 ( const ANSICHAR * Start, ANSICHAR ** End, int32 Base )


code: static uint64 Strtoui64 ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Start, [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) ** End, int32 Base )


code: template<typename CharType> static CharType * Strupr ( CharType * Dest, SIZE_T DestCount )


className: FGenericWidePlatformString

description: Standard implementation

code: struct FGenericWidePlatformString : public [FGenericPlatformString](API\Runtime\Core\GenericPlatform\FGenericPlatformString)


description: Get VendorId

code: bool IsAMD() const


description: Get VendorId

code: bool IsIntel() const


description: Get VendorId

code: bool IsNVIDIA() const


code: bool IsSameDriverVersionGeneration ( const TCHAR * InOpWithMultiInt ) const


description: Set VendorId

code: void SetAMD()


description: Set VendorId

code: void SetIntel()


code: static [FString](API\Runtime\Core\Containers\FString) TrimNVIDIAInternalVersion ( const [FString](API\Runtime\Core\Containers\FString) & InternalVersion )


description: Set VendorId

code: void SetNVIDIA()


className: FGPUDriverInfo

description: Video driver details

code: struct FGPUDriverInfo

DeviceDescription

description: E.g. "NVIDIA GeForce GTX 680" or "AMD Radeon R9 200 / HD 7900 Series"

DriverDate

description: E.g. 3-13-2015

InternalDriverVersion

description: E.g.

ProviderName

description: E.g. "NVIDIA" or "Advanced Micro Devices, Inc."

RHIName

description: E.g. D3D11, D3D12

UserDriverVersion

description: E.g.

VendorId

description: DirectX VendorId, 0 if not set, use functions below to set/get.


description: a driver version intended to be shown to the user e.g. "15.30.1025.1001 12/17/2015 (Crimson Edition 15.12)"

code: [FString](API\Runtime\Core\Containers\FString) GetSuggestedDriverVersion ( const [FString](API\Runtime\Core\Containers\FString) & InRHIName ) const


description: 0 if there is none


description:
To get a section name in the Hardware.ini file
0 if not found


description: Returns true if the latest version of the driver is on the deny list.

code: bool IsLatestDenied() const


description: Constructor

code: FGPUHardware ( const [FGPUDriverInfo](API\Runtime\Core\GenericPlatform\FGPUDriverInfo) InDriverInfo )


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

code: struct FInt128

High

description: The high part of the 128-bit integer.

Low

description: The low part of the 128-bit integer.


className: FGPUHardware

code: struct FGPUHardware

DriverInfo

type: constFGPUDrive...

description: Const as this is set in the constructor to be conveniently available


code: static double Atod ( const WIDECHAR * String )


code: static double Atod ( const ANSICHAR * String )


code: static double Atod ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String )


code: static float Atof ( const WIDECHAR * String )


code: static float Atof ( const ANSICHAR * String )


code: static float Atof ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String )


code: static int32 Atoi ( const WIDECHAR * String )


code: static int32 Atoi ( const ANSICHAR * String )


code: static int32 Atoi ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String )


code: static int64 Atoi64 ( const WIDECHAR * String )


code: static int64 Atoi64 ( const ANSICHAR * String )


code: static int64 Atoi64 ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String )


code: static int32 GetVarArgs ( ANSICHAR * Dest, SIZE_T DestSize, const ANSICHAR *& Fmt, va_list ArgPtr )


code: static int32 GetVarArgs ( [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Dest, SIZE_T DestSize, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) *& Fmt, va_list ArgPtr )


code: static WIDECHAR * Strcat ( WIDECHAR * Dest, SIZE_T DestCount, const WIDECHAR * Src )


code: static ANSICHAR * Strcat ( ANSICHAR * Dest, SIZE_T DestCount, const ANSICHAR * Src )