Navigation
API > API/Runtime > API/Runtime/Core
Generic implementation for most platforms
| Name | FGenericPlatformMisc |
| Type | struct |
| Header File | /Engine/Source/Runtime/Core/Public/GenericPlatform/GenericPlatformMisc.h |
| Include Path | #include "GenericPlatform/GenericPlatformMisc.h" |
Syntax
struct FGenericPlatformMisc
Derived Classes
Structs
| Name | Remarks |
|---|---|
| FStaticData |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| AllowedDeviceOrientation | EDeviceScreenOrientation | GenericPlatform/GenericPlatformMisc.h | |
| bPromptForRemoteDebugOnEnsure | bool | Whether the user should be prompted to allow for a remote debugger to be attached on an ensure | GenericPlatform/GenericPlatformMisc.h |
| bShouldPromptForRemoteDebugging | bool | Whether the user should be prompted to allow for a remote debugger to be attached | GenericPlatform/GenericPlatformMisc.h |
| CurrentNetworkConnectionStatus | ENetworkConnectionStatus | GenericPlatform/GenericPlatformMisc.h |
Functions
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void AddAdditionalRootDirectory
(
const FString& RootDir |
Add an additional root directory | GenericPlatform/GenericPlatformMisc.h | |
static FDelegateHandle AddNetworkListener
(
FOnNetworkConnectionChangedDelegate&& InNewDelegate |
GenericPlatform/GenericPlatformMisc.h | ||
static bool AllowAudioThread() |
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) | GenericPlatform/GenericPlatformMisc.h | |
static bool AllowLocalCaching() |
GenericPlatform/GenericPlatformMisc.h | ||
static bool AllowThreadHeartBeat() |
Checks if platform wants to allow the thread heartbeat hang detection | GenericPlatform/GenericPlatformMisc.h | |
static void BeginEnterBackgroundEvent
(
const TCHAR* Text |
Profiler enter background events. | GenericPlatform/GenericPlatformMisc.h | |
static void BeginNamedEvent
(
const FColor& Color, |
GenericPlatform/GenericPlatformMisc.h | ||
static void BeginNamedEvent
(
const FColor& Color, |
Add a named event that can be viewed in external tool, both generic and platform-specific. | GenericPlatform/GenericPlatformMisc.h | |
static void BeginNamedEventFrame() |
Indicates the start of a frame for named events, both generic and platform-specific. | GenericPlatform/GenericPlatformMisc.h | |
static void CacheLaunchDir() |
Function to store the current working directory for use with LaunchDir() | GenericPlatform/GenericPlatformMisc.h | |
static bool CheckPersistentDownloadStorageSpaceAvailable
(
uint64 BytesRequired, |
Ensure that there enough space in the persistent download dir. | GenericPlatform/GenericPlatformMisc.h | |
static void ChooseHDRDeviceAndColorGamut
(
uint32 DeviceId, |
GenericPlatform/GenericPlatformMisc.h | ||
static FString CloudDir() |
Return the CloudDir. CloudDir can be per-user. | GenericPlatform/GenericPlatformMisc.h | |
static bool CommandLineCommands() |
Handles Game Explorer, Firewall and FirstInstall commands, typically from the installer | GenericPlatform/GenericPlatformMisc.h | |
static void CreateGuid
(
FGuid& Result |
Create a new globally unique identifier. | GenericPlatform/GenericPlatformMisc.h | |
static void CustomNamedStat
(
const TCHAR* Text, |
Set the value for a named custom stat that can be viewed in external tool, both generic and platform-specific. | GenericPlatform/GenericPlatformMisc.h | |
static void CustomNamedStat
(
const ANSICHAR* Text, |
GenericPlatform/GenericPlatformMisc.h | ||
static void DebugBreak() |
Break into the debugger, if IsDebuggerPresent returns true, otherwise do nothing | GenericPlatform/GenericPlatformMisc.h | |
| 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 | GenericPlatform/GenericPlatformMisc.h | ||
| 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 | GenericPlatform/GenericPlatformMisc.h | ||
static bool DesktopTouchScreen() |
GenericPlatform/GenericPlatformMisc.h | ||
static void DisableScreenTimeout() |
GenericPlatform/GenericPlatformMisc.h | ||
static void EnableScreenTimeout() |
GenericPlatform/GenericPlatformMisc.h | ||
static void EndEnterBackgroundEvent() |
GenericPlatform/GenericPlatformMisc.h | ||
static void EndNamedEvent() |
Close a named event that can be viewed in external tool, both generic and platform-specific. | GenericPlatform/GenericPlatformMisc.h | |
static const TCHAR * EngineDir() |
Get the engine directory | GenericPlatform/GenericPlatformMisc.h | |
static void EnsureNetworkIfNecessary() |
GenericPlatform/GenericPlatformMisc.h | ||
static bool Exec
(
UWorld* InWorld, |
Platform-specific Exec function | GenericPlatform/GenericPlatformMisc.h | |
static bool Expand16BitIndicesTo32BitOnLoad() |
GenericPlatform/GenericPlatformMisc.h | ||
static bool FileExistsInPlatformPackage
(
const FString& RelativePath |
GenericPlatform/GenericPlatformMisc.h | ||
static bool FullscreenSameAsWindowedFullscreen() |
GenericPlatform/GenericPlatformMisc.h | ||
static const TCHAR * GamePersistentDownloadDir () |
Return the GamePersistentDownloadDir. | GenericPlatform/GenericPlatformMisc.h | |
static const TCHAR * GameTemporaryDownloadDir() |
Return the temporary directory | GenericPlatform/GenericPlatformMisc.h | |
static const TCHAR * GeneratedConfigDir() |
GenericPlatform/GenericPlatformMisc.h | ||
| Get additional directories which can be considered as root directories | GenericPlatform/GenericPlatformMisc.h | ||
| Returns the allowed orientation of the device. | GenericPlatform/GenericPlatformMisc.h | ||
static int GetBatteryLevel() |
Gets the current battery level. | GenericPlatform/GenericPlatformMisc.h | |
static bool GetBlockingIOStats
(
FProcessIOStats& OutStats, |
Gets Blocking Input/Output stats covering the lifetime of the process | GenericPlatform/GenericPlatformMisc.h | |
static float GetBrightness() |
GenericPlatform/GenericPlatformMisc.h | ||
static int32 GetChunkIDFromPakchunkIndex
(
int32 PakchunkIndex |
GenericPlatform/GenericPlatformMisc.h | ||
| Returns the value of config rule variable or null if not found. | GenericPlatform/GenericPlatformMisc.h | ||
| Returns the map containing all config rule variables. | GenericPlatform/GenericPlatformMisc.h | ||
static void GetConfiguredCoreLimits
(
int32 PlatformNumPhysicalCores, |
Parse CoreLimit from CommandLine or from the SetCoreLimit value. | GenericPlatform/GenericPlatformMisc.h | |
static bool GetContextSwitchStats
(
FContextSwitchStats& OutStats, |
Gets Context Switch stats covering the lifetime of the process | GenericPlatform/GenericPlatformMisc.h | |
static EConvertibleLaptopMode GetConvertibleLaptopMode() |
Gets the current mode of convertible laptops, i.e. Laptop or Tablet. | GenericPlatform/GenericPlatformMisc.h | |
static FString GetCPUBrand() |
Uses cpuid instruction to get the CPU brand string | GenericPlatform/GenericPlatformMisc.h | |
static FString GetCPUChipset() |
Returns the CPU chipset if known | GenericPlatform/GenericPlatformMisc.h | |
static uint32 GetCPUInfo() |
On x86(-64) platforms, uses cpuid instruction to get the CPU signature | GenericPlatform/GenericPlatformMisc.h | |
static uint32 GetCPUMicrocodeRevision() |
GenericPlatform/GenericPlatformMisc.h | ||
static uint32 GetCPUModelID() |
GenericPlatform/GenericPlatformMisc.h | ||
static FString GetCPUVendor() |
Uses cpuid instruction to get the vendor string | GenericPlatform/GenericPlatformMisc.h | |
static ECrashHandlingType GetCrashHandlingType() |
Gets the current crash handling type. | GenericPlatform/GenericPlatformMisc.h | |
static const TCHAR * GetDefaultDeviceProfileName() |
Gets the default profile name. Used if there is no device profile specified | GenericPlatform/GenericPlatformMisc.h | |
static FString GetDefaultLanguage () |
Get the default language (for localization) used by this platform. | GenericPlatform/GenericPlatformMisc.h | |
static FString GetDefaultLocale () |
Get the default locale (for internationalization) used by this platform. | GenericPlatform/GenericPlatformMisc.h | |
static const TCHAR * GetDefaultPathSeparator() |
GenericPlatform/GenericPlatformMisc.h | ||
static FString GetDeviceId () |
Returns a unique string for device identification. | GenericPlatform/GenericPlatformMisc.h | |
static FString GetDeviceMakeAndModel() |
GenericPlatform/GenericPlatformMisc.h | ||
static EDeviceScreenOrientation GetDeviceOrientation() |
Returns the current orientation of the device: will be either Portrait, LandscapeLeft, PortraitUpsideDown or LandscapeRight. | GenericPlatform/GenericPlatformMisc.h | |
static FString GetDeviceTag () |
Get Device Tag of the device running the session. | GenericPlatform/GenericPlatformMisc.h | |
static float GetDeviceTemperatureLevel () |
Returns the current device temperature level. | GenericPlatform/GenericPlatformMisc.h | |
static int32 GetDeviceVolume () |
Returns the device volume if the device is capable of returning that information. | GenericPlatform/GenericPlatformMisc.h | |
static bool GetDiskTotalAndFreeSpace
(
const FString& InPath, |
Retrieves information about the total number of bytes and number of free bytes for the specified disk path. | GenericPlatform/GenericPlatformMisc.h | |
static bool GetEngineAndProjectAbsoluteDirsFromExecutable
(
FString& OutProjectDir, |
Return the engine and project directory based from the executable. | GenericPlatform/GenericPlatformMisc.h | |
static const TCHAR * GetEngineMode() |
Get a string description of the mode the engine was running in. | GenericPlatform/GenericPlatformMisc.h | |
static FString GetEnvironmentVariable
(
const TCHAR* VariableName |
Retrieve a environment variable from the system | GenericPlatform/GenericPlatformMisc.h | |
static FString GetEpicAccountId () |
Get the Epic account ID for the user who last used the Launcher. | GenericPlatform/GenericPlatformMisc.h | |
static int32 GetExternalAppMaxPathLength () |
Returns the maximum length of a path which applies to all processes on the host platform. | GenericPlatform/GenericPlatformMisc.h | |
static FText GetFileManagerName() |
GenericPlatform/GenericPlatformMisc.h | ||
static FGPUDriverInfo GetGPUDriverInfo
(
const FString& DeviceDescription |
GenericPlatform/GenericPlatformMisc.h | ||
static FString GetHashedMacAddressString () |
Retrieve the Mac address of the current adapter as a hashed string (privacy). | GenericPlatform/GenericPlatformMisc.h | |
static FString GetHostArchitecture() |
GenericPlatform/GenericPlatformMisc.h | ||
static uint32 GetLastError() |
GenericPlatform/GenericPlatformMisc.h | ||
static FString GetLocalCurrencyCode() |
Returns the currency code associated with the device's locale | GenericPlatform/GenericPlatformMisc.h | |
static FString GetLocalCurrencySymbol() |
Returns the currency symbol associated with the device's locale | GenericPlatform/GenericPlatformMisc.h | |
static FString GetLoginId () |
Returns a unique string associated with the login account of the current machine. | GenericPlatform/GenericPlatformMisc.h | |
static TArray< uint8 > GetMacAddress () |
Retrieve the Mac address of the current adapter. | GenericPlatform/GenericPlatformMisc.h | |
static FString GetMacAddressString () |
Retrieve the Mac address of the current adapter as a string. | GenericPlatform/GenericPlatformMisc.h | |
static FGuid GetMachineId () |
Get (or create) the unique ID used to identify this computer. | GenericPlatform/GenericPlatformMisc.h | |
static int32 GetMaxPathLength () |
Returns the maximum length of a path. | GenericPlatform/GenericPlatformMisc.h | |
static int32 GetMaxRefreshRate() |
Retrieves the current maximum refresh rate supported by the platform | GenericPlatform/GenericPlatformMisc.h | |
static int32 GetMaxSupportedRefreshRate() |
Retrieves the maximum refresh rate supported by the platform | GenericPlatform/GenericPlatformMisc.h | |
static int32 GetMaxSyncInterval() |
Returns the platform's maximum allowed value for rhi.SyncInterval | GenericPlatform/GenericPlatformMisc.h | |
static int GetMobilePropagateAlphaSetting() |
For mobile devices, this function will return true if we wish to propagate the alpha to the backbuffer | GenericPlatform/GenericPlatformMisc.h | |
static ENetworkConnectionStatus GetNetworkConnectionStatus() |
Returns the current status for the network connection | GenericPlatform/GenericPlatformMisc.h | |
static ENetworkConnectionType GetNetworkConnectionType() |
Returns whether WiFi connection is currently active | GenericPlatform/GenericPlatformMisc.h | |
| Returns any platform-specific key-value data that needs to be sent to the network file server | GenericPlatform/GenericPlatformMisc.h | ||
static const TCHAR * GetNullRHIShaderFormat() |
Determines the shader format for the platform | GenericPlatform/GenericPlatformMisc.h | |
static FString GetOperatingSystemId() |
Gets a globally unique ID the represents a particular operating system install. | GenericPlatform/GenericPlatformMisc.h | |
static FString GetOSVersion () |
Gets a string representing the numeric OS version (as opposed to a translated OS version that GetOSVersions returns). | GenericPlatform/GenericPlatformMisc.h | |
| Gets the OS Version and OS Subversion. | GenericPlatform/GenericPlatformMisc.h | ||
static bool GetPageFaultStats
(
FPageFaultStats& OutStats, |
Gets Page Fault stats covering the lifetime of the process | GenericPlatform/GenericPlatformMisc.h | |
static int32 GetPakchunkIndexFromPakFile
(
FStringView InFilename |
GenericPlatform/GenericPlatformMisc.h | ||
static FStringView GetPakFilenamePrefix() |
GenericPlatform/GenericPlatformMisc.h | ||
static const TCHAR * GetPathVarDelimiter() |
Return the delimiter between paths in the PATH environment variable. | GenericPlatform/GenericPlatformMisc.h | |
static FString GetPendingActivationProtocol() |
Returns activation protocol that's waiting to be broadcast | GenericPlatform/GenericPlatformMisc.h | |
static IPlatformChunkInstall * GetPlatformChunkInstall() |
Returns the platform specific chunk based install interface | GenericPlatform/GenericPlatformMisc.h | |
static IPlatformCompression * GetPlatformCompression() |
Returns the platform specific compression interface | GenericPlatform/GenericPlatformMisc.h | |
static const TCHAR * GetPlatformFeaturesModuleName () |
Return the name of the platform features module. | GenericPlatform/GenericPlatformMisc.h | |
static IPlatformHostCommunication & GetPlatformHostCommunication() |
Returns the platform specific interface for communication with processes running on the host pc. | GenericPlatform/GenericPlatformMisc.h | |
| Returns any platform specific warning messages we want printed on screen | GenericPlatform/GenericPlatformMisc.h | ||
static FAsyncIOSystemBase * GetPlatformSpecificAsyncIOSystem() |
Return the platform specific async IO system, or nullptr if the standard one should be used. | GenericPlatform/GenericPlatformMisc.h | |
static FPlatformUserId GetPlatformUserForUserIndex
(
int32 LocalUserIndex |
Converts from a local user index to a FPlatformUserId | GenericPlatform/GenericPlatformMisc.h | |
| Returns an array of the user's preferred languages in order of preference | GenericPlatform/GenericPlatformMisc.h | ||
static FString GetPrimaryGPUBrand() |
GenericPlatform/GenericPlatformMisc.h | ||
static EProcessDiagnosticFlags GetProcessDiagnostics() |
Returns non-zero if a performance-sensitive diagnostic, like a memory sanitizer, is detected for this process | GenericPlatform/GenericPlatformMisc.h | |
static const FProcessorGroupDesc & GetProcessorGroupDesc() |
GenericPlatform/GenericPlatformMisc.h | ||
static bool GetSHA256Signature
(
const void* Data, |
Generates the SHA256 signature of the given data. | GenericPlatform/GenericPlatformMisc.h | |
| 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 | GenericPlatform/GenericPlatformMisc.h | ||
static const TCHAR * GetSystemErrorMessage
(
TCHAR* OutBuffer, |
Returns the last system error code in string form. | GenericPlatform/GenericPlatformMisc.h | |
static TArray< uint8 > GetSystemFontBytes() |
GenericPlatform/GenericPlatformMisc.h | ||
static FString GetTimeZoneId () |
Get the timezone identifier for this platform, or an empty string if the default timezone calculation will work. | GenericPlatform/GenericPlatformMisc.h | |
static const TCHAR * GetUBTArchitecture() |
GenericPlatform/GenericPlatformMisc.h | ||
static const TCHAR * GetUBTPlatform() |
GenericPlatform/GenericPlatformMisc.h | ||
static const TCHAR * GetUBTTarget() |
GenericPlatform/GenericPlatformMisc.h | ||
static const TCHAR * GetUBTTargetName() |
GenericPlatform/GenericPlatformMisc.h | ||
static FString GetUniqueAdvertisingId() |
Returns a unique string for advertising identification | GenericPlatform/GenericPlatformMisc.h | |
static int32 GetUserIndexForPlatformUser
(
FPlatformUserId PlatformUser |
Converts from a FPlatformUserId to local user index | GenericPlatform/GenericPlatformMisc.h | |
static bool GetUseVirtualJoysticks() |
Returns whether the platform wants to use a touch screen for virtual joysticks. | GenericPlatform/GenericPlatformMisc.h | |
| 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) | GenericPlatform/GenericPlatformMisc.h | ||
static const float GetVirtualKeyboardInputHeight() |
GenericPlatform/GenericPlatformMisc.h | ||
static bool GetVolumeButtonsHandledBySystem() |
Returns whether the volume buttons are handled by the system | GenericPlatform/GenericPlatformMisc.h | |
static bool HasActiveWiFiConnection() |
Returns whether WiFi connection is currently active | GenericPlatform/GenericPlatformMisc.h | |
static bool HasMemoryWarningHandler() |
Determines if a warning handler has been set | GenericPlatform/GenericPlatformMisc.h | |
static bool HasNonoptionalCPUFeatures() |
GenericPlatform/GenericPlatformMisc.h | ||
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) | GenericPlatform/GenericPlatformMisc.h | |
static bool HasProjectPersistentDownloadDir () |
Return true if the PersistentDownloadDir is available. | GenericPlatform/GenericPlatformMisc.h | |
static bool HasSeparateChannelForDebugOutput () |
Whether the platform has a separate debug channel to stdout (eg. OutputDebugString on Windows). | GenericPlatform/GenericPlatformMisc.h | |
static bool HasVariableHardware() |
Returns whether the platform has variable hardware (configurable/upgradeable system). | GenericPlatform/GenericPlatformMisc.h | |
static void HidePlatformStartupScreen() |
GenericPlatform/GenericPlatformMisc.h | ||
static void InitTaggedStorage
(
uint32 NumTags |
Platform specific function for initializing storage of tagged memory buffers | GenericPlatform/GenericPlatformMisc.h | |
static bool Is64bitOperatingSystem() |
Detects whether we're running in a 64-bit operating system. | GenericPlatform/GenericPlatformMisc.h | |
static bool IsCacheStorageAvailable () |
For platforms that support cache storage functionality, setting a directory for it when it's not available can result in errors. | GenericPlatform/GenericPlatformMisc.h | |
static bool IsDebuggerPresent() |
Return true if a debugger is present | GenericPlatform/GenericPlatformMisc.h | |
static bool IsEnsureAllowed() |
Allows disabling ensure()s without rebuilding the binary, by either a commandline switch or a hotfix. | GenericPlatform/GenericPlatformMisc.h | |
static bool IsInLowPowerMode() |
GenericPlatform/GenericPlatformMisc.h | ||
static bool IsLocalPrintThreadSafe() |
Whether LocalPrint can be called from any thread without overlapping | GenericPlatform/GenericPlatformMisc.h | |
static bool IsLowLevelOutputDebugStringStructured() |
Whether LowLevelOutputDebugString[f] can receive structured output as lines of JSON. | GenericPlatform/GenericPlatformMisc.h | |
static bool IsPackagedForDistribution() |
GenericPlatform/GenericPlatformMisc.h | ||
static bool IsPGIActive () |
Returns true if PGI (profile-guided instrumentation, needed for PGO) is currently ongoing. | GenericPlatform/GenericPlatformMisc.h | |
static bool IsPGICapableBinary() |
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 | GenericPlatform/GenericPlatformMisc.h | |
static bool IsPGOEnabled() |
Returns true if PGO is currently enabled | GenericPlatform/GenericPlatformMisc.h | |
static bool IsRegisteredForRemoteNotifications() |
Returns whether or not the device has been registered to receive remote notifications. | GenericPlatform/GenericPlatformMisc.h | |
static bool IsRemoteSession () |
Check to see if the platform is being viewed remotely. | GenericPlatform/GenericPlatformMisc.h | |
static bool IsRunningInCloud() |
Return if the game is running on cloud server | GenericPlatform/GenericPlatformMisc.h | |
static bool IsRunningOnBattery() |
Returns whether the platform is running on battery power or not. | GenericPlatform/GenericPlatformMisc.h | |
static bool IsValidAbsolutePathFormat
(
const FString& Path |
Checks structure of the path against platform formatting requirements | GenericPlatform/GenericPlatformMisc.h | |
static const TCHAR * LaunchDir() |
Get the directory the application was launched from (useful for commandline utilities) | GenericPlatform/GenericPlatformMisc.h | |
static FString LoadTextFileFromPlatformPackage
(
const FString& RelativePath |
Loads a text file relative to the package root on platforms that distribute apps in package formats. | GenericPlatform/GenericPlatformMisc.h | |
static void LocalPrint
(
const TCHAR* Str |
Prints string to the default output | GenericPlatform/GenericPlatformMisc.h | |
static void LogNameEventStatsInit() |
GenericPlatform/GenericPlatformMisc.h | ||
static void LowLevelOutputDebugString
(
const TCHAR* Message |
Sends a message to a remote tool, and debugger consoles | GenericPlatform/GenericPlatformMisc.h | |
static void LowLevelOutputDebugStringf
(
const TCHAR* Format, |
GenericPlatform/GenericPlatformMisc.h | ||
static void MemoryBarrier() |
Enforces strict memory load/store ordering across the memory barrier call. | GenericPlatform/GenericPlatformMisc.h | |
static EAppReturnType::Type MessageBoxExt
(
EAppMsgType::Type MsgType, |
Show a message box if possible, otherwise print a message and return the default | GenericPlatform/GenericPlatformMisc.h | |
static bool NeedsNonoptionalCPUFeaturesCheck() |
GenericPlatform/GenericPlatformMisc.h | ||
static void NormalizePath
(
FStringBuilderBase& InPath |
Platform-specific normalization of path E.g. | GenericPlatform/GenericPlatformMisc.h | |
static void NormalizePath
(
FString& InPath |
Platform-specific normalization of path E.g. | GenericPlatform/GenericPlatformMisc.h | |
static int32 NumberOfCores() |
Return the number of hardware CPU cores | GenericPlatform/GenericPlatformMisc.h | |
static int32 NumberOfCoresIncludingHyperthreads() |
Return the number of logical CPU cores | GenericPlatform/GenericPlatformMisc.h | |
static int32 NumberOfIOWorkerThreadsToSpawn() |
Return the number of worker threads we should spawn to service IO, NOT based on number of cores | GenericPlatform/GenericPlatformMisc.h | |
static int32 NumberOfWorkerThreadsToSpawn() |
Return the number of worker threads we should spawn, based on number of cores | GenericPlatform/GenericPlatformMisc.h | |
static bool OsExecute
(
const TCHAR* CommandType, |
Has the OS execute a command and path pair (such as launch a browser) | GenericPlatform/GenericPlatformMisc.h | |
| GenericPlatform/GenericPlatformMisc.h | |||
static void PlatformHandleSplashScreen
(
bool ShowSplashScreen |
Called to dismiss splash screen | GenericPlatform/GenericPlatformMisc.h | |
static void PlatformInit() |
GenericPlatform/GenericPlatformMisc.h | ||
static void PlatformPreInit() |
Called during appInit() after cmd line setup | GenericPlatform/GenericPlatformMisc.h | |
static void PlatformTearDown() |
Called during AppExit(). Log, Config still exist at this point, but not much else does. | GenericPlatform/GenericPlatformMisc.h | |
static void Prefetch
(
const void* Ptr, |
GenericPlatform/GenericPlatformMisc.h | ||
static void Prefetch
(
const void* Ptr |
GenericPlatform/GenericPlatformMisc.h | ||
static void PrefetchBlock
(
const void* Ptr |
GenericPlatform/GenericPlatformMisc.h | ||
static void PrefetchBlock
(
const void* Ptr, |
GenericPlatform/GenericPlatformMisc.h | ||
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 | GenericPlatform/GenericPlatformMisc.h | |
static const TCHAR * ProjectDir() |
Return the project directory | GenericPlatform/GenericPlatformMisc.h | |
static void PromptForRemoteDebugging
(
bool bIsEnsure |
GenericPlatform/GenericPlatformMisc.h | ||
static void PumpEssentialAppMessages () |
Pumps app messages only if there are essential keep-alive messages pending. | GenericPlatform/GenericPlatformMisc.h | |
static void PumpMessagesForSlowTask() |
GenericPlatform/GenericPlatformMisc.h | ||
static void PumpMessagesOutsideMainLoop() |
GenericPlatform/GenericPlatformMisc.h | ||
static void RaiseException
(
uint32 ExceptionCode |
GenericPlatform/GenericPlatformMisc.h | ||
static void RegisterForRemoteNotifications() |
Requests permission to send remote notifications to the user's device. | GenericPlatform/GenericPlatformMisc.h | |
static void ReleaseMobileHaptics() |
For mobile devices, this will shutdown the haptics, allowing system to put it to reset as needed | GenericPlatform/GenericPlatformMisc.h | |
static bool RemoveNetworkListener
(
FDelegateHandle Handle |
GenericPlatform/GenericPlatformMisc.h | ||
| GenericPlatform/GenericPlatformMisc.h | |||
static void RequestExit
(
bool Force, |
Requests application exit. | GenericPlatform/GenericPlatformMisc.h | |
static void RequestExitWithStatus
(
bool Force, |
Requests application exit with a specified return code. | GenericPlatform/GenericPlatformMisc.h | |
static bool RestartApplication() |
Requests application to restart | GenericPlatform/GenericPlatformMisc.h | |
static bool RestartApplicationWithCmdLine
(
const char* CmdLine |
Requests application to restart appending the passed in CmdLine to the restart | GenericPlatform/GenericPlatformMisc.h | |
static const TCHAR * RootDir() |
Get the application root directory. | GenericPlatform/GenericPlatformMisc.h | |
static void SetAllowedDeviceOrientation
(
EDeviceScreenOrientation NewAllowedDeviceOrientation |
Change the allowed orientation of the device. | GenericPlatform/GenericPlatformMisc.h | |
static void SetBrightness
(
float bBright |
GenericPlatform/GenericPlatformMisc.h | ||
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. | GenericPlatform/GenericPlatformMisc.h | |
static ECrashHandlingType SetCrashHandlingType
(
ECrashHandlingType Type |
Sets the type of crash handling done by the engine. | GenericPlatform/GenericPlatformMisc.h | |
static void SetDeviceOrientation
(
EDeviceScreenOrientation NewDeviceOrientation |
Change the orientation of the device. | GenericPlatform/GenericPlatformMisc.h | |
static void SetEnvironmentVar
(
const TCHAR* VariableName, |
Sets an environment variable to the local process's environment | GenericPlatform/GenericPlatformMisc.h | |
static void SetGracefulTerminationHandler() |
Set/restore the Console Interrupt (Control-C, Control-Break, Close) handler. | GenericPlatform/GenericPlatformMisc.h | |
static void SetLastError
(
uint32 ErrorCode |
GenericPlatform/GenericPlatformMisc.h | ||
static void SetMemoryWarningHandler
(
void(*)(const FGenericMemoryWarningContext&Context) Handler |
Set a handler to be called when there is a memory warning from the OS | GenericPlatform/GenericPlatformMisc.h | |
static void SetNetworkConnectionStatus
(
ENetworkConnectionStatus NewNetworkConnectionStatus |
Updates the current status for the network connection | GenericPlatform/GenericPlatformMisc.h | |
static void SetOverrideGameDir
(
const FString& InOverrideDir |
GenericPlatform/GenericPlatformMisc.h | ||
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) | GenericPlatform/GenericPlatformMisc.h | |
static void SetShouldPromptForRemoteDebugging
(
bool bInShouldPrompt |
GenericPlatform/GenericPlatformMisc.h | ||
static void SetShouldPromptForRemoteDebugOnEnsure
(
bool bInShouldPrompt |
GenericPlatform/GenericPlatformMisc.h | ||
| 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 | GenericPlatform/GenericPlatformMisc.h | ||
| 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 | GenericPlatform/GenericPlatformMisc.h | ||
static void SetUBTTargetName
(
const TCHAR* InTargetName |
GenericPlatform/GenericPlatformMisc.h | ||
static bool SetupSyscallFilters() |
Unix only function, but put a stub so we can call this for higher level code when we want to setup the Syscall Filters | GenericPlatform/GenericPlatformMisc.h | |
static void SetUTF8Output() |
Sets the default output to UTF8 | GenericPlatform/GenericPlatformMisc.h | |
static void SetVolumeButtonsHandledBySystem
(
bool enabled |
Set whether the volume buttons are handled by the system | GenericPlatform/GenericPlatformMisc.h | |
| Perform a mobile-style sharing of a URL. Will use native UI to display sharing target | GenericPlatform/GenericPlatformMisc.h | ||
static bool ShouldDisablePluginAtRuntime
(
const FString& PluginName |
Allows platform at runtime to disable unsupported plugins | GenericPlatform/GenericPlatformMisc.h | |
static bool ShouldDisplayTouchInterfaceOnFakingTouchEvents() |
GenericPlatform/GenericPlatformMisc.h | ||
static void ShowConsoleWindow() |
GenericPlatform/GenericPlatformMisc.h | ||
static void ShutdownTaggedStorage() |
Platform specific function for freeing storage of tagged memory buffers | GenericPlatform/GenericPlatformMisc.h | |
static bool StartNewPGOCollection
(
const FString& AbsoluteFileName |
On platforms that support run-time PGI on/off, starts a new collection with a given file name. | GenericPlatform/GenericPlatformMisc.h | |
static void StatNamedEvent
(
const CharType* Text |
Stats logging for named event | GenericPlatform/GenericPlatformMisc.h | |
static bool StopPGOCollectionAndCloseFile () |
On platforms that support run-time PGI on/off, stops the current collection and writes out the file (or completes its write). | GenericPlatform/GenericPlatformMisc.h | |
static void SubmitErrorReport
(
const TCHAR* InErrorHist, |
#CrashReport: 2015-02-24 Remove | GenericPlatform/GenericPlatformMisc.h | |
static bool SupportsBackbufferSampling() |
GenericPlatform/GenericPlatformMisc.h | ||
static bool SupportsBrightness() |
GenericPlatform/GenericPlatformMisc.h | ||
static bool SupportsDeviceCheckToken() |
GenericPlatform/GenericPlatformMisc.h | ||
static bool SupportsForceTouchInput() |
GenericPlatform/GenericPlatformMisc.h | ||
static bool SupportsFullCrashDumps() |
Platform can generate a full-memory crashdump during crash handling. | GenericPlatform/GenericPlatformMisc.h | |
static bool SupportsLocalCaching() |
GenericPlatform/GenericPlatformMisc.h | ||
static bool SupportsMessaging() |
GenericPlatform/GenericPlatformMisc.h | ||
static bool SupportsMultithreadedFileHandles() |
GenericPlatform/GenericPlatformMisc.h | ||
static bool SupportsTouchInput() |
GenericPlatform/GenericPlatformMisc.h | ||
static void TagBuffer
(
const char* Label, |
Platform specific function for tagging a memory buffer with a label. | GenericPlatform/GenericPlatformMisc.h | |
static void TearDown() |
Frees any memory retained by FGenericPlatformMisc. | GenericPlatform/GenericPlatformMisc.h | |
static void TickHotfixables() |
Ticks values that can be hotfixable in the config. | GenericPlatform/GenericPlatformMisc.h | |
static void TickStatNamedEvents() |
GenericPlatform/GenericPlatformMisc.h | ||
static void TriggerMobileHaptics () |
For mobile devices, this will kick the haptic type that was set in PrepareMobileHaptics. | GenericPlatform/GenericPlatformMisc.h | |
static void UnregisterForRemoteNotifications() |
Requests unregistering from receiving remote notifications on the user's device. | GenericPlatform/GenericPlatformMisc.h | |
static void UpdateHotfixableEnsureSettings() |
Updates hotfixable ensure settings from config and commandline (config takes priority). | GenericPlatform/GenericPlatformMisc.h | |
static bool UseHDRByDefault() |
GenericPlatform/GenericPlatformMisc.h | ||
static bool UseRenderThread() |
Checks if platform wants to use a rendering thread on current device | GenericPlatform/GenericPlatformMisc.h | |
static const FString VersionCheckPlatformName() |
GenericPlatform/GenericPlatformMisc.h | ||
static bool WasLaunchedStreaming() |
Return true if the game is being streamed to a separate client device | GenericPlatform/GenericPlatformMisc.h |