#include <GenericPlatformMisc.h>

Inheritance diagram for FGenericPlatformMisc:

Public Member Functions
	UE_DEPRECATED (4.18, "FPlatformMisc::ClipboardCopy() has been superseded by FPlatformApplicationMisc::ClipboardCopy()") static void ClipboardCopy(const TCHAR *Str)

	UE_DEPRECATED (4.18, "FPlatformMisc::ClipboardPaste() has been superseded by FPlatformApplicationMisc::ClipboardPaste()") static void ClipboardPaste(class FString &Dest)

	UE_DEPRECATED (4.18, "FPaths::SetOverrideGameDir() has been superseded by FPaths::SetOverrideProjectDir().") static FORCEINLINE void SetOverrideGameDir(const FString &InOverrideDir)

Static Public Member Functions
static void	PlatformPreInit ()

static void	PlatformInit ()

static void	PlatformHandleSplashScreen (bool ShowSplashScreen=false)

static void	PlatformTearDown ()

static void	SetGracefulTerminationHandler ()

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

static ECrashHandlingType	GetCrashHandlingType ()

static ECrashHandlingType	SetCrashHandlingType (ECrashHandlingType Type)

static FString	GetEnvironmentVariable (const TCHAR *VariableName)

static void	SetEnvironmentVar (const TCHAR VariableName, const TCHAR Value)

static FORCEINLINE int32	GetMaxPathLength ()

static const TCHAR *	GetPathVarDelimiter ()

static TArray< uint8 >	GetMacAddress ()

static FString	GetMacAddressString ()

static FString	GetHashedMacAddressString ()

static FString	GetDeviceId ()

static FString	GetUniqueAdvertisingId ()

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

static bool	IsRemoteSession ()

static FORCEINLINE bool	IsDebuggerPresent ()

static EProcessDiagnosticFlags	GetProcessDiagnostics ()

static FORCEINLINE void	DebugBreak ()

static FString	GetCPUVendor ()

static uint32	GetCPUInfo ()

static bool	HasNonoptionalCPUFeatures ()

static bool	NeedsNonoptionalCPUFeaturesCheck ()

static FString	GetCPUBrand ()

static FString	GetCPUChipset ()

static FString	GetPrimaryGPUBrand ()

static FString	GetDeviceMakeAndModel ()

static struct FGPUDriverInfo	GetGPUDriverInfo (const FString &DeviceDescription)

static void	GetOSVersions (FString &out_OSVersionLabel, FString &out_OSSubVersionLabel)

static FString	GetOSVersion ()

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

static bool	GetPageFaultStats (FPageFaultStats &OutStats, EPageFaultFlags Flags=EPageFaultFlags::All)

static bool	GetBlockingIOStats (FProcessIOStats &OutStats, EInputOutputFlags Flags=EInputOutputFlags::All)

static bool	GetContextSwitchStats (FContextSwitchStats &OutStats, EContextSwitchFlags Flags=EContextSwitchFlags::All)

static bool	SupportsMessaging ()

static bool	IsCacheStorageAvailable ()

static bool	SupportsLocalCaching ()

static bool	AllowLocalCaching ()

static bool	SupportsFullCrashDumps ()

static FORCENOINLINE void	MemoryBarrier ()

static void	SetMemoryWarningHandler (void(*Handler)(const FGenericMemoryWarningContext &Context))

static bool	HasMemoryWarningHandler ()

static FORCEINLINE uint32	GetLastError ()

static void	SetLastError (uint32 ErrorCode)

static void	RaiseException (uint32 ExceptionCode)

static void	BeginNamedEvent (const struct FColor &Color, const TCHAR *Text)

static void	BeginNamedEvent (const struct FColor &Color, const ANSICHAR *Text)

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

static void	TickStatNamedEvents ()

static void	LogNameEventStatsInit ()

static void	EndNamedEvent ()

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

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

static void	BeginProfilerColor (const struct FColor &Color)

static void	EndProfilerColor ()

static void	BeginEnterBackgroundEvent (const TCHAR *Text)

static void	EndEnterBackgroundEvent ()

static FORCEINLINE void	BeginNamedEventFrame ()

static FORCEINLINE void	InitTaggedStorage (uint32 NumTags)

static FORCEINLINE void	ShutdownTaggedStorage ()

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

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

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

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

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

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

static void	LowLevelOutputDebugString (const TCHAR *Message)

static void VARARGS	LowLevelOutputDebugStringf (const TCHAR *Format,...)

static bool	IsLowLevelOutputDebugStringStructured ()

static void	SetUTF8Output ()

static void	LocalPrint (const TCHAR *Str)

static bool	IsLocalPrintThreadSafe ()

static bool	HasSeparateChannelForDebugOutput ()

static void	RequestExit (bool Force)

static void	RequestExitWithStatus (bool Force, uint8 ReturnCode)

static bool	RestartApplication ()

static bool	RestartApplicationWithCmdLine (const char *CmdLine)

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

static void	CreateGuid (struct FGuid &Result)

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

static bool	CommandLineCommands ()

static FORCEINLINE bool	Is64bitOperatingSystem ()

static bool	IsValidAbsolutePathFormat (const FString &Path)

static void	NormalizePath (FString &InPath)

static void	NormalizePath (FStringBuilderBase &InPath)

static const TCHAR *	GetDefaultPathSeparator ()

static bool	UseRenderThread ()

static bool	AllowAudioThread ()

static bool	AllowThreadHeartBeat ()

static int32	NumberOfCores ()

static const FProcessorGroupDesc &	GetProcessorGroupDesc ()

static int32	NumberOfCoresIncludingHyperthreads ()

static int32	NumberOfWorkerThreadsToSpawn ()

static int32	NumberOfIOWorkerThreadsToSpawn ()

static struct FAsyncIOSystemBase *	GetPlatformSpecificAsyncIOSystem ()

static const TCHAR *	GetPlatformFeaturesModuleName ()

static const TCHAR *	RootDir ()

static TArray< FString >	GetAdditionalRootDirectories ()

static void	AddAdditionalRootDirectory (const FString &RootDir)

static const TCHAR *	EngineDir ()

static const TCHAR *	LaunchDir ()

static void	CacheLaunchDir ()

static const TCHAR *	ProjectDir ()

static FString	CloudDir ()

static bool	HasProjectPersistentDownloadDir ()

static bool	CheckPersistentDownloadStorageSpaceAvailable (uint64 BytesRequired, bool bAttemptToUseUI)

static const TCHAR *	GamePersistentDownloadDir ()

static const TCHAR *	GameTemporaryDownloadDir ()

static const TCHAR *	GeneratedConfigDir ()

static const TCHAR *	GetUBTPlatform ()

static const TCHAR *	GetUBTTarget ()

static void	SetUBTTargetName (const TCHAR *InTargetName)

static const TCHAR *	GetUBTTargetName ()

static const TCHAR *	GetNullRHIShaderFormat ()

static IPlatformChunkInstall *	GetPlatformChunkInstall ()

static IPlatformCompression *	GetPlatformCompression ()

static IPlatformHostCommunication &	GetPlatformHostCommunication ()

static bool	OsExecute (const TCHAR CommandType, const TCHAR Command, const TCHAR *CommandLine=NULL)

static bool	IsPackagedForDistribution ()

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

static FString	GetDefaultLanguage ()

static FString	GetDefaultLocale ()

static FString	GetTimeZoneId ()

static bool	Exec (struct UWorld InWorld, const TCHAR Cmd, FOutputDevice &Out)

static FText	GetFileManagerName ()

static bool	SupportsMultithreadedFileHandles ()

static void	SetShouldPromptForRemoteDebugging (bool bInShouldPrompt)

static void	SetShouldPromptForRemoteDebugOnEnsure (bool bInShouldPrompt)

static bool	IsEnsureAllowed ()

static void	UpdateHotfixableEnsureSettings ()

static void	TickHotfixables ()

static void	PromptForRemoteDebugging (bool bIsEnsure)

static FORCEINLINE void	Prefetch (const void *Ptr)

static FORCEINLINE void	Prefetch (const void *Ptr, int32 Offset)

static FORCEINLINE void	PrefetchBlock (const void *Ptr)

static FORCEINLINE void	PrefetchBlock (const void *Ptr, int32 NumBytes)

static const TCHAR *	GetDefaultDeviceProfileName ()

static FORCEINLINE int	GetBatteryLevel ()

