Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > GenericPlatform > FGenericPlatformMisc

Light Theme

Dark Theme

FGenericPlatformMisc

Generic implementation for most platforms

Windows

MacOS

Linux

Inheritance Hierarchy

FGenericPlatformMisc

	FHoloLensMisc
	FUnixPlatformMisc

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

	Name	Description
void	AddAdditionalRootDirectory ( const FString& RootDir )	Add an additional root directory
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)
bool	AllowLocalCaching()
bool	AllowThreadHeartBeat()	Checks if platform wants to allow the thread heartbeat hang detection
void	BeginNamedEvent ( const FColor& Color, const ANSICHAR* Text )	Platform specific function for adding a named event that can be viewed in external tool
void	BeginNamedEvent ( const FColor& Color, const TCHAR* Text )	Platform specific function for adding a named event that can be viewed in external tool
void	BeginNamedEventFrame()	Indicates the start of a frame for named events
void	BeginProfilerColor ( const FColor& Color )	Profiler color stack - this overrides the color for named events with undefined colors (e.g stat namedevents)
void	CacheLaunchDir()	Function to store the current working directory for use with LaunchDir()
void	ChooseHDRDeviceAndColorGamut ( uint32 DeviceId, uint32 DisplayNitLevel, int32& OutputDevice, int32& ColorGamut )
FString	CloudDir()	Return the CloudDir. CloudDir can be per-user.
bool	CommandLineCommands()	Handles Game Explorer, Firewall and FirstInstall commands, typically from the installer
void	CreateGuid ( FGuid& Result )	Create a new globally unique identifier.
void	CustomNamedStat ( const ANSICHAR* Text, float Value, const ANSICHAR* Graph, const ANSICHAR* Unit )
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
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
bool	DesktopTouchScreen()
void	EndNamedEvent()	Platform specific function for closing a named event that can be viewed in external tool
void	EndProfilerColor()
const TCHAR ...	EngineDir()	Get the engine directory
bool	Exec ( UWorld* InWorld, const TCHAR* Cmd, FOutputDevice& Out )	Platform-specific Exec function
bool	Expand16BitIndicesTo32BitOnLoad()
bool	FileExistsInPlatformPackage ( const FString& RelativePath )
bool	FullscreenSameAsWindowedFullscreen()
const TCHAR ...	GamePersistentDownloadDir()	Return the GamePersistentDownloadDir.
TArray< FStr...	GetAdditionalRootDirectories()	Get additional directories which can be considered as root directories
TArray< FCus...	GetAllLanguageChunks()
TArray< FCus...	GetAllOnDemandChunks()
int	GetBatteryLevel()	Gets the current battery level.
float	GetBrightness()
int32	GetChunkIDFromPakchunkIndex ( int32 PakchunkIndex )
EConvertible...	GetConvertibleLaptopMode()	Gets the current mode of convertible laptops, i.e. Laptop or Tablet.
FString	GetCPUBrand()	Uses cpuid instruction to get the CPU brand string
FString	GetCPUChipset()	Returns the CPU chipset if known
uint32	GetCPUInfo()	On x86(-64) platforms, uses cpuid instruction to get the CPU signature
FString	GetCPUVendor()	Uses cpuid instruction to get the vendor string
TArray< FCus...	GetCustomChunksByType ( ECustomChunkType DesiredChunkType )
const TCHAR ...	GetDefaultDeviceProfileName()	Gets the default profile name. Used if there is no device profile specified
FString	GetDefaultLanguage()	Get the default language (for localization) used by this platform.
FString	GetDefaultLocale()	Get the default locale (for internationalization) used by this platform.
const TCHAR ...	GetDefaultPathSeparator()
FString	GetDeviceId()	Returns a unique string for device identification.
FString	GetDeviceMakeAndModel()
EDeviceScree...	GetDeviceOrientation()	Returns the orientation of the device: e.g. Portrait, LandscapeRight.
float	GetDeviceTemperatureLevel()	Returns the current device temperature level.
int32	GetDeviceVolume()	Returns the device volume if the device is capable of returning that information.
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.
const TCHAR ...	GetEngineMode()	Get a string description of the mode the engine was running in.
FString	GetEnvironmentVariable ( const TCHAR* VariableName )	Retrieve a environment variable from the system
FString	GetEpicAccountId()	Get the Epic account ID for the user who last used the Launcher.
FText	GetFileManagerName()
FGPUDriverIn...	GetGPUDriverInfo ( const FString& DeviceDescription )
uint32	GetLastError()
FString	GetLocalCurrencyCode()	Returns the currency code associated with the device's locale
FString	GetLocalCurrencySymbol()	Returns the currency symbol associated with the device's locale
FString	GetLoginId()	Returns a unique string associated with the login account of the current machine.
int32	GetMaxPathLength()	Returns the maximum length of a path
ENetworkConn...	GetNetworkConnectionType()	Returns whether WiFi connection is currently active
const TCHAR ...	GetNullRHIShaderFormat()	Determines the shader format for the platform
FString	GetOperatingSystemId()	Gets a globally unique ID the represents a particular operating system install.
FString	GetOSVersion()	Gets a string representing the numeric OS version (as opposed to a translated OS version that GetOSVersions returns).
void	GetOSVersions ( FString& out_OSVersionLabel, FString& out_OSSubVersionLabel )	Gets the OS Version and OS Subversion.
int32	GetPakchunkIndexFromPakFile ( const FString& InFilename )
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.
bool	GetPlatformScreenWarnings ( TArray< FText >& PlatformScreenWar... )	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.
TArray< FStr...	GetPreferredLanguages()	Returns an array of the user's preferred languages in order of preference
FString	GetPrimaryGPUBrand()
bool	GetSHA256Signature ( const void* Data, uint32 ByteSize, FSHA256Signature& OutSignature )	Generates the SHA256 signature of the given data.
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
const TCHAR ...	GetSystemErrorMessage ( TCHAR* OutBuffer, int32 BufferCount, int32 Error )	Returns the last system error code in string form.
TArray< uint...	GetSystemFontBytes()
FString	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()
FString	GetUniqueAdvertisingId()	Returns a unique string for advertising identification
bool	GetUseVirtualJoysticks()	Returns whether the platform wants to use a touch screen for virtual joysticks.
void	GetValidTargetPlatforms ( TArray< FString >& TargetPlatformN... )	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)
bool	GetVolumeButtonsHandledBySystem()	Returns whether the volume buttons are handled by the system
bool	HasActiveWiFiConnection()	Returns whether WiFi connection is currently active
bool	HasMemoryWarningHandler()	Determines if a warning handler has been set
bool	HasNonoptionalCPUFeatures()
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)
bool	HasProjectPersistentDownloadDir()	Return true if the PersistentDownloadDir is available.
bool	HasSeparateChannelForDebugOutput()	Whether the platform has a separate debug channel to stdout (eg. OutputDebugString on Windows).
bool	HasVariableHardware()	Returns whether the platform has variable hardware (configurable/upgradeable system).
void	HidePlatformStartupScreen()
void	InitTaggedStorage ( uint32 NumTags )	Platform specific function for initializing storage of tagged memory buffers
bool	Is64bitOperatingSystem()	Detects whether we're running in a 64-bit operating system.
bool	IsDebuggerPresent()	Return true if a debugger is present
bool	IsEnsureAllowed()	Allows disabling ensure()s without rebuilding the binary, by either a commandline switch or a hotfix.
bool	IsInLowPowerMode()
bool	IsLocalPrintThreadSafe()	Whether LocalPrint can be called from any thread without overlapping
bool	IsPackagedForDistribution()
bool	IsRegisteredForRemoteNotifications()	Returns whether or not the device has been registered to receive remote notifications.
bool	IsRemoteSession()	Check to see if the platform is being viewed remotely.
bool	IsRunningOnBattery()	Returns whether the platform is running on battery power or not.
bool	IsStandaloneStereoOnlyDevice()	Returns whether this is a 'stereo only' platform.
bool	IsValidAbsolutePathFormat ( const FString& Path )	Checks structure of the path against platform formatting requirements
const TCHAR ...	LaunchDir()	Get the directory the application was launched from (useful for commandline utilities)
FString	LoadTextFileFromPlatformPackage ( const FString& RelativePath )	Loads a text file relative to the package root on platforms that distribute apps in package formats.
void	LocalPrint ( const TCHAR* Str )	Prints string to the default output
void	LowLevelOutputDebugString ( const TCHAR* Message )	Sends a message to a remote tool, and debugger consoles
void	LowLevelOutputDebugStringf ( const TCHAR* Format, ... )	Sends a message to a remote tool, and debugger consoles
void	MemoryBarrier()	Enforces strict memory load/store ordering across the memory barrier call.
EAppReturnTy...	MessageBoxExt ( EAppMsgType::Type MsgType, const TCHAR* Text, const TCHAR* Caption )	Show a message box if possible, otherwise print a message and return the default
bool	NeedsNonoptionalCPUFeaturesCheck()
void	NormalizePath ( FString& InPath )	Platform-specific normalization of path E.g.
int32	NumberOfCores()	Return the number of hardware CPU cores
int32	NumberOfCoresIncludingHyperthreads()	Return the number of logical CPU cores
int32	NumberOfIOWorkerThreadsToSpawn()	Return the number of worker threads we should spawn to service IO, NOT based on number of cores
int32	NumberOfWorkerThreadsToSpawn()	Return the number of worker threads we should spawn, based on number of cores
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)
void	ParseChunkIdPakchunkIndexMapping ( TArray< FString > ChunkIndexRedirec..., TMap< int32, int32 >& OutMapping )
void	PlatformHandleSplashScreen ( bool ShowSplashScreen )	Called to dismiss splash screen
void	PlatformInit()
void	PlatformPreInit()	Called during appInit() after cmd line setup
void	PlatformTearDown()	Called during AppExit(). Log, Config still exist at this point, but not much else does.
void	Prefetch ( void const* x, int32 offset )	Platform-specific instruction prefetch
void	PrefetchBlock ( const void* InPtr, int32 NumBytes )
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
const TCHAR ...	ProjectDir()	Return the project directory
void	PromptForRemoteDebugging ( bool bIsEnsure )
void	PumpMessagesForSlowTask()
void	PumpMessagesOutsideMainLoop()
void	RaiseException ( uint32 ExceptionCode )
void	RegisterForRemoteNotifications()	Requests permission to send remote notifications to the user's device.
void	ReleaseMobileHaptics()	For mobile devices, this will shutdown the haptics, allowing system to put it to reset as needed
bool	RequestDeviceCheckToken ( TFunction< void< uint8..., TFunction< void&, co... )
void	RequestExit ( bool Force )	Requests application exit.
void	RequestExitWithStatus ( bool Force, uint8 ReturnCode )	Requests application exit with a specified return code.
void	ResetBrightness()
bool	RestartApplication()	Requests application to restart
const TCHAR ...	RootDir()	Get the application root directory.
void	SetBrightness ( float bBright )
void	SetCrashHandler ( void... )	Installs handler for the unexpected (due to error) termination of the program, including, but not limited to, crashes.
void	SetEnvironmentVar ( const TCHAR* VariableName, const TCHAR* Value )	Sets an environment variable to the local process's environment
bool	SetEpicAccountId ( const FString& AccountId )	Set the Epic account ID for the user who last used the Launcher
void	SetGracefulTerminationHandler()	Set/restore the Console Interrupt (Control-C, Control-Break, Close) handler.
void	SetLastError ( uint32 ErrorCode )
void	SetMemoryWarningHandler ( void... )	Set a handler to be called when there is a memory warning from the OS
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)
void	SetShouldPromptForRemoteDebugging ( bool bInShouldPrompt )
void	SetShouldPromptForRemoteDebugOnEnsure ( bool bInShouldPrompt )
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
bool	SetStoredValues ( const FString& InStoreId, const FString& InSectionName, const TMap< FString, FString >& In... )	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
void	SetUBTTargetName ( const TCHAR* InTargetName )
void	SetUTF8Output()	Sets the default output to UTF8
void	SetVolumeButtonsHandledBySystem ( bool enabled )	Set whether the volume buttons are handled by the system
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
bool	ShouldDisablePluginAtRuntime ( const FString& PluginName )	Allows platform at runtime to disable unsupported plugins
bool	ShouldDisplayTouchInterfaceOnFakingTouchEvents()
void	ShutdownTaggedStorage()	Platform specific function for freeing storage of tagged memory buffers
void	SubmitErrorReport ( const TCHAR* InErrorHist, EErrorReportMode::Type InMode )	#CrashReport: 2015-02-24 Remove
bool	SupportsBrightness()
bool	SupportsDeviceCheckToken()
bool	SupportsForceTouchInput()
bool	SupportsFullCrashDumps()	Platform can generate a full-memory crashdump during crash handling.
bool	SupportsLocalCaching()
bool	SupportsMessaging()
bool	SupportsTouchInput()
void	TagBuffer ( const char* Label, uint32 Category, const void* Buffer, size_t BufferSize )	Platform specific function for tagging a memory buffer with a label.
void	TearDown()	Frees any memory retained by FGenericPlatformMisc.
void	TickHotfixables()	Ticks values that can be hotfixable in the config.
void	TriggerMobileHaptics()	For mobile devices, this will kick the haptic type that was set in PrepareMobileHaptics.
void	UnregisterForRemoteNotifications()	Requests unregistering from receiving remote notifications on the user's device.
void	UpdateHotfixableEnsureSettings()	Updates hotfixable ensure settings from config and commandline (config takes priority).
bool	UseHDRByDefault()
bool	UseRenderThread()	Checks if platform wants to use a rendering thread on current device

