FGenericPlatformMisc

Generic implementation for most platforms

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/GenericPlatform

Inheritance Hierarchy

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/GenericPlatform/GenericPlatformMisc.h
Include #include "GenericPlatform/GenericPlatformMisc.h"

Syntax

struct FGenericPlatformMisc

Remarks

Generic implementation for most platforms

Functions

  Type Name Description
Public function Static void

AddAdditionalRootDirectory ( const FString& RootDir
)

 Add an additional root directory
Public function Static FDelegateHandle

AddNetworkListener ( FOnNetworkConnectionChangedDelegate&& InNewDelegate
)

  
Public function Static bool 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)
Public function Static bool  
Public function Static bool Checks if platform wants to allow the thread heartbeat hang detection
Public function Static void

BeginEnterBackgroundEvent ( const TCHAR* Text
)

 Profiler enter background events.
Public function Static void

BeginNamedEvent ( const FColor& Color,
const ANSICHAR* Text
)

 Platform specific function for adding a named event that can be viewed in external tool
Public function Static void

BeginNamedEvent ( const FColor& Color,
const TCHAR* Text
)

 Platform specific function for adding a named event that can be viewed in external tool
Public function Static void Indicates the start of a frame for named events
Public function Static void

BeginProfilerColor ( const FColor& Color
)

 Profiler color stack - this overrides the color for named events with undefined colors (e.g stat namedevents)
Public function Static void Function to store the current working directory for use with LaunchDir()
Public function Static bool

CheckPersistentDownloadStorageSpaceAvailable ( uint64 BytesRequired,
bool bAttemptToUseUI
)

 Ensure that there enough space in the persistent download dir.
Public function Static void

ChooseHDRDeviceAndColorGamut ( uint32 DeviceId,
uint32 DisplayNitLevel,
EDisplayOutputFormat& OutputDevice,
EDisplayColorGamut& ColorGamut
)

  
Public function Static FString Return the CloudDir. CloudDir can be per-user.
Public function Static bool Handles Game Explorer, Firewall and FirstInstall commands, typically from the installer
Public function Static void

CreateGuid ( FGuid& Result
)

 Create a new globally unique identifier.
Public function Static void

CustomNamedStat ( const TCHAR* Text,
float Value,
const TCHAR* Graph,
const TCHAR* Unit
)

 Platform specific function for adding a named custom stat that can be viewed in external tool
Public function Static void

CustomNamedStat ( const ANSICHAR* Text,
float Value,
const ANSICHAR* Graph,
const ANSICHAR* Unit
)

  
Public function Static bool

DeleteStoredSection ( const FString& InStoreId,
const FString& InSectionName
)

 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
Public function Static bool

DeleteStoredValue ( const FString& InStoreId,
const FString& InSectionName,
const FString& InKeyName
)

 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
Public function Static bool  
Public function Static void  
Public function Static void  
Public function Static void  
Public function Static void Platform specific function for closing a named event that can be viewed in external tool
Public function Static void  
Public function Static const TCHAR * Get the engine directory
Public function Static bool

Exec ( UWorld* InWorld,
const TCHAR* Cmd,
FOutputDevice& Out
)

 Platform-specific Exec function
Public function Static bool  
Public function Static bool

FileExistsInPlatformPackage ( const FString& RelativePath
)

  
Public function Static bool  
Public function Static const TCHAR * Return the GamePersistentDownloadDir.
Public function Static const TCHAR * Return the temporary directory
Public function Static const TCHAR *  
Public function Static TArray< FString > Get additional directories which can be considered as root directories
Public function Static EDeviceScreenOrientation Returns the allowed orientation of the device.
Public function Static int Gets the current battery level.
Public function Static bool

GetBlockingIOStats ( FProcessIOStats& OutStats,
EInputOutputFlags Flags
)

 Gets Blocking Input/Output stats covering the lifetime of the process
Public function Static float  
Public function Static int32

GetChunkIDFromPakchunkIndex ( int32 PakchunkIndex
)

  
Protected function Static void

GetConfiguredCoreLimits ( int32 PlatformNumPhysicalCores,
int32 PlatformNumLogicalCores,
bool& bOutFullyInitialized,
int32& OutPhysicalCoreLimit,
int32& OutLogicalCoreLimit,
bool& bOutSetPhysicalCountToLogicalCount
)

 Parse CoreLimit from CommandLine or from the SetCoreLimit value.
Public function Static bool

GetContextSwitchStats ( FContextSwitchStats& OutStats,
EContextSwitchFlags Flags
)

 Gets Context Switch stats covering the lifetime of the process
Public function Static EConvertibleLaptopMode Gets the current mode of convertible laptops, i.e. Laptop or Tablet.
Public function Static FString Uses cpuid instruction to get the CPU brand string
Public function Static FString Returns the CPU chipset if known
Public function Static uint32 On x86(-64) platforms, uses cpuid instruction to get the CPU signature
Public function Static FString Uses cpuid instruction to get the vendor string
Public function Static ECrashHandlingType Gets the current crash handling type.
Public function Static const TCHAR * Gets the default profile name. Used if there is no device profile specified
Public function Static FString Get the default language (for localization) used by this platform.
Public function Static FString Get the default locale (for internationalization) used by this platform.
Public function Static const TCHAR *  
Public function Static FString Returns a unique string for device identification.
Public function Static FString  
Public function Static EDeviceScreenOrientation Returns the current orientation of the device: will be either Portrait, LandscapeLeft, PortraitUpsideDown or LandscapeRight.
Public function Static float Returns the current device temperature level.
Public function Static int32 Returns the device volume if the device is capable of returning that information.
Public function Static bool

GetDiskTotalAndFreeSpace ( const FString& InPath,
uint64& TotalNumberOfBytes,
uint64& NumberOfFreeBytes
)

 Retrieves information about the total number of bytes and number of free bytes for the specified disk path.
Public function Static bool Return the engine and project directory based from the executable.
Public function Static const TCHAR * Get a string description of the mode the engine was running in.
Public function Static FString

GetEnvironmentVariable ( const TCHAR* VariableName
)

 Retrieve a environment variable from the system
Public function Static FString Get the Epic account ID for the user who last used the Launcher.
Public function Static FText  
Public function Static FGPUDriverInfo

GetGPUDriverInfo ( const FString& DeviceDescription
)

  
Public function Static uint32  
Public function Static FString Returns the currency code associated with the device's locale
Public function Static FString Returns the currency symbol associated with the device's locale
Public function Static FString Returns a unique string associated with the login account of the current machine.
Public function Static int32 Returns the maximum length of a path
Public function Static int32 Retrieves the current maximum refresh rate supported by the platform
Public function Static int32 Retrieves the maximum refresh rate supported by the platform
Public function Static int32 Returns the platform's maximum allowed value for rhi.SyncInterval
Public function Static int For mobile devices, this function will return true if we wish to propagate the alpha to the backbuffer
Public function Static ENetworkConnectionStatus Returns the current status for the network connection
Public function Static ENetworkConnectionType Returns whether WiFi connection is currently active
Public function Static void

GetNetworkFileCustomData ( TMap< FString, FString >& OutCustomPlatformData
)

 Returns any platform-specific key-value data that needs to be sent to the network file server
Public function Static const TCHAR * Determines the shader format for the platform
Public function Static FString Gets a globally unique ID the represents a particular operating system install.
Public function Static FString Gets a string representing the numeric OS version (as opposed to a translated OS version that GetOSVersions returns).
Public function Static void

GetOSVersions ( FString& out_OSVersionLabel,
FString& out_OSSubVersionLabel
)

 Gets the OS Version and OS Subversion.
Public function Static bool

GetPageFaultStats ( FPageFaultStats& OutStats,
EPageFaultFlags Flags
)

 Gets Page Fault stats covering the lifetime of the process
Public function Static int32

GetPakchunkIndexFromPakFile ( const FString& InFilename
)

  
Public function Static const TCHAR * Return the delimiter between paths in the PATH environment variable.
Public function Static IPlatformChunkInstall * Returns the platform specific chunk based install interface
Public function Static IPlatformCompression * Returns the platform specific compression interface
Public function Static const TCHAR * Return the name of the platform features module.
Public function Static IPlatformHostCommunication & Returns the platform specific interface for communication with processes running on the host pc.
Public function Static bool

GetPlatformScreenWarnings ( TArray< FText >& PlatformScreenWarnings
)

 Returns any platform specific warning messages we want printed on screen
Public function Static FAsyncIOSystemBase * Return the platform specific async IO system, or nullptr if the standard one should be used.
Public function Static FPlatformUserId

GetPlatformUserForUserIndex ( int32 LocalUserIndex
)

 Converts from a local user index to a FPlatformUserId
Public function Static TArray< FString > Returns an array of the user's preferred languages in order of preference
Public function Static FString  
Public function Static EProcessDiagnosticFlags Returns non-zero if a performance-sensitive diagnostic, like a memory sanitizer, is detected for this process
Public function Static const FProcessorGroupDesc &  
Public function Static bool

GetSHA256Signature ( const void* Data,
uint32 ByteSize,
FSHA256Signature& OutSignature
)

 Generates the SHA256 signature of the given data.
Public function Static bool

GetStoredValue ( const FString& InStoreId,
const FString& InSectionName,
const FString& InKeyName,
FString& OutValue
)

 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
Public function Static const TCHAR *

GetSystemErrorMessage ( TCHAR* OutBuffer,
int32 BufferCount,
int32 Error
)

 Returns the last system error code in string form.
Public function Static TArray< uint8 >  
Public function Static FString Get the timezone identifier for this platform, or an empty string if the default timezone calculation will work.
Public function Static const TCHAR *  
Public function Static const TCHAR *  
Public function Static const TCHAR *  
Public function Static FString Returns a unique string for advertising identification
Public function Static int32 Converts from a FPlatformUserId to local user index
Public function Static bool Returns whether the platform wants to use a touch screen for virtual joysticks.
Public function Static void

GetValidTargetPlatforms ( TArray< FString >& TargetPlatformNames
)

 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)
Public function Static bool Returns whether the volume buttons are handled by the system
Public function Static bool Returns whether WiFi connection is currently active
Public function Static bool Determines if a warning handler has been set
Public function Static bool  
Public function Static bool

HasPlatformFeature ( const TCHAR* FeatureName
)

 Returns whether the given platform feature is currently available (for instance, Metal is only available in IOS8 and with A7 devices)
Public function Static bool Return true if the PersistentDownloadDir is available.
Public function Static bool Whether the platform has a separate debug channel to stdout (eg. OutputDebugString on Windows).
Public function Static bool Returns whether the platform has variable hardware (configurable/upgradeable system).
Public function Static void  
Public function Static void

InitTaggedStorage ( uint32 NumTags
)

 Platform specific function for initializing storage of tagged memory buffers
Public function Static bool Detects whether we're running in a 64-bit operating system.
Public function Static bool For platforms that support cache storage functionality, setting a directory for it when it's not available can result in errors.
Public function Static bool Return true if a debugger is present
Public function Static bool Allows disabling ensure()s without rebuilding the binary, by either a commandline switch or a hotfix.
Public function Static bool  
Public function Static bool Whether LocalPrint can be called from any thread without overlapping
Public function Static bool Whether LowLevelOutputDebugString[f] can receive structured output as lines of JSON.
Public function Static bool  
Public function Static bool Returns true if PGI (profile-guided instrumentation, needed for PGO) is currently ongoing.
Public function Static bool 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
Public function Static bool Returns true if PGO is currently enabled
Public function Static bool Returns whether or not the device has been registered to receive remote notifications.
Public function Static bool Check to see if the platform is being viewed remotely.
Public function Static bool Return if the game is running on cloud server
Public function Static bool Returns whether the platform is running on battery power or not.
Public function Static bool Checks structure of the path against platform formatting requirements
Public function Static const TCHAR * Get the directory the application was launched from (useful for commandline utilities)
Public function Static FString

LoadTextFileFromPlatformPackage ( const FString& RelativePath
)

 Loads a text file relative to the package root on platforms that distribute apps in package formats.
Public function Static void

LocalPrint ( const TCHAR* Str
)

 Prints string to the default output
Public function Static void  
Public function Static void

LowLevelOutputDebugString ( const TCHAR* Message
)

 Sends a message to a remote tool, and debugger consoles
Public function Static void

LowLevelOutputDebugStringf ( const TCHAR* Format,
...
)

 Sends a message to a remote tool, and debugger consoles
Public function Static void Enforces strict memory load/store ordering across the memory barrier call.
Public function Static EAppReturnType::Type

MessageBoxExt ( EAppMsgType::Type MsgType,
const TCHAR* Text,
const TCHAR* Caption
)

 Show a message box if possible, otherwise print a message and return the default
Public function Static bool  
Public function Static void

NormalizePath ( FString& InPath
)

 Platform-specific normalization of path E.g.
Public function Static void

NormalizePath ( FStringBuilderBase& InPath
)

 Platform-specific normalization of path E.g.
Public function Static int32 Return the number of hardware CPU cores
Public function Static int32 Return the number of logical CPU cores
Public function Static int32 Return the number of worker threads we should spawn to service IO, NOT based on number of cores
Public function Static int32 Return the number of worker threads we should spawn, based on number of cores
Public function Static bool

OsExecute ( const TCHAR* CommandType,
const TCHAR* Command,
const TCHAR* CommandLine
)

 Has the OS execute a command and path pair (such as launch a browser)
Public function Static void

ParseChunkIdPakchunkIndexMapping ( TArray< FString > ChunkIndexRedirects,
TMap< int32, int32 >& OutMapping
)

  
Public function Static void

PlatformHandleSplashScreen ( bool ShowSplashScreen
)

 Called to dismiss splash screen
Public function Static void  
Public function Static void Called during appInit() after cmd line setup
Public function Static void Called during AppExit(). Log, Config still exist at this point, but not much else does.
Public function Static void

Prefetch ( const void* Ptr,
int32 Offset
)

  
Public function Static void

Prefetch ( const void* Ptr
)

  
Public function Static void

PrefetchBlock ( const void* Ptr,
int32 NumBytes
)

  
Public function Static void

PrepareMobileHaptics ( EMobileHapticsType Type
)

 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
Public function Static const TCHAR * Return the project directory
Public function Static void

PromptForRemoteDebugging ( bool bIsEnsure
)

  
Public function Static void Pumps app messages only if there are essential keep-alive messages pending.
Public function Static void  
Public function Static void  
Public function Static void

RaiseException ( uint32 ExceptionCode
)

  
Public function Static void Requests permission to send remote notifications to the user's device.
Public function Static void For mobile devices, this will shutdown the haptics, allowing system to put it to reset as needed
Public function Static bool  
Public function Static bool

RequestDeviceCheckToken ( TFunction< void(const TArray< uint8 >&)> QuerySucceededFunc,
TFunction< void(const FString&, const FString&)> QueryFailedFunc
)

  
Public function Static void

RequestExit ( bool Force,
const TCHAR* CallSite
)

 Requests application exit.
Public function Static void

RequestExitWithStatus ( bool Force,
uint8 ReturnCode,
const TCHAR* CallSite
)

 Requests application exit with a specified return code.
Public function Static bool Requests application to restart
Public function Static bool

RestartApplicationWithCmdLine ( const char* CmdLine
)

 Requests application to restart appending the passed in CmdLine to the restart
Public function Static const TCHAR *

RootDir ()

 Get the application root directory.
Public function Static void

SetAllowedDeviceOrientation ( EDeviceScreenOrientation NewAllowedDeviceOrientation
)

 Change the allowed orientation of the device.
Public function Static void

SetBrightness ( float bBright
)

  
Public function Static void

SetCrashHandler ( void(*)(const FGenericCrashContext&Context) CrashHandler
)

 Installs handler for the unexpected (due to error) termination of the program, including, but not limited to, crashes.
Public function Static ECrashHandlingType

SetCrashHandlingType ( ECrashHandlingType Type
)

 Sets the type of crash handling done by the engine.
Public function Static void

SetEnvironmentVar ( const TCHAR* VariableName,
const TCHAR* Value
)

 Sets an environment variable to the local process's environment
Public function Static void Set/restore the Console Interrupt (Control-C, Control-Break, Close) handler.
Public function Static void

SetLastError ( uint32 ErrorCode
)

  
Public function Static void Set a handler to be called when there is a memory warning from the OS
Public function Static void

SetNetworkConnectionStatus ( ENetworkConnectionStatus NewNetworkConnectionStatus
)

 Updates the current status for the network connection
Public function Static void

SetOverrideProjectDir ( const FString& InOverrideDir
)

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

SetShouldPromptForRemoteDebugging ( bool bInShouldPrompt
)

  
Public function Static void

SetShouldPromptForRemoteDebugOnEnsure ( bool bInShouldPrompt
)

  
Public function Static bool

SetStoredValue ( const FString& InStoreId,
const FString& InSectionName,
const FString& InKeyName,
const FString& InValue
)

 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
Public function Static bool

SetStoredValues ( const FString& InStoreId,
const FString& InSectionName,
const TMap< FString, FString >& InKeyValues
)

 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
Public function Static void

SetUBTTargetName ( const TCHAR* InTargetName
)

  
Public function Static bool Unix only function, but put a stub so we can call this for higher level code when we want to setup the Syscall Filters
Public function Static void Sets the default output to UTF8
Public function Static void Set whether the volume buttons are handled by the system
Public function Static void

ShareURL ( const FString& URL,
const FText& Description,
int32 LocationHintX,
int32 LocationHintY
)

 Perform a mobile-style sharing of a URL. Will use native UI to display sharing target
Public function Static bool

ShouldDisablePluginAtRuntime ( const FString& PluginName
)

 Allows platform at runtime to disable unsupported plugins
Public function Static bool  
Public function Static void  
Public function Static void Platform specific function for freeing storage of tagged memory buffers
Public function Static bool

StartNewPGOCollection ( const FString& AbsoluteFileName
)

 On platforms that support run-time PGI on/off, starts a new collection with a given file name.
Public function Static void

StatNamedEvent ( const CharType* Text
)

 Stats logging for named event
Public function Static bool On platforms that support run-time PGI on/off, stops the current collection and writes out the file (or completes its write).
Public function Static void

SubmitErrorReport ( const TCHAR* InErrorHist,
EErrorReportMode::Type InMode
)

 #CrashReport: 2015-02-24 Remove
Public function Static bool  
Public function Static bool  
Public function Static bool  
Public function Static bool  
Public function Static bool Platform can generate a full-memory crashdump during crash handling.
Public function Static bool  
Public function Static bool  
Public function Static bool  
Public function Static bool  
Public function Static void

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

 Platform specific function for tagging a memory buffer with a label.
Public function Static void Frees any memory retained by FGenericPlatformMisc.
Public function Static void Ticks values that can be hotfixable in the config.
Public function Static void Stats logging for named event
Public function Static void For mobile devices, this will kick the haptic type that was set in PrepareMobileHaptics.
Public function Static void Requests unregistering from receiving remote notifications on the user's device.
Public function Static void Updates hotfixable ensure settings from config and commandline (config takes priority).
Public function Static bool  
Public function Static bool Checks if platform wants to use a rendering thread on current device

Classes

  Type Name Description
Public struct FStaticData    

Constants

Name Description
AllowedDeviceOrientation  
bPromptForRemoteDebugOnEnsure Whether the user should be prompted to allow for a remote debugger to be attached on an ensure
bShouldPromptForRemoteDebugging Whether the user should be prompted to allow for a remote debugger to be attached
CurrentNetworkConnectionStatus  

Deprecated Functions

  Type Name Description
Public function Static void

ClipboardCopy ( const TCHAR* Str
)

 FPlatformMisc::ClipboardCopy() has been superseded by FPlatformApplicationMisc::ClipboardCopy()
Public function Static void FPlatformMisc::ClipboardPaste() has been superseded by FPlatformApplicationMisc::ClipboardPaste()
Public function Static void FPlatformMisc::DebugBreak is deprecated. Use the UE_DEBUG_BREAK() macro instead.
Public function Static TArray< FCustomChunk > Use IPlatformChunkInstall::GetNamedChunksByType instead
Public function Static TArray< FCustomChunk > Use IPlatformChunkInstall::GetNamedChunksByType instead
Public function Static TArray< FCustomChunk >

GetCustomChunksByType ( ECustomChunkType DesiredChunkType
)

 Use IPlatformChunkInstall::GetNamedChunksByType instead
Public function Static FString GetHasedMacAddressString is deprecated. It is not reliable on all platforms
Public function Static TArray< uint8 > GetMacAddress is deprecated. It is not reliable on all platforms
Public function Static FString GetMacAddressString is deprecated. It is not reliable on all platforms
Public function Static FGuid GetMachineId is deprecated. Use GetLoginId instead.
Public function Static TArray< FCustomChunk >

GetOnDemandChunksForPakchunkIndices ( const TArray< int32 >& PakchunkIndices
)

 Use named chunks instead
Public function Static void

PrefetchBlock ( const void* Ptr
)

 Must supply size when prefetching a block of data
Public function Static void

SetDeviceOrientation ( EDeviceScreenOrientation NewDeviceOrientation
)

 SetDeviceOrientation is deprecated. Use SetAllowedDeviceOrientation instead.
Public function Static void

SetOverrideGameDir ( const FString& InOverrideDir
)

 FPaths::SetOverrideGameDir() has been superseded by FPaths::SetOverrideProjectDir().

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page