static FORCEINLINE void	SetBrightness (float bBright)

static FORCEINLINE float	GetBrightness ()

static FORCEINLINE bool	SupportsBrightness ()

static FORCEINLINE bool	IsInLowPowerMode ()

static float	GetDeviceTemperatureLevel ()

static void	SetOverrideProjectDir (const FString &InOverrideDir)

static void	GetValidTargetPlatforms (TArray< FString > &TargetPlatformNames)

static FPlatformUserId	GetPlatformUserForUserIndex (int32 LocalUserIndex)

static int32	GetUserIndexForPlatformUser (FPlatformUserId PlatformUser)

static bool	GetUseVirtualJoysticks ()

static bool	SupportsTouchInput ()

static bool	SupportsForceTouchInput ()

static bool	ShouldDisplayTouchInterfaceOnFakingTouchEvents ()

static bool	DesktopTouchScreen ()

static bool	FullscreenSameAsWindowedFullscreen ()

static bool	GetVolumeButtonsHandledBySystem ()

static void	SetVolumeButtonsHandledBySystem (bool enabled)

static TArray< uint8 >	GetSystemFontBytes ()

static bool	HasActiveWiFiConnection ()

static ENetworkConnectionStatus	GetNetworkConnectionStatus ()

static void	SetNetworkConnectionStatus (ENetworkConnectionStatus NewNetworkConnectionStatus)

static ENetworkConnectionType	GetNetworkConnectionType ()

static bool	HasVariableHardware ()

static bool	HasPlatformFeature (const TCHAR *FeatureName)

static bool	IsRunningOnBattery ()

static EDeviceScreenOrientation	GetDeviceOrientation ()

static void	SetDeviceOrientation (EDeviceScreenOrientation NewDeviceOrientation)

static EDeviceScreenOrientation	GetAllowedDeviceOrientation ()

static void	SetAllowedDeviceOrientation (EDeviceScreenOrientation NewAllowedDeviceOrientation)

static int32	GetDeviceVolume ()

static FGuid	GetMachineId ()

static FString	GetLoginId ()

static FString	GetEpicAccountId ()

static FString	GetOperatingSystemId ()

static EConvertibleLaptopMode	GetConvertibleLaptopMode ()

static const TCHAR *	GetEngineMode ()

static TArray< FString >	GetPreferredLanguages ()

static FString	GetLocalCurrencyCode ()

static FString	GetLocalCurrencySymbol ()

static void	RegisterForRemoteNotifications ()

static bool	IsRegisteredForRemoteNotifications ()

static void	UnregisterForRemoteNotifications ()

static bool	ShouldDisablePluginAtRuntime (const FString &PluginName)

static void	PrepareMobileHaptics (EMobileHapticsType Type)

static void	TriggerMobileHaptics ()

static void	ReleaseMobileHaptics ()

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

static bool	SupportsDeviceCheckToken ()

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

static TArray< FCustomChunk >	GetOnDemandChunksForPakchunkIndices (const TArray< int32 > &PakchunkIndices)

static TArray< FCustomChunk >	GetAllOnDemandChunks ()

static TArray< FCustomChunk >	GetAllLanguageChunks ()

static TArray< FCustomChunk >	GetCustomChunksByType (ECustomChunkType DesiredChunkType)

static FString	LoadTextFileFromPlatformPackage (const FString &RelativePath)

static bool	FileExistsInPlatformPackage (const FString &RelativePath)

static void	TearDown ()

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

static void	PumpMessagesOutsideMainLoop ()

static void	PumpMessagesForSlowTask ()

static void	PumpEssentialAppMessages ()

static void	HidePlatformStartupScreen ()

static FORCEINLINE bool	UseHDRByDefault ()

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

static FORCEINLINE int32	GetChunkIDFromPakchunkIndex (int32 PakchunkIndex)

static int32	GetPakchunkIndexFromPakFile (const FString &InFilename)

static FORCEINLINE bool	Expand16BitIndicesTo32BitOnLoad ()

static FORCEINLINE void	GetNetworkFileCustomData (TMap< FString, FString > &OutCustomPlatformData)

static FORCEINLINE bool	SupportsBackbufferSampling ()

static int32	GetMaxRefreshRate ()

static int32	GetMaxSupportedRefreshRate ()

static int32	GetMaxSyncInterval ()

static bool	IsPGOEnabled ()

static void	ShowConsoleWindow ()

static int	GetMobilePropagateAlphaSetting ()

static bool	IsRunningInCloud ()

static void	DisableScreenTimeout ()

static void	EnableScreenTimeout ()

static bool	SetupSyscallFilters ()

static bool	GetPlatformScreenWarnings (TArray< FText > &PlatformScreenWarnings)

Static Protected Member Functions
static void	GetConfiguredCoreLimits (int32 PlatformNumPhysicalCores, int32 PlatformNumLogicalCores, bool &bOutFullyInitialized, int32 &OutPhysicalCoreLimit, int32 &OutLogicalCoreLimit, bool &bOutSetPhysicalCountToLogicalCount)

Static Protected Attributes
static bool	bShouldPromptForRemoteDebugging

static bool	bPromptForRemoteDebugOnEnsure

static EDeviceScreenOrientation	AllowedDeviceOrientation

static ENetworkConnectionStatus	CurrentNetworkConnectionStatus

Detailed Description

Generic implementation for most platforms

Definition at line 535 of file GenericPlatformMisc.h.

Member Function Documentation

◆ AddAdditionalRootDirectory()

static void FGenericPlatformMisc::AddAdditionalRootDirectory ( const FString & RootDir )

static

add an additional root directory

◆ AllowAudioThread()

static bool FGenericPlatformMisc::AllowAudioThread ( )

inlinestatic

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)

Returns: true if allowed, false if shouldn't use a separate audio thread

Definition at line 1115 of file GenericPlatformMisc.h.

◆ AllowLocalCaching()

static bool FGenericPlatformMisc::AllowLocalCaching ( )

inlinestatic

Definition at line 808 of file GenericPlatformMisc.h.

◆ AllowThreadHeartBeat()

static bool FGenericPlatformMisc::AllowThreadHeartBeat ( )

static

Checks if platform wants to allow the thread heartbeat hang detection

Returns: true if allows, false if shouldn't allow thread heartbeat hang detection

◆ BeginEnterBackgroundEvent()

static void FGenericPlatformMisc::BeginEnterBackgroundEvent ( const TCHAR * Text )

inlinestatic

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

Definition at line 888 of file GenericPlatformMisc.h.

Here is the caller graph for this function:

◆ BeginNamedEvent() [1/2]

static void FGenericPlatformMisc::BeginNamedEvent	(	const struct FColor &	Color,
		const ANSICHAR *	Text )

static

◆ BeginNamedEvent() [2/2]

static void FGenericPlatformMisc::BeginNamedEvent	(	const struct FColor &	Color,
		const TCHAR *	Text )

static

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

◆ BeginNamedEventFrame()

static FORCEINLINE void FGenericPlatformMisc::BeginNamedEventFrame ( )

inlinestatic

Indicates the start of a frame for named events

Definition at line 893 of file GenericPlatformMisc.h.

◆ BeginProfilerColor()

static void FGenericPlatformMisc::BeginProfilerColor ( const struct FColor & Color )

inlinestatic

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

Definition at line 882 of file GenericPlatformMisc.h.

◆ CacheLaunchDir()

static void FGenericPlatformMisc::CacheLaunchDir ( )

static

Function to store the current working directory for use with LaunchDir()

◆ CheckPersistentDownloadStorageSpaceAvailable()

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

static

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

◆ ChooseHDRDeviceAndColorGamut()

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

inlinestatic

Definition at line 1803 of file GenericPlatformMisc.h.

◆ CloudDir()

static FString FGenericPlatformMisc::CloudDir ( )

static

Return the CloudDir. CloudDir can be per-user.

◆ CommandLineCommands()

static bool FGenericPlatformMisc::CommandLineCommands ( )

inlinestatic

Handles Game Explorer, Firewall and FirstInstall commands, typically from the installer

Returns: false if the game cannot continue.

Definition at line 1057 of file GenericPlatformMisc.h.

◆ CreateGuid()

static void FGenericPlatformMisc::CreateGuid ( struct FGuid & Result )

static

Create a new globally unique identifier.

◆ CustomNamedStat() [1/2]

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

inlinestatic

Definition at line 877 of file GenericPlatformMisc.h.

◆ CustomNamedStat() [2/2]

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

inlinestatic

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

Definition at line 876 of file GenericPlatformMisc.h.

◆ DebugBreak()

static FORCEINLINE void FGenericPlatformMisc::DebugBreak ( )

inlinestatic

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

Definition at line 675 of file GenericPlatformMisc.h.

Here is the call graph for this function:

◆ DeleteStoredSection()

static bool FGenericPlatformMisc::DeleteStoredSection	(	const FString &	InStoreId,
		const FString &	InSectionName )

static

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

Parameters

InStoreId	The name used to identify the store you want to use (eg, MyGame)
InSectionName	The section to delete.

Returns: bool true if the section was deleted, false if not found or couldn't delete

◆ DeleteStoredValue()

static bool FGenericPlatformMisc::DeleteStoredValue	(	const FString &	InStoreId,
		const FString &	InSectionName,
		const FString &	InKeyName )

static

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

Parameters

InStoreId	The name used to identify the store you want to use (eg, MyGame)
InSectionName	The section that this key->value pair is placed within (can contain / separators, eg UserDetails/AccountInfo)
InKeyName	The name of the key to set the value for

Returns: bool true if the value was deleted correctly, false if not found or couldn't delete

◆ DesktopTouchScreen()

static bool FGenericPlatformMisc::DesktopTouchScreen ( )

inlinestatic

Definition at line 1504 of file GenericPlatformMisc.h.

◆ DisableScreenTimeout()

static void FGenericPlatformMisc::DisableScreenTimeout ( )

inlinestatic

Definition at line 1876 of file GenericPlatformMisc.h.

◆ EnableScreenTimeout()

static void FGenericPlatformMisc::EnableScreenTimeout ( )

inlinestatic

Definition at line 1880 of file GenericPlatformMisc.h.

◆ EndEnterBackgroundEvent()

static void FGenericPlatformMisc::EndEnterBackgroundEvent ( )

inlinestatic

Definition at line 889 of file GenericPlatformMisc.h.

Here is the caller graph for this function:

◆ EndNamedEvent()

static void FGenericPlatformMisc::EndNamedEvent ( )

static

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

◆ EndProfilerColor()

static void FGenericPlatformMisc::EndProfilerColor ( )

inlinestatic

Definition at line 883 of file GenericPlatformMisc.h.

◆ EngineDir()

static const TCHAR * FGenericPlatformMisc::EngineDir ( )

static

Get the engine directory

◆ Exec()

static bool FGenericPlatformMisc::Exec	(	struct UWorld *	InWorld,
		const TCHAR *	Cmd,
		FOutputDevice &	Out )

inlinestatic

Platform-specific Exec function

Parameters

InWorld	World context
Cmd	The command to execute
Out	The output device to utilize

Returns: bool true if command was processed, false if not

Definition at line 1330 of file GenericPlatformMisc.h.

◆ Expand16BitIndicesTo32BitOnLoad()

static FORCEINLINE bool FGenericPlatformMisc::Expand16BitIndicesTo32BitOnLoad ( )

inlinestatic

Definition at line 1814 of file GenericPlatformMisc.h.

◆ FileExistsInPlatformPackage()

static bool FGenericPlatformMisc::FileExistsInPlatformPackage ( const FString & RelativePath )

static

◆ FullscreenSameAsWindowedFullscreen()

static bool FGenericPlatformMisc::FullscreenSameAsWindowedFullscreen ( )

inlinestatic

Definition at line 1513 of file GenericPlatformMisc.h.

◆ GamePersistentDownloadDir()

static const TCHAR * FGenericPlatformMisc::GamePersistentDownloadDir ( )

static

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

◆ GameTemporaryDownloadDir()

static const TCHAR * FGenericPlatformMisc::GameTemporaryDownloadDir ( )

static

Return the temporary directory

◆ GeneratedConfigDir()

static const TCHAR * FGenericPlatformMisc::GeneratedConfigDir ( )

static

◆ GetAdditionalRootDirectories()

static TArray< FString > FGenericPlatformMisc::GetAdditionalRootDirectories ( )

static

get additional directories which can be considered as root directories

◆ GetAllLanguageChunks()

static TArray< FCustomChunk > FGenericPlatformMisc::GetAllLanguageChunks ( )

static

◆ GetAllOnDemandChunks()

static TArray< FCustomChunk > FGenericPlatformMisc::GetAllOnDemandChunks ( )

static

◆ GetAllowedDeviceOrientation()

static EDeviceScreenOrientation FGenericPlatformMisc::GetAllowedDeviceOrientation ( )

static

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

Returns: An EDeviceScreenOrientation value.

◆ GetBatteryLevel()

static FORCEINLINE int FGenericPlatformMisc::GetBatteryLevel ( )

inlinestatic

Gets the current battery level.

Returns: the battery level between 0 and 100.

Definition at line 1432 of file GenericPlatformMisc.h.

◆ GetBlockingIOStats()

static bool FGenericPlatformMisc::GetBlockingIOStats	(	FProcessIOStats &	OutStats,
		EInputOutputFlags	Flags = EInputOutputFlags::All )

inlinestatic

Gets Blocking Input/Output stats covering the lifetime of the process

Parameters

OutStats	Outputs the IO stats
Flags	The type of IO stats to retrieve

Returns: Whether or not stats were successfully retrieved

Definition at line 771 of file GenericPlatformMisc.h.

◆ GetBrightness()

static FORCEINLINE float FGenericPlatformMisc::GetBrightness ( )

inlinestatic

Definition at line 1438 of file GenericPlatformMisc.h.

◆ GetChunkIDFromPakchunkIndex()

static FORCEINLINE int32 FGenericPlatformMisc::GetChunkIDFromPakchunkIndex ( int32 PakchunkIndex )

inlinestatic

Definition at line 1807 of file GenericPlatformMisc.h.

◆ GetConfiguredCoreLimits()

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

staticprotected

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

Parameters

bOutFullyInitialized	True if commandline was available. If false, values are set to defaults.
OutPhysicalCoreLimit	The maximum number of physical cores to report in NumberOfCores. Non-negative. 0 indicates unlimited.
OutLogicalCoreLimit	The maximum number of logical cores to report in NumberOfCoresIncludingHyperthreads. Non-negative. 0 indicates unlimited.
bOutSetPhysicalCountToLogicalCount	Whether NumberOfCores should be overridden to return NumberOfCoresIncludingHyperthreads.

◆ GetContextSwitchStats()

static bool FGenericPlatformMisc::GetContextSwitchStats	(	FContextSwitchStats &	OutStats,
		EContextSwitchFlags	Flags = EContextSwitchFlags::All )

inlinestatic

Gets Context Switch stats covering the lifetime of the process

Parameters

OutStats	Outputs the Context Switch stats
Flags	The type of Context Switch stats to retrieve

Returns: Whether or not stats were successfully retrieved

Definition at line 783 of file GenericPlatformMisc.h.

◆ GetConvertibleLaptopMode()

static EConvertibleLaptopMode FGenericPlatformMisc::GetConvertibleLaptopMode ( )

static

Gets the current mode of convertible laptops, i.e. Laptop or Tablet.

Returns: The laptop mode, or Unknown if not known, or NotSupported if not a convertible laptop.

◆ GetCPUBrand()

static FString FGenericPlatformMisc::GetCPUBrand ( )

static

Uses cpuid instruction to get the CPU brand string

Returns: CPU brand string

◆ GetCPUChipset()

static FString FGenericPlatformMisc::GetCPUChipset ( )

static

Returns the CPU chipset if known

Returns: CPU chipset string (or "Unknown")

◆ GetCPUInfo()

static uint32 FGenericPlatformMisc::GetCPUInfo ( )

static

On x86(-64) platforms, uses cpuid instruction to get the CPU signature

Returns

CPU info bitfield

    Bits 0-3    Stepping ID
    Bits 4-7    Model
    Bits 8-11   Family
    Bits 12-13  Processor type (Intel) / Reserved (AMD)
    Bits 14-15  Reserved
    Bits 16-19  Extended model
    Bits 20-27  Extended family
    Bits 28-31  Reserved

◆ GetCPUVendor()

static FString FGenericPlatformMisc::GetCPUVendor ( )

static

Uses cpuid instruction to get the vendor string

Returns: CPU vendor name

◆ GetCrashHandlingType()

static ECrashHandlingType FGenericPlatformMisc::GetCrashHandlingType ( )

inlinestatic

Gets the current crash handling type.

Definition at line 565 of file GenericPlatformMisc.h.

◆ GetCustomChunksByType()

static TArray< FCustomChunk > FGenericPlatformMisc::GetCustomChunksByType ( ECustomChunkType DesiredChunkType )

static

◆ GetDefaultDeviceProfileName()

static const TCHAR * FGenericPlatformMisc::GetDefaultDeviceProfileName ( )

static

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

Returns: the default profile name.

◆ GetDefaultLanguage()

static FString FGenericPlatformMisc::GetDefaultLanguage ( )

static

Get the default language (for localization) used by this platform.

Note

This is typically the same as GetDefaultLocale unless the platform distinguishes between the two.

This should be returned in IETF language tag form:

A two-letter ISO 639-1 language code (eg, "zh").
An optional four-letter ISO 15924 script code (eg, "Hans").
An optional two-letter ISO 3166-1 country code (eg, "CN").

◆ GetDefaultLocale()

static FString FGenericPlatformMisc::GetDefaultLocale ( )

static

Get the default locale (for internationalization) used by this platform.

Note

This should be returned in IETF language tag form:

A two-letter ISO 639-1 language code (eg, "zh").
An optional four-letter ISO 15924 script code (eg, "Hans").
An optional two-letter ISO 3166-1 country code (eg, "CN").

◆ GetDefaultPathSeparator()

static const TCHAR * FGenericPlatformMisc::GetDefaultPathSeparator ( )

static

Returns: platform specific path separator.

◆ GetDeviceId()

static FString FGenericPlatformMisc::GetDeviceId ( )

static

Returns a unique string for device identification. Differs from the deprecated GetUniqueDeviceId in that there is no default implementation (which used unreliable Mac address determiniation). This code is expected to use platform-specific methods to identify the device.

WARNING: Use of this method in your app may imply technical certification requirments for your platform! For instance, consoles often require cert waivers to be in place before calling APIs that can track a device, so be very careful that you are following your platform's protocols for accessing device IDs. See the platform- specific implementations of this method for details on what APIs are used.

If you do not have permission to call this on one or more of your platforms, set GET_DEVICE_ID_UNAVAILABLE=1 in your build step to ensure that any calls that may be made to this API will simply return an empty string.

Returns: the unique string generated by this platform for this device, or an empty string if one is not available.

◆ GetDeviceMakeAndModel()

static FString FGenericPlatformMisc::GetDeviceMakeAndModel ( )

static

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

◆ GetDeviceOrientation()

static EDeviceScreenOrientation FGenericPlatformMisc::GetDeviceOrientation ( )

static

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

Returns: An EDeviceScreenOrientation value.

◆ GetDeviceTemperatureLevel()

static float FGenericPlatformMisc::GetDeviceTemperatureLevel ( )

static

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

◆ GetDeviceVolume()

static int32 FGenericPlatformMisc::GetDeviceVolume ( )

static

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

◆ GetDiskTotalAndFreeSpace()

static bool FGenericPlatformMisc::GetDiskTotalAndFreeSpace	(	const FString &	InPath,
		uint64 &	TotalNumberOfBytes,
		uint64 &	NumberOfFreeBytes )

static

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

◆ GetEngineMode()

static const TCHAR * FGenericPlatformMisc::GetEngineMode ( )

static

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

◆ GetEnvironmentVariable()

static FString FGenericPlatformMisc::GetEnvironmentVariable ( const TCHAR * VariableName )

static

Retrieve a environment variable from the system

Parameters

VariableName The name of the variable (ie "Path")

Returns: Value of the variable, or an empty string if not set.

◆ GetEpicAccountId()

static FString FGenericPlatformMisc::GetEpicAccountId ( )

static

Get the Epic account ID for the user who last used the Launcher.

Note: This function is for Epic internal use only. Do not use.

Returns: an empty string if the account ID was not present or it failed to read it for any reason.

◆ GetFileManagerName()

static FText FGenericPlatformMisc::GetFileManagerName ( )

static

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

◆ GetGPUDriverInfo()

static struct FGPUDriverInfo FGenericPlatformMisc::GetGPUDriverInfo ( const FString & DeviceDescription )

static

◆ GetHashedMacAddressString()

static FString FGenericPlatformMisc::GetHashedMacAddressString ( )

static

Retrieve the Mac address of the current adapter as a hashed string (privacy). This generally relies on GetMacAddress() being implemented for the platform, if possible.

Returns: String representing the hashed Mac address, or empty string.

◆ GetLastError()

static FORCEINLINE uint32 FGenericPlatformMisc::GetLastError ( )

inlinestatic

Definition at line 845 of file GenericPlatformMisc.h.

◆ GetLocalCurrencyCode()

static FString FGenericPlatformMisc::GetLocalCurrencyCode ( )

static

Returns the currency code associated with the device's locale

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

◆ GetLocalCurrencySymbol()

static FString FGenericPlatformMisc::GetLocalCurrencySymbol ( )

static

Returns the currency symbol associated with the device's locale

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

◆ GetLoginId()

static FString FGenericPlatformMisc::GetLoginId ( )

static

Returns a unique string associated with the login account of the current machine. Implemented using persistent storage like the registry on window (using HKCU), so is susceptible to anything that could reset or revert that storage if the ID is created, which is generally during install or first run of the app.

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

Returns: a string containing the LoginID, or empty if not available.

◆ GetMacAddress()

static TArray< uint8 > FGenericPlatformMisc::GetMacAddress ( )

static

Retrieve the Mac address of the current adapter. This is generally platform-dependent code that other platforms must implement.

Returns: array of bytes representing the Mac address, or empty array if unable to determine.

◆ GetMacAddressString()

static FString FGenericPlatformMisc::GetMacAddressString ( )

static

Retrieve the Mac address of the current adapter as a string. This generally relies on GetMacAddress() being implemented for the platform, if possible.

Returns: String representing the Mac address, or empty string.

◆ GetMachineId()

static FGuid FGenericPlatformMisc::GetMachineId ( )

static

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

◆ GetMaxPathLength()

static FORCEINLINE int32 FGenericPlatformMisc::GetMaxPathLength ( )

inlinestatic

Returns the maximum length of a path

Definition at line 592 of file GenericPlatformMisc.h.

◆ GetMaxRefreshRate()

static int32 FGenericPlatformMisc::GetMaxRefreshRate ( )

inlinestatic

retrieves the current maximum refresh rate supported by the platform

Definition at line 1834 of file GenericPlatformMisc.h.

Here is the caller graph for this function:

◆ GetMaxSupportedRefreshRate()

static int32 FGenericPlatformMisc::GetMaxSupportedRefreshRate ( )

inlinestatic

retrieves the maximum refresh rate supported by the platform

Definition at line 1842 of file GenericPlatformMisc.h.

Here is the call graph for this function:

◆ GetMaxSyncInterval()

static int32 FGenericPlatformMisc::GetMaxSyncInterval ( )

inlinestatic

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

Definition at line 1850 of file GenericPlatformMisc.h.

◆ GetMobilePropagateAlphaSetting()

static int FGenericPlatformMisc::GetMobilePropagateAlphaSetting ( )

static

◆ GetNetworkConnectionStatus()

static ENetworkConnectionStatus FGenericPlatformMisc::GetNetworkConnectionStatus ( )

static

Returns the current status for the network connection

◆ GetNetworkConnectionType()

static ENetworkConnectionType FGenericPlatformMisc::GetNetworkConnectionType ( )

inlinestatic

Returns whether WiFi connection is currently active

Definition at line 1559 of file GenericPlatformMisc.h.

◆ GetNetworkFileCustomData()

static FORCEINLINE void FGenericPlatformMisc::GetNetworkFileCustomData ( TMap< FString, FString > & OutCustomPlatformData )

inlinestatic

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

Definition at line 1822 of file GenericPlatformMisc.h.

◆ GetNullRHIShaderFormat()

static const TCHAR * FGenericPlatformMisc::GetNullRHIShaderFormat ( )

static

Determines the shader format for the platform

Returns: Returns the shader format to be used by that platform

◆ GetOnDemandChunksForPakchunkIndices()

static TArray< FCustomChunk > FGenericPlatformMisc::GetOnDemandChunksForPakchunkIndices ( const TArray< int32 > & PakchunkIndices )

static

◆ GetOperatingSystemId()

static FString FGenericPlatformMisc::GetOperatingSystemId ( )

static

Gets a globally unique ID the represents a particular operating system install.

Returns: an opaque string representing the ID, or an empty string if the platform doesn't support one.

◆ GetOSVersion()

static FString FGenericPlatformMisc::GetOSVersion ( )

static

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

◆ GetOSVersions()

static void FGenericPlatformMisc::GetOSVersions	(	FString &	out_OSVersionLabel,
		FString &	out_OSSubVersionLabel )

static

Gets the OS Version and OS Subversion.

◆ GetPageFaultStats()

static bool FGenericPlatformMisc::GetPageFaultStats	(	FPageFaultStats &	OutStats,
		EPageFaultFlags	Flags = EPageFaultFlags::All )

inlinestatic

Gets Page Fault stats covering the lifetime of the process

Parameters

OutStats	Outputs the page fault stats
Flags	The type of page fault stats to retrieve

Returns: Whether or not stats were successfully retrieved

Definition at line 759 of file GenericPlatformMisc.h.

◆ GetPakchunkIndexFromPakFile()

static int32 FGenericPlatformMisc::GetPakchunkIndexFromPakFile ( const FString & InFilename )

static

◆ GetPathVarDelimiter()

static const TCHAR * FGenericPlatformMisc::GetPathVarDelimiter ( )

static

return the delimiter between paths in the PATH environment variable.

◆ GetPlatformChunkInstall()

static IPlatformChunkInstall * FGenericPlatformMisc::GetPlatformChunkInstall ( )

static

Returns the platform specific chunk based install interface

Returns: Returns the platform specific chunk based install implementation

◆ GetPlatformCompression()

static IPlatformCompression * FGenericPlatformMisc::GetPlatformCompression ( )

static

Returns the platform specific compression interface

Returns: Returns the platform specific compression interface

◆ GetPlatformFeaturesModuleName()

static const TCHAR * FGenericPlatformMisc::GetPlatformFeaturesModuleName ( )

inlinestatic

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

Definition at line 1162 of file GenericPlatformMisc.h.

◆ GetPlatformHostCommunication()

static IPlatformHostCommunication & FGenericPlatformMisc::GetPlatformHostCommunication ( )

static

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

Returns: Returns the platform specific host communication interface.

◆ GetPlatformScreenWarnings()

static bool FGenericPlatformMisc::GetPlatformScreenWarnings ( TArray< FText > & PlatformScreenWarnings )

inlinestatic

Returns any platform specific warning messages we want printed on screen

Definition at line 1896 of file GenericPlatformMisc.h.

◆ GetPlatformSpecificAsyncIOSystem()

static struct FAsyncIOSystemBase * FGenericPlatformMisc::GetPlatformSpecificAsyncIOSystem ( )

inlinestatic

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

Definition at line 1156 of file GenericPlatformMisc.h.

◆ GetPlatformUserForUserIndex()

static FPlatformUserId FGenericPlatformMisc::GetPlatformUserForUserIndex ( int32 LocalUserIndex )

static

◆ GetPreferredLanguages()

static TArray< FString > FGenericPlatformMisc::GetPreferredLanguages ( )

static

Returns an array of the user's preferred languages in order of preference

Returns: An array of language IDs ordered from most preferred to least

◆ GetPrimaryGPUBrand()

static FString FGenericPlatformMisc::GetPrimaryGPUBrand ( )

static

Returns: primary GPU brand string

◆ GetProcessDiagnostics()

static EProcessDiagnosticFlags FGenericPlatformMisc::GetProcessDiagnostics ( )

static

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

◆ GetProcessorGroupDesc()

static const FProcessorGroupDesc & FGenericPlatformMisc::GetProcessorGroupDesc ( )

static

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

◆ GetSHA256Signature()

static bool FGenericPlatformMisc::GetSHA256Signature	(	const void *	Data,
		uint32	ByteSize,
		FSHA256Signature &	OutSignature )

static

Generates the SHA256 signature of the given data.

Parameters

Data	Pointer to the beginning of the data to hash
Bytesize	Size of the data to has, in bytes.
OutSignature	Output Structure to hold the computed signature.

Returns: whether the hash was computed successfully

◆ GetStoredValue()

static bool FGenericPlatformMisc::GetStoredValue	(	const FString &	InStoreId,
		const FString &	InSectionName,
		const FString &	InKeyName,
		FString &	OutValue )

static

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

Parameters

InStoreId	The name used to identify the store you want to use (eg, MyGame)
InSectionName	The section that this key->value pair is placed within (can contain / separators, eg UserDetails/AccountInfo)
InKeyName	The name of the key to get the value for
OutValue	The value found

Returns: bool true if the entry was found (and OutValue contains the result), false if not

◆ GetSystemErrorMessage()

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

static

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

Parameters

OutBuffer	the buffer to be filled with the error message
BufferLength	the size of the buffer in character count
Error	the error code to convert to string form

◆ GetSystemFontBytes()

static TArray< uint8 > FGenericPlatformMisc::GetSystemFontBytes ( )

static

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

◆ GetTimeZoneId()

static FString FGenericPlatformMisc::GetTimeZoneId ( )

static

Get the timezone identifier for this platform, or an empty string if the default timezone calculation will work.

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

◆ GetUBTPlatform()

static const TCHAR * FGenericPlatformMisc::GetUBTPlatform ( )

static

◆ GetUBTTarget()

static const TCHAR * FGenericPlatformMisc::GetUBTTarget ( )

static

◆ GetUBTTargetName()

static const TCHAR * FGenericPlatformMisc::GetUBTTargetName ( )

static

◆ GetUniqueAdvertisingId()

static FString FGenericPlatformMisc::GetUniqueAdvertisingId ( )

static

Returns a unique string for advertising identification

Returns: the unique string generated by this platform for this device

◆ GetUserIndexForPlatformUser()

static int32 FGenericPlatformMisc::GetUserIndexForPlatformUser ( FPlatformUserId PlatformUser )

static

◆ GetUseVirtualJoysticks()

static bool FGenericPlatformMisc::GetUseVirtualJoysticks ( )

inlinestatic

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

Definition at line 1483 of file GenericPlatformMisc.h.

◆ GetValidTargetPlatforms()

static void FGenericPlatformMisc::GetValidTargetPlatforms ( TArray< FString > & TargetPlatformNames )

static

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()

static bool FGenericPlatformMisc::GetVolumeButtonsHandledBySystem ( )

inlinestatic

Definition at line 1524 of file GenericPlatformMisc.h.

◆ HasActiveWiFiConnection()

static bool FGenericPlatformMisc::HasActiveWiFiConnection ( )

inlinestatic

Returns whether WiFi connection is currently active

Definition at line 1541 of file GenericPlatformMisc.h.

◆ HasMemoryWarningHandler()

static bool FGenericPlatformMisc::HasMemoryWarningHandler ( )

inlinestatic

Determines if a warning handler has been set

Definition at line 840 of file GenericPlatformMisc.h.

◆ HasNonoptionalCPUFeatures()

static bool FGenericPlatformMisc::HasNonoptionalCPUFeatures ( )

static

Returns: whether this cpu supports certain required instructions or not

◆ HasPlatformFeature()

static bool FGenericPlatformMisc::HasPlatformFeature ( const TCHAR * FeatureName )

inlinestatic

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

Definition at line 1576 of file GenericPlatformMisc.h.

◆ HasProjectPersistentDownloadDir()

static bool FGenericPlatformMisc::HasProjectPersistentDownloadDir ( )

inlinestatic

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

Definition at line 1200 of file GenericPlatformMisc.h.

◆ HasSeparateChannelForDebugOutput()

static bool FGenericPlatformMisc::HasSeparateChannelForDebugOutput ( )

static

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

◆ HasVariableHardware()

static bool FGenericPlatformMisc::HasVariableHardware ( )

inlinestatic

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

Definition at line 1567 of file GenericPlatformMisc.h.

◆ HidePlatformStartupScreen()

static void FGenericPlatformMisc::HidePlatformStartupScreen ( )

inlinestatic

Definition at line 1793 of file GenericPlatformMisc.h.

◆ InitTaggedStorage()

static FORCEINLINE void FGenericPlatformMisc::InitTaggedStorage ( uint32 NumTags )

inlinestatic

Platform specific function for initializing storage of tagged memory buffers

Definition at line 900 of file GenericPlatformMisc.h.

◆ Is64bitOperatingSystem()

static FORCEINLINE bool FGenericPlatformMisc::Is64bitOperatingSystem ( )

inlinestatic

Detects whether we're running in a 64-bit operating system.

Returns: true if we're running in a 64-bit operating system

Definition at line 1067 of file GenericPlatformMisc.h.

◆ IsCacheStorageAvailable()

static bool FGenericPlatformMisc::IsCacheStorageAvailable ( )

inlinestatic

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

Definition at line 798 of file GenericPlatformMisc.h.

◆ IsDebuggerPresent()

static FORCEINLINE bool FGenericPlatformMisc::IsDebuggerPresent ( )

inlinestatic

Return true if a debugger is present

Definition at line 661 of file GenericPlatformMisc.h.

Here is the caller graph for this function:

◆ IsEnsureAllowed()

static bool FGenericPlatformMisc::IsEnsureAllowed ( )

inlinestatic

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

Returns: ensure is allowed

Definition at line 1364 of file GenericPlatformMisc.h.

◆ IsInLowPowerMode()

static FORCEINLINE bool FGenericPlatformMisc::IsInLowPowerMode ( )

inlinestatic

Definition at line 1441 of file GenericPlatformMisc.h.

◆ IsLocalPrintThreadSafe()

static bool FGenericPlatformMisc::IsLocalPrintThreadSafe ( )

inlinestatic

Whether LocalPrint can be called from any thread without overlapping

Definition at line 988 of file GenericPlatformMisc.h.

◆ IsLowLevelOutputDebugStringStructured()

static bool FGenericPlatformMisc::IsLowLevelOutputDebugStringStructured ( )

static

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

◆ IsPackagedForDistribution()

static bool FGenericPlatformMisc::IsPackagedForDistribution ( )

inlinestatic

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

Definition at line 1276 of file GenericPlatformMisc.h.

◆ IsPGOEnabled()

static bool FGenericPlatformMisc::IsPGOEnabled ( )

static

Returns true if PGO is currently enabled

◆ IsRegisteredForRemoteNotifications()

static bool FGenericPlatformMisc::IsRegisteredForRemoteNotifications ( )

static

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

◆ IsRemoteSession()

static bool FGenericPlatformMisc::IsRemoteSession ( )

inlinestatic

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

Definition at line 655 of file GenericPlatformMisc.h.

◆ IsRunningInCloud()

static bool FGenericPlatformMisc::IsRunningInCloud ( )

inlinestatic

Return if the game is running on cloud server

Definition at line 1871 of file GenericPlatformMisc.h.

◆ IsRunningOnBattery()

static bool FGenericPlatformMisc::IsRunningOnBattery ( )

static

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

◆ IsValidAbsolutePathFormat()

static bool FGenericPlatformMisc::IsValidAbsolutePathFormat ( const FString & Path )

inlinestatic

Checks structure of the path against platform formatting requirements

return true if path is formatted validly

Definition at line 1077 of file GenericPlatformMisc.h.

◆ LaunchDir()

static const TCHAR * FGenericPlatformMisc::LaunchDir ( )

static

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

◆ LoadTextFileFromPlatformPackage()

static FString FGenericPlatformMisc::LoadTextFileFromPlatformPackage ( const FString & RelativePath )

static

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

◆ LocalPrint()

static void FGenericPlatformMisc::LocalPrint ( const TCHAR * Str )

static

Prints string to the default output

◆ LogNameEventStatsInit()

static void FGenericPlatformMisc::LogNameEventStatsInit ( )

static

◆ LowLevelOutputDebugString()

static void FGenericPlatformMisc::LowLevelOutputDebugString ( const TCHAR * Message )

static

Sends a message to a remote tool, and debugger consoles

◆ LowLevelOutputDebugStringf()

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

static

◆ MemoryBarrier()

static FORCENOINLINE void FGenericPlatformMisc::MemoryBarrier ( )

static

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

◆ MessageBoxExt()

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

static

Show a message box if possible, otherwise print a message and return the default

Parameters

MsgType	What sort of options are provided
Text	Specific message
Caption	String indicating the title of the message box

Returns: Very strange convention...not really EAppReturnType, see implementation

◆ NeedsNonoptionalCPUFeaturesCheck()

static bool FGenericPlatformMisc::NeedsNonoptionalCPUFeaturesCheck ( )

static

Returns: whether to check for specific CPU compatibility or not

◆ NormalizePath() [1/2]

static void FGenericPlatformMisc::NormalizePath ( FString & InPath )

inlinestatic

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

Definition at line 1086 of file GenericPlatformMisc.h.

◆ NormalizePath() [2/2]

static void FGenericPlatformMisc::NormalizePath ( FStringBuilderBase & InPath )

inlinestatic

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

Definition at line 1094 of file GenericPlatformMisc.h.

◆ NumberOfCores()

static int32 FGenericPlatformMisc::NumberOfCores ( )

static

return the number of hardware CPU cores

◆ NumberOfCoresIncludingHyperthreads()

static int32 FGenericPlatformMisc::NumberOfCoresIncludingHyperthreads ( )

static

return the number of logical CPU cores

◆ NumberOfIOWorkerThreadsToSpawn()

static int32 FGenericPlatformMisc::NumberOfIOWorkerThreadsToSpawn ( )

static

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

◆ NumberOfWorkerThreadsToSpawn()

static int32 FGenericPlatformMisc::NumberOfWorkerThreadsToSpawn ( )

static

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

◆ OsExecute()

static bool FGenericPlatformMisc::OsExecute	(	const TCHAR *	CommandType,
		const TCHAR *	Command,
		const TCHAR *	CommandLine = NULL )

inlinestatic

Has the OS execute a command and path pair (such as launch a browser)

Parameters

ComandType	OS hint as to the type of command
Command	the command to execute
CommandLine	the commands to pass to the executable

Returns: whether the command was successful or not

Definition at line 1268 of file GenericPlatformMisc.h.

◆ ParseChunkIdPakchunkIndexMapping()

static void FGenericPlatformMisc::ParseChunkIdPakchunkIndexMapping	(	TArray< FString >	ChunkIndexRedirects,
		TMap< int32, int32 > &	OutMapping )

static

◆ PlatformHandleSplashScreen()

static void FGenericPlatformMisc::PlatformHandleSplashScreen ( bool ShowSplashScreen = false )

inlinestatic

Called to dismiss splash screen

Definition at line 546 of file GenericPlatformMisc.h.

◆ PlatformInit()

static void FGenericPlatformMisc::PlatformInit ( )

inlinestatic

Definition at line 541 of file GenericPlatformMisc.h.

◆ PlatformPreInit()

static void FGenericPlatformMisc::PlatformPreInit ( )

static

Called during appInit() after cmd line setup

◆ PlatformTearDown()

static void FGenericPlatformMisc::PlatformTearDown ( )

inlinestatic

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

Definition at line 551 of file GenericPlatformMisc.h.

◆ Prefetch() [1/2]

static FORCEINLINE void FGenericPlatformMisc::Prefetch ( const void * Ptr )

inlinestatic

Definition at line 1385 of file GenericPlatformMisc.h.

Here is the caller graph for this function:

◆ Prefetch() [2/2]

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

inlinestatic

Definition at line 1400 of file GenericPlatformMisc.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PrefetchBlock() [1/2]

static FORCEINLINE void FGenericPlatformMisc::PrefetchBlock ( const void * Ptr )

inlinestatic

Definition at line 1406 of file GenericPlatformMisc.h.

Here is the call graph for this function:

◆ PrefetchBlock() [2/2]

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

inlinestatic

Definition at line 1411 of file GenericPlatformMisc.h.

Here is the call graph for this function:

◆ PrepareMobileHaptics()

static void FGenericPlatformMisc::PrepareMobileHaptics ( EMobileHapticsType Type )

inlinestatic

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

Definition at line 1718 of file GenericPlatformMisc.h.

◆ ProjectDir()

static const TCHAR * FGenericPlatformMisc::ProjectDir ( )

static

Return the project directory

◆ PromptForRemoteDebugging()

static void FGenericPlatformMisc::PromptForRemoteDebugging ( bool bIsEnsure )

inlinestatic

Definition at line 1381 of file GenericPlatformMisc.h.