Classes

	Name	Description
	FStaticData

Constants

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

Deprecated Functions

	Name	Description
void	ClipboardCopy ( const TCHAR* Str )	FPlatformMisc::ClipboardCopy() has been superseded by FPlatformApplicationMisc::ClipboardCopy()
void	ClipboardPaste ( FString& Dest )	FPlatformMisc::ClipboardPaste() has been superseded by FPlatformApplicationMisc::ClipboardPaste()
void	DebugBreak()	FPlatformMisc::DebugBreak is deprecated. Use the UE_DEBUG_BREAK() macro instead.
void	GetEnvironmentVariable ( const TCHAR* VariableName, TCHAR* Result, int32 ResultLength )	void FPlatformMisc::GetEnvironmentVariable(Name, Result, Length) is deprecated. Use FString FPlatformMisc::GetEnvironmentVariable(Name) instead.
FString	GetHashedMacAddressString()	GetHasedMacAddressString is deprecated. It is not reliable on all platforms
TArray< uint...	GetMacAddress()	GetMacAddress is deprecated. It is not reliable on all platforms
FString	GetMacAddressString()	GetMacAddressString is deprecated. It is not reliable on all platforms
FGuid	GetMachineId()	GetMachineId is deprecated. Use GetLoginId instead.
FString	GetUniqueDeviceId()	GetUniqueDeviceId is deprecated. Use GetDeviceId instead.
void	SetOverrideGameDir ( const FString& InOverrideDir )	FPaths::SetOverrideGameDir() has been superseded by FPaths::SetOverrideProjectDir().

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss