| FGenericPlatformMisc
|
Module |
|
Header |
/Engine/Source/Runtime/Core/Public/GenericPlatform/GenericPlatformMisc.h |
Include |
#include "GenericPlatform/GenericPlatformMisc.h" |
struct FGenericPlatformMisc
Generic implementation for most platforms
Name | Description | ||
---|---|---|---|
|
AddAdditionalRootDirectory ( |
Add an additional root directory |
|
|
AllowAudioThread() |
Checks if platform wants to allow an audio thread on current device ( does not imply it will, only if okay given other criteria met) |
|
|
AllowLocalCaching() |
||
|
AllowThreadHeartBeat() |
Checks if platform wants to allow the thread heartbeat hang detection |
|
|
BeginNamedEvent |
Platform specific function for adding a named event that can be viewed in external tool |
|
|
BeginNamedEvent |
Platform specific function for adding a named event that can be viewed in external tool |
|
|
BeginNamedEventFrame() |
Indicates the start of a frame for named events |
|
|
BeginProfilerColor ( |
Profiler color stack - this overrides the color for named events with undefined colors (e.g stat namedevents) |
|
|
CacheLaunchDir() |
Function to store the current working directory for use with LaunchDir() |
|
|
ChooseHDRDeviceAndColorGamut |
||
|
CloudDir() |
Return the CloudDir. CloudDir can be per-user. |
|
|
CommandLineCommands() |
Handles Game Explorer, Firewall and FirstInstall commands, typically from the installer |
|
|
CreateGuid ( |
Create a new globally unique identifier. |
|
|
CustomNamedStat |
||
|
CustomNamedStat |
Platform specific function for adding a named custom stat that can be viewed in external tool |
|
|
DeleteStoredSection |
Deletes the given section and its contained values in the platform specific key->value store |
|
|
DeleteStoredValue |
Deletes value for the given section and key in the platform specific key->value store |
|
|
DesktopTouchScreen() |
||
|
EndNamedEvent() |
Platform specific function for closing a named event that can be viewed in external tool |
|
|
EndProfilerColor() |
||
|
const TCHAR ... |
EngineDir() |
Get the engine directory |
|
Exec ( |
Platform-specific Exec function |
|
|
Expand16BitIndicesTo32BitOnLoad() |
||
|
FileExistsInPlatformPackage ( |
||
|
FullscreenSameAsWindowedFullscreen() |
||
|
const TCHAR ... |
GamePersistentDownloadDir() |
Return the GamePersistentDownloadDir. |
|
const TCHAR ... |
GeneratedConfigDir() |
|
|
GetAdditionalRootDirectories() |
Get additional directories which can be considered as root directories |
|
|
GetAllLanguageChunks() |
||
|
GetAllOnDemandChunks() |
||
|
int |
GetBatteryLevel() |
Gets the current battery level. |
|
float |
GetBrightness() |
|
|
GetChunkIDFromPakchunkIndex ( |
||
|
EConvertible... |
GetConvertibleLaptopMode() |
Gets the current mode of convertible laptops, i.e. Laptop or Tablet. |
|
GetCPUBrand() |
Uses cpuid instruction to get the CPU brand string |
|
|
GetCPUChipset() |
Returns the CPU chipset if known |
|
|
GetCPUInfo() |
On x86(-64) platforms, uses cpuid instruction to get the CPU signature |
|
|
GetCPUVendor() |
Uses cpuid instruction to get the vendor string |
|
|
GetCustomChunksByType ( |
||
|
const TCHAR ... |
GetDefaultDeviceProfileName() |
Gets the default profile name. Used if there is no device profile specified |
|
GetDefaultLanguage() |
Get the default language (for localization) used by this platform. |
|
|
GetDefaultLocale() |
Get the default locale (for internationalization) used by this platform. |
|
|
const TCHAR ... |
GetDefaultPathSeparator() |
|
|
GetDeviceId() |
Returns a unique string for device identification. |
|
|
GetDeviceMakeAndModel() |
||
|
EDeviceScree... |
GetDeviceOrientation() |
Returns the orientation of the device: e.g. Portrait, LandscapeRight. |
|
float |
GetDeviceTemperatureLevel() |
Returns the current device temperature level. |
|
GetDeviceVolume() |
Returns the device volume if the device is capable of returning that information. |
|
|
GetDiskTotalAndFreeSpace |
Retrieves information about the total number of bytes and number of free bytes for the specified disk path. |
|
|
const TCHAR ... |
GetEngineMode() |
Get a string description of the mode the engine was running in. |
|
GetEnvironmentVariable ( |
Retrieve a environment variable from the system |
|
|
GetEpicAccountId() |
Get the Epic account ID for the user who last used the Launcher. |
|
|
GetFileManagerName() |
||
|
FGPUDriverIn... |
GetGPUDriverInfo ( |
|
|
GetLastError() |
||
|
GetLocalCurrencyCode() |
Returns the currency code associated with the device's locale |
|
|
GetLocalCurrencySymbol() |
Returns the currency symbol associated with the device's locale |
|
|
GetLoginId() |
Returns a unique string associated with the login account of the current machine. |
|
|
GetMaxPathLength() |
Returns the maximum length of a path |
|
|
GetMaxRefreshRate() |
Retrieves the maximum refresh rate supported by the platform |
|
|
GetMaxSyncInterval() |
Returns the platform's maximum allowed value for rhi.SyncInterval |
|
|
ENetworkConn... |
GetNetworkConnectionType() |
Returns whether WiFi connection is currently active |
|
GetNetworkFileCustomData |
Returns any platform-specific key-value data that needs to be sent to the network file server |
|
|
const TCHAR ... |
GetNullRHIShaderFormat() |
Determines the shader format for the platform |
|
GetOnDemandChunksForPakchunkIndices |
||
|
GetOperatingSystemId() |
Gets a globally unique ID the represents a particular operating system install. |
|
|
GetOSVersion() |
Gets a string representing the numeric OS version (as opposed to a translated OS version that GetOSVersions returns). |
|
|
GetOSVersions |
Gets the OS Version and OS Subversion. |
|
|
GetPakchunkIndexFromPakFile ( |
||
|
const TCHAR ... |
GetPathVarDelimiter() |
Return the delimiter between paths in the PATH environment variable. |
|
IPlatformChu... |
GetPlatformChunkInstall() |
Returns the platform specific chunk based install interface |
|
IPlatformCom... |
GetPlatformCompression() |
Returns the platform specific compression interface |
|
const TCHAR ... |
GetPlatformFeaturesModuleName() |
Return the name of the platform features module. |
|
GetPlatformScreenWarnings |
Returns any platform specific warning messages we want printed on screen |
|
|
FAsyncIOSyst... |
GetPlatformSpecificAsyncIOSystem() |
Return the platform specific async IO system, or nullptr if the standard one should be used. |
|
GetPreferredLanguages() |
Returns an array of the user's preferred languages in order of preference |
|
|
GetPrimaryGPUBrand() |
||
|
GetSHA256Signature ( |
Generates the SHA256 signature of the given data. |
|
|
GetStoredValue |
Get the value for the given section and key from the platform specific key->value store |
|
|
const TCHAR ... |
GetSystemErrorMessage |
Returns the last system error code in string form. Only one return value is valid at a time! |
|
GetSystemFontBytes() |
||
|
GetTimeZoneId() |
Get the timezone identifier for this platform, or an empty string if the default timezone calculation will work. |
|
|
const TCHAR ... |
GetUBTPlatform() |
|
|
const TCHAR ... |
GetUBTTarget() |
|
|
const TCHAR ... |
GetUBTTargetName() |
|
|
GetUniqueAdvertisingId() |
Returns a unique string for advertising identification |
|
|
GetUseVirtualJoysticks() |
Returns whether the platform wants to use a touch screen for virtual joysticks. |
|
|
GetValidTargetPlatforms |
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) |
|
|
GetVolumeButtonsHandledBySystem() |
Returns whether the volume buttons are handled by the system |
|
|
HasActiveWiFiConnection() |
Returns whether WiFi connection is currently active |
|
|
HasMemoryWarningHandler() |
Determines if a warning handler has been set |
|
|
HasNonoptionalCPUFeatures() |
||
|
HasPlatformFeature ( |
Returns whether the given platform feature is currently available (for instance, Metal is only available in IOS8 and with A7 devices) |
|
|
HasProjectPersistentDownloadDir() |
Return true if the PersistentDownloadDir is available. |
|
|
HasSeparateChannelForDebugOutput() |
Whether the platform has a separate debug channel to stdout (eg. OutputDebugString on Windows). |
|
|
HasVariableHardware() |
Returns whether the platform has variable hardware (configurable/upgradeable system). |
|
|
HidePlatformStartupScreen() |
||
|
InitTaggedStorage ( |
Platform specific function for initializing storage of tagged memory buffers |
|
|
Is64bitOperatingSystem() |
Detects whether we're running in a 64-bit operating system. |
|
|
IsDebuggerPresent() |
Return true if a debugger is present |
|
|
IsEnsureAllowed() |
Allows disabling ensure()s without rebuilding the binary, by either a commandline switch or a hotfix. |
|
|
IsInLowPowerMode() |
||
|
IsLocalPrintThreadSafe() |
Whether LocalPrint can be called from any thread without overlapping |
|
|
IsPackagedForDistribution() |
||
|
IsPGOEnabled() |
Returns true if PGO is currently enabled |
|
|
IsRegisteredForRemoteNotifications() |
Returns whether or not the device has been registered to receive remote notifications. |
|
|
IsRemoteSession() |
Check to see if the platform is being viewed remotely. |
|
|
IsRunningOnBattery() |
Returns whether the platform is running on battery power or not. |
|
|
IsValidAbsolutePathFormat ( |
Checks structure of the path against platform formatting requirements |
|
|
const TCHAR ... |
LaunchDir() |
Get the directory the application was launched from (useful for commandline utilities) |
|
LoadTextFileFromPlatformPackage ( |
Loads a text file relative to the package root on platforms that distribute apps in package formats. |
|
|
LocalPrint ( |
Prints string to the default output |
|
|
LowLevelOutputDebugString ( |
Sends a message to a remote tool, and debugger consoles |
|
|
LowLevelOutputDebugStringf ( |
Sends a message to a remote tool, and debugger consoles |
|
|
MemoryBarrier() |
Enforces strict memory load/store ordering across the memory barrier call. |
|
|
EAppReturnTy... |
MessageBoxExt ( |
Show a message box if possible, otherwise print a message and return the default |
|
NeedsNonoptionalCPUFeaturesCheck() |
||
|
NormalizePath ( |
Platform-specific normalization of path E.g. |
|
|
NumberOfCores() |
Return the number of hardware CPU cores |
|
|
NumberOfCoresIncludingHyperthreads() |
Return the number of logical CPU cores |
|
|
NumberOfIOWorkerThreadsToSpawn() |
Return the number of worker threads we should spawn to service IO, NOT based on number of cores |
|
|
NumberOfWorkerThreadsToSpawn() |
Return the number of worker threads we should spawn, based on number of cores |
|
|
OsExecute |
Has the OS execute a command and path pair (such as launch a browser) |
|
|
ParseChunkIdPakchunkIndexMapping |
||
|
PlatformHandleSplashScreen ( |
Called to dismiss splash screen |
|
|
PlatformInit() |
||
|
PlatformPreInit() |
Called during appInit() after cmd line setup |
|
|
PlatformTearDown() |
Called during AppExit(). Log, Config still exist at this point, but not much else does. |
|
|
Prefetch |
Platform-specific instruction prefetch |
|
|
PrefetchBlock |
||
|
PrepareMobileHaptics ( |
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 |
|
|
const TCHAR ... |
ProjectDir() |
Return the project directory |
|
PromptForRemoteDebugging ( |
||
|
PumpEssentialAppMessages() |
Pumps app messages only if there are essential keep-alive messages pending. |
|
|
PumpMessagesForSlowTask() |
||
|
PumpMessagesOutsideMainLoop() |
||
|
RaiseException ( |
||
|
RegisterForRemoteNotifications() |
Requests permission to send remote notifications to the user's device. |
|
|
ReleaseMobileHaptics() |
For mobile devices, this will shutdown the haptics, allowing system to put it to reset as needed |
|
|
RequestDeviceCheckToken |
||
|
RequestExit ( |
Requests application exit. |
|
|
RequestExitWithStatus |
Requests application exit with a specified return code. |
|
|
ResetBrightness() |
||
|
RestartApplication() |
Requests application to restart |
|
|
const TCHAR ... |
RootDir() |
Get the application root directory. |
|
SetBrightness ( |
||
|
SetCrashHandler ( |
Installs handler for the unexpected (due to error) termination of the program, including, but not limited to, crashes. |
|
|
SetDeviceOrientation ( |
Change the orientation of the device: e.g. Portrait, LandscapeRight. |
|
|
SetEnvironmentVar |
Sets an environment variable to the local process's environment |
|
|
SetEpicAccountId ( |
Set the Epic account ID for the user who last used the Launcher |
|
|
SetGracefulTerminationHandler() |
Set/restore the Console Interrupt (Control-C, Control-Break, Close) handler. |
|
|
SetLastError ( |
||
|
SetMemoryWarningHandler ( |
Set a handler to be called when there is a memory warning from the OS |
|
|
SetOverrideProjectDir ( |
Allows a game/program/etc to control the game directory in a special place (for instance, monolithic programs that don't have .uprojects) |
|
|
SetShouldPromptForRemoteDebugging ( |
||
|
SetShouldPromptForRemoteDebugOnEnsure ( |
||
|
SetStoredValue |
Set the value for the given section and key in the platform specific key->value store |
|
|
SetStoredValues |
Set the value for the given section and key in the platform specific key->value store |
|
|
SetUBTTargetName ( |
||
|
SetUTF8Output() |
Sets the default output to UTF8 |
|
|
SetVolumeButtonsHandledBySystem ( |
Set whether the volume buttons are handled by the system |
|
|
ShareURL |
Perform a mobile-style sharing of a URL. Will use native UI to display sharing target |
|
|
ShouldDisablePluginAtRuntime ( |
Allows platform at runtime to disable unsupported plugins |
|
|
ShouldDisplayTouchInterfaceOnFakingTouchEvents() |
||
|
ShutdownTaggedStorage() |
Platform specific function for freeing storage of tagged memory buffers |
|
|
SubmitErrorReport ( |
#CrashReport: 2015-02-24 Remove |
|
|
SupportsBackbufferSampling() |
||
|
SupportsBrightness() |
||
|
SupportsDeviceCheckToken() |
||
|
SupportsForceTouchInput() |
||
|
SupportsFullCrashDumps() |
Platform can generate a full-memory crashdump during crash handling. |
|
|
SupportsLocalCaching() |
||
|
SupportsMessaging() |
||
|
SupportsMultithreadedFileHandles() |
||
|
SupportsTouchInput() |
||
|
TagBuffer |
Platform specific function for tagging a memory buffer with a label. |
|
|
TearDown() |
Frees any memory retained by FGenericPlatformMisc. |
|
|
TickHotfixables() |
Ticks values that can be hotfixable in the config. |
|
|
TriggerMobileHaptics() |
For mobile devices, this will kick the haptic type that was set in PrepareMobileHaptics. |
|
|
UnregisterForRemoteNotifications() |
Requests unregistering from receiving remote notifications on the user's device. |
|
|
UpdateHotfixableEnsureSettings() |
Updates hotfixable ensure settings from config and commandline (config takes priority). |
|
|
UseHDRByDefault() |
||
|
UseRenderThread() |
Checks if platform wants to use a rendering thread on current device |
Name |
Description |
|
---|---|---|
|
FStaticData |
Name |
Description |
---|---|
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 |
Name | Description | ||
---|---|---|---|
|
ClipboardCopy ( |
FPlatformMisc::ClipboardCopy() has been superseded by FPlatformApplicationMisc::ClipboardCopy() |
|
|
ClipboardPaste ( |
FPlatformMisc::ClipboardPaste() has been superseded by FPlatformApplicationMisc::ClipboardPaste() |
|
|
DebugBreak() |
FPlatformMisc::DebugBreak is deprecated. Use the UE_DEBUG_BREAK() macro instead. |
|
|
GetEnvironmentVariable |
void FPlatformMisc::GetEnvironmentVariable(Name, Result, Length) is deprecated. Use FString FPlatformMisc::GetEnvironmentVariable(Name) instead. |
|
|
GetHashedMacAddressString() |
GetHasedMacAddressString is deprecated. It is not reliable on all platforms |
|
|
GetMacAddress() |
GetMacAddress is deprecated. It is not reliable on all platforms |
|
|
GetMacAddressString() |
GetMacAddressString is deprecated. It is not reliable on all platforms |
|
|
GetMachineId() |
GetMachineId is deprecated. Use GetLoginId instead. |
|
|
SetOverrideGameDir ( |
FPaths::SetOverrideGameDir() has been superseded by FPaths::SetOverrideProjectDir(). |