◆ PumpEssentialAppMessages()

static void FGenericPlatformMisc::PumpEssentialAppMessages ( )

inlinestatic

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

Definition at line 1789 of file GenericPlatformMisc.h.

◆ PumpMessagesForSlowTask()

static void FGenericPlatformMisc::PumpMessagesForSlowTask ( )

inlinestatic

Definition at line 1782 of file GenericPlatformMisc.h.

◆ PumpMessagesOutsideMainLoop()

static void FGenericPlatformMisc::PumpMessagesOutsideMainLoop ( )

inlinestatic

Definition at line 1778 of file GenericPlatformMisc.h.

◆ RaiseException()

static void FGenericPlatformMisc::RaiseException ( uint32 ExceptionCode )

static

◆ RegisterForRemoteNotifications()

static void FGenericPlatformMisc::RegisterForRemoteNotifications ( )

static

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

◆ ReleaseMobileHaptics()

static void FGenericPlatformMisc::ReleaseMobileHaptics ( )

inlinestatic

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

Definition at line 1733 of file GenericPlatformMisc.h.

◆ RequestDeviceCheckToken()

static bool FGenericPlatformMisc::RequestDeviceCheckToken	(	TFunction< void(const TArray< uint8 > &)>	QuerySucceededFunc,
		TFunction< void(const FString &, const FString &)>	QueryFailedFunc )

static

◆ RequestExit()

static void FGenericPlatformMisc::RequestExit ( bool Force )

static

Requests application exit.

Parameters

Force If true, perform immediate exit (dangerous because config code isn't flushed, etc). If false, request clean main-loop exit from the platform specific code.

◆ RequestExitWithStatus()

static void FGenericPlatformMisc::RequestExitWithStatus	(	bool	Force,
		uint8	ReturnCode )

static

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

Parameters

Force	If true, perform immediate exit (dangerous because config code isn't flushed, etc). If false, request clean main-loop exit from the platform specific code.
ReturnCode	This value will be returned from the program (on the platforms where it's possible). Limited to 0-255 to conform with POSIX.

◆ RestartApplication()

static bool FGenericPlatformMisc::RestartApplication ( )

static

Requests application to restart

◆ RestartApplicationWithCmdLine()

static bool FGenericPlatformMisc::RestartApplicationWithCmdLine ( const char * CmdLine )

static

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

◆ RootDir()

static const TCHAR * FGenericPlatformMisc::RootDir ( )

static

Get the application root directory.

◆ SetAllowedDeviceOrientation()

static void FGenericPlatformMisc::SetAllowedDeviceOrientation ( EDeviceScreenOrientation NewAllowedDeviceOrientation )

static

Change the allowed orientation of the device.

◆ SetBrightness()

static FORCEINLINE void FGenericPlatformMisc::SetBrightness ( float bBright )

inlinestatic

Definition at line 1437 of file GenericPlatformMisc.h.

◆ SetCrashHandler()

static void FGenericPlatformMisc::SetCrashHandler ( void(*)(const FGenericCrashContext &Context) CrashHandler )

inlinestatic

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

Definition at line 560 of file GenericPlatformMisc.h.

◆ SetCrashHandlingType()

static ECrashHandlingType FGenericPlatformMisc::SetCrashHandlingType ( ECrashHandlingType Type )

inlinestatic

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

Definition at line 571 of file GenericPlatformMisc.h.

◆ SetDeviceOrientation()

static void FGenericPlatformMisc::SetDeviceOrientation ( EDeviceScreenOrientation NewDeviceOrientation )

static

Change the orientation of the device.

◆ SetEnvironmentVar()

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

static

Sets an environment variable to the local process's environment

Parameters

VariableName	The name of the variable (ie "Path")
Value	The string to set the variable to.

◆ SetGracefulTerminationHandler()

static void FGenericPlatformMisc::SetGracefulTerminationHandler ( )

inlinestatic

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

Definition at line 554 of file GenericPlatformMisc.h.

◆ SetLastError()

static void FGenericPlatformMisc::SetLastError ( uint32 ErrorCode )

inlinestatic

Definition at line 850 of file GenericPlatformMisc.h.

◆ SetMemoryWarningHandler()

static void FGenericPlatformMisc::SetMemoryWarningHandler ( void(*)(const FGenericMemoryWarningContext &Context) Handler )

inlinestatic

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

Parameters

Handler The handler to call

Definition at line 833 of file GenericPlatformMisc.h.

◆ SetNetworkConnectionStatus()

static void FGenericPlatformMisc::SetNetworkConnectionStatus ( ENetworkConnectionStatus NewNetworkConnectionStatus )

static

Updates the current status for the network connection

◆ SetOverrideProjectDir()

static void FGenericPlatformMisc::SetOverrideProjectDir ( const FString & InOverrideDir )

static

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

Here is the caller graph for this function:

◆ SetShouldPromptForRemoteDebugging()

static void FGenericPlatformMisc::SetShouldPromptForRemoteDebugging ( bool bInShouldPrompt )

inlinestatic

Definition at line 1345 of file GenericPlatformMisc.h.

◆ SetShouldPromptForRemoteDebugOnEnsure()

static void FGenericPlatformMisc::SetShouldPromptForRemoteDebugOnEnsure ( bool bInShouldPrompt )

inlinestatic

Definition at line 1350 of file GenericPlatformMisc.h.

◆ SetStoredValue()

static bool FGenericPlatformMisc::SetStoredValue	(	const FString &	InStoreId,
		const FString &	InSectionName,
		const FString &	InKeyName,
		const FString &	InValue )

static

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

Parameters

InStoreId	The name used to identify the store you want to use (eg, MyGame)
InSectionName	The section that this key->value pair is placed within (can contain / separators, eg UserDetails/AccountInfo)
InKeyName	The name of the key to set the value for
InValue	The value to set

Returns: bool true if the value was set correctly, false if not

◆ SetStoredValues()

static bool FGenericPlatformMisc::SetStoredValues	(	const FString &	InStoreId,
		const FString &	InSectionName,
		const TMap< FString, FString > &	InKeyValues )

static

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

Parameters

InStoreId	The name used to identify the store you want to use (eg, MyGame)
InSectionName	The section that this key->value pair is placed within (can contain / separators, eg UserDetails/AccountInfo)
InKeyValues	The mapping of key->value pairs to set

Returns: bool true if the value was set correctly, false if not

◆ SetUBTTargetName()

static void FGenericPlatformMisc::SetUBTTargetName ( const TCHAR * InTargetName )

static

◆ SetupSyscallFilters()

static bool FGenericPlatformMisc::SetupSyscallFilters ( )

inlinestatic

Definition at line 1887 of file GenericPlatformMisc.h.

◆ SetUTF8Output()

static void FGenericPlatformMisc::SetUTF8Output ( )

static

Sets the default output to UTF8

◆ SetVolumeButtonsHandledBySystem()

static void FGenericPlatformMisc::SetVolumeButtonsHandledBySystem ( bool enabled )

inlinestatic

Definition at line 1532 of file GenericPlatformMisc.h.

◆ ShareURL()

static void FGenericPlatformMisc::ShareURL	(	const FString &	URL,
		const FText &	Description,
		int32	LocationHintX,
		int32	LocationHintY )

inlinestatic

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

Definition at line 1740 of file GenericPlatformMisc.h.

◆ ShouldDisablePluginAtRuntime()

static bool FGenericPlatformMisc::ShouldDisablePluginAtRuntime ( const FString & PluginName )

inlinestatic

Allows platform at runtime to disable unsupported plugins

Parameters

PluginName Name of enabled plugin to consider

Returns: bool true if plugin should be disabled

Definition at line 1709 of file GenericPlatformMisc.h.

◆ ShouldDisplayTouchInterfaceOnFakingTouchEvents()

static bool FGenericPlatformMisc::ShouldDisplayTouchInterfaceOnFakingTouchEvents ( )

inlinestatic

Definition at line 1498 of file GenericPlatformMisc.h.

◆ ShowConsoleWindow()

static void FGenericPlatformMisc::ShowConsoleWindow ( )

static

◆ ShutdownTaggedStorage()

static FORCEINLINE void FGenericPlatformMisc::ShutdownTaggedStorage ( )

inlinestatic

Platform specific function for freeing storage of tagged memory buffers

Definition at line 907 of file GenericPlatformMisc.h.

◆ StatNamedEvent()

template<typename CharType >

static void FGenericPlatformMisc::StatNamedEvent ( const CharType * Text )

static

Stats logging for named event

◆ SubmitErrorReport()

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

static

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

◆ SupportsBackbufferSampling()

static FORCEINLINE bool FGenericPlatformMisc::SupportsBackbufferSampling ( )

inlinestatic

Definition at line 1826 of file GenericPlatformMisc.h.

◆ SupportsBrightness()

static FORCEINLINE bool FGenericPlatformMisc::SupportsBrightness ( )

inlinestatic

Definition at line 1439 of file GenericPlatformMisc.h.

◆ SupportsDeviceCheckToken()

static bool FGenericPlatformMisc::SupportsDeviceCheckToken ( )

inlinestatic

Definition at line 1744 of file GenericPlatformMisc.h.

◆ SupportsForceTouchInput()

static bool FGenericPlatformMisc::SupportsForceTouchInput ( )

inlinestatic

Definition at line 1493 of file GenericPlatformMisc.h.

◆ SupportsFullCrashDumps()

static bool FGenericPlatformMisc::SupportsFullCrashDumps ( )

inlinestatic

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

Definition at line 818 of file GenericPlatformMisc.h.

◆ SupportsLocalCaching()

static bool FGenericPlatformMisc::SupportsLocalCaching ( )

inlinestatic

Definition at line 803 of file GenericPlatformMisc.h.

◆ SupportsMessaging()

static bool FGenericPlatformMisc::SupportsMessaging ( )

inlinestatic

Definition at line 788 of file GenericPlatformMisc.h.

◆ SupportsMultithreadedFileHandles()

static bool FGenericPlatformMisc::SupportsMultithreadedFileHandles ( )

inlinestatic

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

Definition at line 1339 of file GenericPlatformMisc.h.

◆ SupportsTouchInput()

static bool FGenericPlatformMisc::SupportsTouchInput ( )

inlinestatic

Definition at line 1488 of file GenericPlatformMisc.h.

◆ TagBuffer()

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

inlinestatic

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

Definition at line 914 of file GenericPlatformMisc.h.

◆ TearDown()

static void FGenericPlatformMisc::TearDown ( )

static

Frees any memory retained by FGenericPlatformMisc.

◆ TickHotfixables()

static void FGenericPlatformMisc::TickHotfixables ( )

static

Ticks values that can be hotfixable in the config.

◆ TickStatNamedEvents()

static void FGenericPlatformMisc::TickStatNamedEvents ( )

static

◆ TriggerMobileHaptics()

static void FGenericPlatformMisc::TriggerMobileHaptics ( )

inlinestatic

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

Definition at line 1726 of file GenericPlatformMisc.h.

◆ UE_DEPRECATED() [1/3]

FGenericPlatformMisc::UE_DEPRECATED	(	4.	18,
		"FPaths::SetOverrideGameDir() has been superseded by FPaths::SetOverrideProjectDir()."	) const &

inline

Definition at line 1455 of file GenericPlatformMisc.h.

Here is the call graph for this function:

◆ UE_DEPRECATED() [2/3]

FGenericPlatformMisc::UE_DEPRECATED	(	4.	18,
		"FPlatformMisc::ClipboardCopy() has been superseded by FPlatformApplicationMisc::ClipboardCopy()"	) const

Copies text to the operating system clipboard.

◆ UE_DEPRECATED() [3/3]

FGenericPlatformMisc::UE_DEPRECATED	(	4.	18,
		"FPlatformMisc::ClipboardPaste() has been superseded by FPlatformApplicationMisc::ClipboardPaste()"	) &

Pastes in text from the operating system clipboard.

◆ UnregisterForRemoteNotifications()

static void FGenericPlatformMisc::UnregisterForRemoteNotifications ( )

static

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

◆ UpdateHotfixableEnsureSettings()

static void FGenericPlatformMisc::UpdateHotfixableEnsureSettings ( )

inlinestatic

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

Definition at line 1373 of file GenericPlatformMisc.h.

◆ UseHDRByDefault()

static FORCEINLINE bool FGenericPlatformMisc::UseHDRByDefault ( )

inlinestatic

Definition at line 1798 of file GenericPlatformMisc.h.

◆ UseRenderThread()

static bool FGenericPlatformMisc::UseRenderThread ( )

static

Checks if platform wants to use a rendering thread on current device

Returns: true if allowed, false if shouldn't use a separate rendering thread

Member Data Documentation

◆ AllowedDeviceOrientation

EDeviceScreenOrientation FGenericPlatformMisc::AllowedDeviceOrientation

staticprotected

Definition at line 1908 of file GenericPlatformMisc.h.

◆ bPromptForRemoteDebugOnEnsure

bool FGenericPlatformMisc::bPromptForRemoteDebugOnEnsure

staticprotected

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

Definition at line 1905 of file GenericPlatformMisc.h.

◆ bShouldPromptForRemoteDebugging

bool FGenericPlatformMisc::bShouldPromptForRemoteDebugging

staticprotected

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

Definition at line 1903 of file GenericPlatformMisc.h.

◆ CurrentNetworkConnectionStatus

ENetworkConnectionStatus FGenericPlatformMisc::CurrentNetworkConnectionStatus

staticprotected

Definition at line 1910 of file GenericPlatformMisc.h.

The documentation for this struct was generated from the following file:

C:/Users/lachl/Downloads/ArkServerAPI_NEW/ASA/AsaApi/AsaApi/Core/Public/API/UE/GenericPlatform/GenericPlatformMisc.h

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ AddAdditionalRootDirectory()

◆ AllowAudioThread()

◆ AllowLocalCaching()

◆ AllowThreadHeartBeat()

◆ BeginEnterBackgroundEvent()

◆ BeginNamedEvent() [1/2]

◆ BeginNamedEvent() [2/2]

◆ BeginNamedEventFrame()

◆ BeginProfilerColor()

◆ CacheLaunchDir()

◆ CheckPersistentDownloadStorageSpaceAvailable()

◆ ChooseHDRDeviceAndColorGamut()

◆ CloudDir()

◆ CommandLineCommands()

◆ CreateGuid()

◆ CustomNamedStat() [1/2]

◆ CustomNamedStat() [2/2]

◆ DebugBreak()

◆ DeleteStoredSection()

◆ DeleteStoredValue()

◆ DesktopTouchScreen()

◆ DisableScreenTimeout()

◆ EnableScreenTimeout()

◆ EndEnterBackgroundEvent()

◆ EndNamedEvent()

◆ EndProfilerColor()

◆ EngineDir()

◆ Exec()

◆ Expand16BitIndicesTo32BitOnLoad()

◆ FileExistsInPlatformPackage()

◆ FullscreenSameAsWindowedFullscreen()

◆ GamePersistentDownloadDir()

◆ GameTemporaryDownloadDir()

◆ GeneratedConfigDir()

◆ GetAdditionalRootDirectories()

◆ GetAllLanguageChunks()

◆ GetAllOnDemandChunks()

◆ GetAllowedDeviceOrientation()

◆ GetBatteryLevel()

◆ GetBlockingIOStats()

◆ GetBrightness()

◆ GetChunkIDFromPakchunkIndex()

◆ GetConfiguredCoreLimits()

◆ GetContextSwitchStats()

◆ GetConvertibleLaptopMode()

◆ GetCPUBrand()

◆ GetCPUChipset()

◆ GetCPUInfo()

◆ GetCPUVendor()

◆ GetCrashHandlingType()

◆ GetCustomChunksByType()

◆ GetDefaultDeviceProfileName()

◆ GetDefaultLanguage()

◆ GetDefaultLocale()

◆ GetDefaultPathSeparator()

◆ GetDeviceId()

◆ GetDeviceMakeAndModel()

◆ GetDeviceOrientation()

◆ GetDeviceTemperatureLevel()

◆ GetDeviceVolume()

◆ GetDiskTotalAndFreeSpace()

◆ GetEngineMode()

◆ GetEnvironmentVariable()

◆ GetEpicAccountId()

◆ GetFileManagerName()

◆ GetGPUDriverInfo()

◆ GetHashedMacAddressString()

◆ GetLastError()

◆ GetLocalCurrencyCode()

◆ GetLocalCurrencySymbol()

◆ GetLoginId()

◆ GetMacAddress()

◆ GetMacAddressString()

◆ GetMachineId()