FUnixPlatformMisc Struct Reference

#include <UnixPlatformMisc.h>

Inheritance diagram for FUnixPlatformMisc:

Public Member Functions
	UE_DEPRECATED (4.21, "void FPlatformMisc::GetEnvironmentVariable(Name, Result, Length) is deprecated. Use FString FPlatformMisc::GetEnvironmentVariable(Name) instead.") static CORE_API void GetEnvironmentVariable(const TCHAR *VariableName
Public Member Functions inherited from FGenericPlatformMisc
	UE_DEPRECATED (4.18, "FPaths::SetOverrideGameDir() has been superseded by FPaths::SetOverrideProjectDir().") static FORCEINLINE void SetOverrideGameDir(const FString &InOverrideDir)

Static Public Member Functions
static CORE_API void	PlatformPreInit ()
static CORE_API void	PlatformInit ()
static CORE_API void	PlatformTearDown ()
static CORE_API void	SetGracefulTerminationHandler ()
static CORE_API void	SetCrashHandler (void(*CrashHandler)(const FGenericCrashContext &Context))
static CORE_API int32	GetMaxPathLength ()
static CORE_API FString	GetEnvironmentVariable (const TCHAR *VariableName)
static CORE_API void	SetEnvironmentVar (const TCHAR *VariableName, const TCHAR *Value)
static CORE_API TArray< uint8 >	GetMacAddress ()
static CORE_API bool	IsRunningOnBattery ()
static CORE_API bool	IsDebuggerPresent ()
static CORE_API void	LowLevelOutputDebugString (const TCHAR *Message)
static CORE_API void	RequestExit (bool Force, const TCHAR *CallSite=nullptr)
static CORE_API void	RequestExitWithStatus (bool Force, uint8 ReturnCode, const TCHAR *CallSite=nullptr)
static CORE_API const TCHAR *	GetSystemErrorMessage (TCHAR *OutBuffer, int32 BufferCount, int32 Error)
static CORE_API uint32	GetLastError ()
static CORE_API void	NormalizePath (FString &InPath)
static CORE_API void	NormalizePath (FStringBuilderBase &InPath)
static const TCHAR *	GetPathVarDelimiter ()
static CORE_API EAppReturnType::Type	MessageBoxExt (EAppMsgType::Type MsgType, const TCHAR *Text, const TCHAR *Caption)
static UE_FORCEINLINE_HINT void	MemoryBarrier ()
static CORE_API int32	NumberOfCores ()
static CORE_API int32	NumberOfCoresIncludingHyperthreads ()
static CORE_API FString	GetOperatingSystemId ()
static CORE_API bool	GetDiskTotalAndFreeSpace (const FString &InPath, uint64 &TotalNumberOfBytes, uint64 &NumberOfFreeBytes)
static CORE_API bool	GetPageFaultStats (FPageFaultStats &OutStats, EPageFaultFlags Flags=EPageFaultFlags::All)
static CORE_API bool	GetBlockingIOStats (FProcessIOStats &OutStats, EInputOutputFlags Flags=EInputOutputFlags::All)
static CORE_API bool	GetContextSwitchStats (FContextSwitchStats &OutStats, EContextSwitchFlags Flags=EContextSwitchFlags::All)
static CORE_API const TCHAR *	GetNullRHIShaderFormat ()
static CORE_API bool	HasCPUIDInstruction ()
static CORE_API FString	GetCPUVendor ()
static CORE_API FString	GetCPUBrand ()
static CORE_API uint32	GetCPUModelID ()
static CORE_API uint32	GetCPUMicrocodeRevision ()
static CORE_API uint32	GetCPUInfo ()
static CORE_API FString	GetPrimaryGPUBrand ()
static CORE_API bool	HasNonoptionalCPUFeatures ()
static CORE_API bool	NeedsNonoptionalCPUFeaturesCheck ()
static CORE_API void	UngrabAllInput ()
static CORE_API bool	HasBeenStartedRemotely ()
static CORE_API bool	HasOverriddenReturnCode (uint8 *OverriddenReturnCodeToUsePtr)
static CORE_API void	GetOSVersions (FString &out_OSVersionLabel, FString &out_OSSubVersionLabel)
static CORE_API FString	GetOSVersion ()
static CORE_API FString	GetLoginId ()
static CORE_API void	CreateGuid (FGuid &Result)
static CORE_API IPlatformChunkInstall *	GetPlatformChunkInstall ()
static CORE_API bool	SetStoredValues (const FString &InStoreId, const FString &InSectionName, const TMap< FString, FString > &InKeyValues)
static CORE_API int32	NumberOfWorkerThreadsToSpawn ()
static CORE_API bool	SetupSyscallFilters ()
Static Public Member Functions inherited from FGenericPlatformMisc
static CORE_API void	PlatformPreInit ()
static void	PlatformInit ()
static CORE_API FDelegateHandle	AddNetworkListener (FOnNetworkConnectionChangedDelegate &&InNewDelegate)
static CORE_API bool	RemoveNetworkListener (FDelegateHandle Handle)
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 CORE_API FString	GetEnvironmentVariable (const TCHAR *VariableName)
static CORE_API void	SetEnvironmentVar (const TCHAR *VariableName, const TCHAR *Value)
static FORCEINLINE int32	GetMaxPathLength ()
static CORE_API int32	GetExternalAppMaxPathLength ()
static CORE_API const TCHAR *	GetPathVarDelimiter ()
static CORE_API TArray< uint8 >	GetMacAddress ()
static CORE_API FString	GetMacAddressString ()
static CORE_API FString	GetHashedMacAddressString ()
static CORE_API FString	GetDeviceId ()
static CORE_API FString	GetUniqueAdvertisingId ()
static CORE_API void	SubmitErrorReport (const TCHAR *InErrorHist, EErrorReportMode::Type InMode)
static bool	IsRemoteSession ()
static FORCEINLINE bool	IsDebuggerPresent ()
static CORE_API EProcessDiagnosticFlags	GetProcessDiagnostics ()
static FORCEINLINE void	DebugBreak ()
static CORE_API FString	GetCPUVendor ()
static CORE_API uint32	GetCPUInfo ()
static CORE_API bool	HasNonoptionalCPUFeatures ()
static CORE_API bool	NeedsNonoptionalCPUFeaturesCheck ()
static CORE_API FString	GetHostArchitecture ()
static CORE_API FString	GetCPUBrand ()
static CORE_API uint32	GetCPUModelID ()
static CORE_API uint32	GetCPUMicrocodeRevision ()
static CORE_API FString	GetCPUChipset ()
static CORE_API FString	GetPrimaryGPUBrand ()
static CORE_API FString	GetDeviceMakeAndModel ()
static CORE_API struct FGPUDriverInfo	GetGPUDriverInfo (const FString &DeviceDescription)
static CORE_API void	GetOSVersions (FString &out_OSVersionLabel, FString &out_OSSubVersionLabel)
static CORE_API FString	GetOSVersion ()
static CORE_API 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 ()
CORE_API 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 CORE_API void	RaiseException (uint32 ExceptionCode)
static FORCEINLINE void	BeginNamedEventFrame ()
static FORCEINLINE void	BeginNamedEvent (const struct FColor &Color, const TCHAR *Text)
static FORCEINLINE void	BeginNamedEvent (const struct FColor &Color, const ANSICHAR *Text)
static FORCEINLINE void	EndNamedEvent ()
static FORCEINLINE void	CustomNamedStat (const TCHAR *Text, float Value, const TCHAR *Graph, const TCHAR *Unit)
static FORCEINLINE void	CustomNamedStat (const ANSICHAR *Text, float Value, const ANSICHAR *Graph, const ANSICHAR *Unit)
template<typename CharType >
static void	StatNamedEvent (const CharType *Text)
static CORE_API void	TickStatNamedEvents ()
static CORE_API void	LogNameEventStatsInit ()
static void	BeginEnterBackgroundEvent (const TCHAR *Text)
static void	EndEnterBackgroundEvent ()
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 CORE_API bool	SetStoredValues (const FString &InStoreId, const FString &InSectionName, const TMap< FString, FString > &InKeyValues)
static CORE_API bool	SetStoredValue (const FString &InStoreId, const FString &InSectionName, const FString &InKeyName, const FString &InValue)
static CORE_API bool	GetStoredValue (const FString &InStoreId, const FString &InSectionName, const FString &InKeyName, FString &OutValue)
static CORE_API bool	DeleteStoredValue (const FString &InStoreId, const FString &InSectionName, const FString &InKeyName)
static CORE_API bool	DeleteStoredSection (const FString &InStoreId, const FString &InSectionName)
static CORE_API void	LowLevelOutputDebugString (const TCHAR *Message)
static CORE_API void VARARGS	LowLevelOutputDebugStringf (const TCHAR *Format,...)
static CORE_API bool	IsLowLevelOutputDebugStringStructured ()
static CORE_API void	SetUTF8Output ()
static CORE_API void	LocalPrint (const TCHAR *Str)
static bool	IsLocalPrintThreadSafe ()
static CORE_API bool	HasSeparateChannelForDebugOutput ()
static CORE_API void	RequestExit (bool Force, const TCHAR *CallSite=nullptr)
static CORE_API void	RequestExitWithStatus (bool Force, uint8 ReturnCode, const TCHAR *CallSite=nullptr)
static CORE_API bool	RestartApplication ()
static CORE_API bool	RestartApplicationWithCmdLine (const char *CmdLine)
static CORE_API const TCHAR *	GetSystemErrorMessage (TCHAR *OutBuffer, int32 BufferCount, int32 Error)
static CORE_API void	CreateGuid (struct FGuid &Result)
static CORE_API 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 CORE_API const TCHAR *	GetDefaultPathSeparator ()
static CORE_API bool	UseRenderThread ()
static bool	AllowAudioThread ()
static CORE_API bool	AllowThreadHeartBeat ()
static CORE_API int32	NumberOfCores ()
static CORE_API const FProcessorGroupDesc &	GetProcessorGroupDesc ()
static CORE_API int32	NumberOfCoresIncludingHyperthreads ()
static CORE_API int32	NumberOfWorkerThreadsToSpawn ()
static CORE_API int32	NumberOfIOWorkerThreadsToSpawn ()
static struct FAsyncIOSystemBase *	GetPlatformSpecificAsyncIOSystem ()
static const TCHAR *	GetPlatformFeaturesModuleName ()
static CORE_API const TCHAR *	RootDir ()
static CORE_API TArray< FString >	GetAdditionalRootDirectories ()
static CORE_API void	AddAdditionalRootDirectory (const FString &RootDir)
static CORE_API const TCHAR *	EngineDir ()
static CORE_API const TCHAR *	LaunchDir ()
static CORE_API void	CacheLaunchDir ()
static CORE_API const TCHAR *	ProjectDir ()
static CORE_API bool	GetEngineAndProjectAbsoluteDirsFromExecutable (FString &OutProjectDir, FString &OutEngineDir)
static CORE_API FString	CloudDir ()
static bool	HasProjectPersistentDownloadDir ()
static CORE_API bool	CheckPersistentDownloadStorageSpaceAvailable (uint64 BytesRequired, bool bAttemptToUseUI)
static CORE_API const TCHAR *	GamePersistentDownloadDir ()
static CORE_API const TCHAR *	GameTemporaryDownloadDir ()
static CORE_API const TCHAR *	GeneratedConfigDir ()
static CORE_API const TCHAR *	GetUBTPlatform ()
static CORE_API const TCHAR *	GetUBTTarget ()
static CORE_API const TCHAR *	GetUBTArchitecture ()
static CORE_API void	SetUBTTargetName (const TCHAR *InTargetName)
static CORE_API const TCHAR *	GetUBTTargetName ()
static CORE_API const TCHAR *	GetNullRHIShaderFormat ()
static CORE_API IPlatformChunkInstall *	GetPlatformChunkInstall ()
static CORE_API IPlatformCompression *	GetPlatformCompression ()
static CORE_API IPlatformHostCommunication &	GetPlatformHostCommunication ()
static bool	OsExecute (const TCHAR *CommandType, const TCHAR *Command, const TCHAR *CommandLine=NULL)
static bool	IsPackagedForDistribution ()
static CORE_API bool	GetSHA256Signature (const void *Data, uint32 ByteSize, FSHA256Signature &OutSignature)
static CORE_API FString	GetDefaultLanguage ()
static CORE_API FString	GetDefaultLocale ()
static CORE_API FString	GetTimeZoneId ()
static bool	Exec (class UWorld *InWorld, const TCHAR *Cmd, FOutputDevice &Out)
static CORE_API FText	GetFileManagerName ()
static bool	SupportsMultithreadedFileHandles ()
static void	SetShouldPromptForRemoteDebugging (bool bInShouldPrompt)
static void	SetShouldPromptForRemoteDebugOnEnsure (bool bInShouldPrompt)
static bool	IsEnsureAllowed ()
static void	UpdateHotfixableEnsureSettings ()
static CORE_API 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 CORE_API 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 CORE_API float	GetDeviceTemperatureLevel ()
static CORE_API void	SetOverrideProjectDir (const FString &InOverrideDir)
static CORE_API void	GetValidTargetPlatforms (TArray< FString > &TargetPlatformNames)
static CORE_API FPlatformUserId	GetPlatformUserForUserIndex (int32 LocalUserIndex)
static CORE_API 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 CORE_API TArray< uint8 >	GetSystemFontBytes ()
static bool	HasActiveWiFiConnection ()
static CORE_API ENetworkConnectionStatus	GetNetworkConnectionStatus ()
static CORE_API void	SetNetworkConnectionStatus (ENetworkConnectionStatus NewNetworkConnectionStatus)
static ENetworkConnectionType	GetNetworkConnectionType ()
static void	EnsureNetworkIfNecessary ()
static bool	HasVariableHardware ()
static bool	HasPlatformFeature (const TCHAR *FeatureName)
static CORE_API bool	IsRunningOnBattery ()
static CORE_API EDeviceScreenOrientation	GetDeviceOrientation ()
static CORE_API void	SetDeviceOrientation (EDeviceScreenOrientation NewDeviceOrientation)
static CORE_API EDeviceScreenOrientation	GetAllowedDeviceOrientation ()
static CORE_API void	SetAllowedDeviceOrientation (EDeviceScreenOrientation NewAllowedDeviceOrientation)
static CORE_API int32	GetDeviceVolume ()
static CORE_API FGuid	GetMachineId ()
static CORE_API FString	GetLoginId ()
static CORE_API FString	GetEpicAccountId ()
static CORE_API FString	GetDeviceTag ()
static CORE_API FString	GetOperatingSystemId ()
static CORE_API EConvertibleLaptopMode	GetConvertibleLaptopMode ()
static CORE_API const TCHAR *	GetEngineMode ()
static CORE_API TArray< FString >	GetPreferredLanguages ()
static CORE_API FString	GetLocalCurrencyCode ()
static CORE_API FString	GetLocalCurrencySymbol ()
static CORE_API void	RegisterForRemoteNotifications ()
static CORE_API bool	IsRegisteredForRemoteNotifications ()
static CORE_API void	UnregisterForRemoteNotifications ()
static CORE_API FString	GetPendingActivationProtocol ()
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 CORE_API bool	RequestDeviceCheckToken (TFunction< void(const TArray< uint8 > &)> QuerySucceededFunc, TFunction< void(const FString &, const FString &)> QueryFailedFunc)
static CORE_API FString	LoadTextFileFromPlatformPackage (const FString &RelativePath)
static CORE_API bool	FileExistsInPlatformPackage (const FString &RelativePath)
static CORE_API void	TearDown ()
static CORE_API 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 CORE_API FStringView	GetPakFilenamePrefix ()
static CORE_API int32	GetPakchunkIndexFromPakFile (FStringView 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 CORE_API const FString *	GetConfigRulesVariable (const FString &Key)
static CORE_API const class TMap< FString, FString > &	GetConfigRuleVars ()
static CORE_API bool	IsPGOEnabled ()
static CORE_API bool	IsPGICapableBinary ()
static bool	StartNewPGOCollection (const FString &AbsoluteFileName)
static CORE_API bool	IsPGIActive ()
static CORE_API const FString	VersionCheckPlatformName ()
static bool	StopPGOCollectionAndCloseFile ()
static CORE_API void	ShowConsoleWindow ()
static CORE_API int	GetMobilePropagateAlphaSetting ()
static bool	IsRunningInCloud ()
static bool	WasLaunchedStreaming ()
static void	DisableScreenTimeout ()
static void	EnableScreenTimeout ()
static bool	SetupSyscallFilters ()
static const float	GetVirtualKeyboardInputHeight ()
static bool	GetPlatformScreenWarnings (TArray< FText > &PlatformScreenWarnings)

Public Attributes
TCHAR *	Result
TCHAR int32	ResultLength

Additional Inherited Members
Static Protected Member Functions inherited from FGenericPlatformMisc
static CORE_API void	GetConfiguredCoreLimits (int32 PlatformNumPhysicalCores, int32 PlatformNumLogicalCores, bool &bOutFullyInitialized, int32 &OutPhysicalCoreLimit, int32 &OutLogicalCoreLimit, bool &bOutSetPhysicalCountToLogicalCount)
Static Protected Attributes inherited from FGenericPlatformMisc
static CORE_API bool	bShouldPromptForRemoteDebugging = false
static CORE_API bool	bPromptForRemoteDebugOnEnsure = false
static CORE_API EDeviceScreenOrientation	AllowedDeviceOrientation = EDeviceScreenOrientation::Unknown
static CORE_API ENetworkConnectionStatus	CurrentNetworkConnectionStatus = ENetworkConnectionStatus::Connected

Detailed Description

Unix implementation of the misc OS functions

Member Function Documentation

CreateGuid()

void FUnixPlatformMisc::CreateGuid ( FGuid &  Result )

static

GetBlockingIOStats()

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

static

GetContextSwitchStats()

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

static

GetCPUBrand()

FString FUnixPlatformMisc::GetCPUBrand ( )

static

GetCPUInfo()

uint32 FUnixPlatformMisc::GetCPUInfo ( )

static

Uses cpuid instruction to get the vendor string

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

GetCPUMicrocodeRevision()

uint32 FUnixPlatformMisc::GetCPUMicrocodeRevision ( )

static

GetCPUModelID()

uint32 FUnixPlatformMisc::GetCPUModelID ( )

static

GetCPUVendor()

FString FUnixPlatformMisc::GetCPUVendor ( )

static

GetDiskTotalAndFreeSpace()

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

static

GetEnvironmentVariable()

FString FUnixPlatformMisc::GetEnvironmentVariable ( const TCHAR *  VariableName )

static

GetLastError()

uint32 FUnixPlatformMisc::GetLastError ( )

static

GetLoginId()

FString FUnixPlatformMisc::GetLoginId ( )

static

GetMacAddress()

TArray< uint8 > FUnixPlatformMisc::GetMacAddress ( )

static

GetMaxPathLength()

int32 FUnixPlatformMisc::GetMaxPathLength ( )

static

GetNullRHIShaderFormat()

const TCHAR * FUnixPlatformMisc::GetNullRHIShaderFormat ( )

static

Determines the shader format for the platform

Returns

Returns the shader format to be used by that platform

GetOperatingSystemId()

FString FUnixPlatformMisc::GetOperatingSystemId ( )

static

GetOSVersion()

UE_AUTORTFM_ALWAYS_OPEN FString FUnixPlatformMisc::GetOSVersion ( )

static

GetOSVersions()

void FUnixPlatformMisc::GetOSVersions ( FString &  out_OSVersionLabel, FString &  out_OSSubVersionLabel  )

static

GetPageFaultStats()

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

static

GetPathVarDelimiter()

static const TCHAR * FUnixPlatformMisc::GetPathVarDelimiter ( )

inlinestatic

GetPlatformChunkInstall()

IPlatformChunkInstall * FUnixPlatformMisc::GetPlatformChunkInstall ( )

static

GetPrimaryGPUBrand()

FString FUnixPlatformMisc::GetPrimaryGPUBrand ( )

static

GetSystemErrorMessage()

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

static

HasBeenStartedRemotely()

bool FUnixPlatformMisc::HasBeenStartedRemotely ( )

static

Returns whether the program has been started remotely (e.g. over SSH)

HasCPUIDInstruction()

bool FUnixPlatformMisc::HasCPUIDInstruction ( )

static

HasNonoptionalCPUFeatures()

bool FUnixPlatformMisc::HasNonoptionalCPUFeatures ( )

static

HasOverriddenReturnCode()

bool FUnixPlatformMisc::HasOverriddenReturnCode ( uint8 *  OverriddenReturnCodeToUsePtr )

static

Determines if return code has been overriden and returns it.

Parameters

OverriddenReturnCodeToUsePtr

pointer to an variable that will hold an overriden return code, if any. Can be null.

Returns

true if the error code has been overriden, false if not

IsDebuggerPresent()

bool FUnixPlatformMisc::IsDebuggerPresent ( )

static

IsRunningOnBattery()

bool FUnixPlatformMisc::IsRunningOnBattery ( )

static

LowLevelOutputDebugString()

void FUnixPlatformMisc::LowLevelOutputDebugString ( const TCHAR *  Message )

static

MemoryBarrier()

static UE_FORCEINLINE_HINT void FUnixPlatformMisc::MemoryBarrier ( )

inlinestatic

MessageBoxExt()

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

static

NeedsNonoptionalCPUFeaturesCheck()

bool FUnixPlatformMisc::NeedsNonoptionalCPUFeaturesCheck ( )

static

NormalizePath() [1/2]

void FUnixPlatformMisc::NormalizePath ( FString &  InPath )

static

NormalizePath() [2/2]

void FUnixPlatformMisc::NormalizePath ( FStringBuilderBase &  InPath )

static

NumberOfCores()

int32 FUnixPlatformMisc::NumberOfCores ( )

static

NumberOfCoresIncludingHyperthreads()

int32 FUnixPlatformMisc::NumberOfCoresIncludingHyperthreads ( )

static

NumberOfWorkerThreadsToSpawn()

int32 FUnixPlatformMisc::NumberOfWorkerThreadsToSpawn ( )

static

PlatformInit()

void FUnixPlatformMisc::PlatformInit ( )

static

PlatformPreInit()

void FUnixPlatformMisc::PlatformPreInit ( )

static

PlatformTearDown()

void FUnixPlatformMisc::PlatformTearDown ( )

static

RequestExit()

void FUnixPlatformMisc::RequestExit ( bool  Force, const TCHAR *  CallSite = nullptr  )

static

RequestExitWithStatus()

void FUnixPlatformMisc::RequestExitWithStatus ( bool  Force, uint8  ReturnCode, const TCHAR *  CallSite = nullptr  )

static

SetCrashHandler()

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

static

SetEnvironmentVar()

void FUnixPlatformMisc::SetEnvironmentVar ( const TCHAR *  VariableName, const TCHAR *  Value  )

static

SetGracefulTerminationHandler()

void FUnixPlatformMisc::SetGracefulTerminationHandler ( )

static

SetStoredValues()

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

static

SetupSyscallFilters()

bool FUnixPlatformMisc::SetupSyscallFilters ( )

static

UE_DEPRECATED()

FUnixPlatformMisc::UE_DEPRECATED	(	4.	21,
		"void FPlatformMisc::GetEnvironmentVariable(Name, Result, Length) is deprecated. Use FString FPlatformMisc::GetEnvironmentVariable(Name) instead."
	)		const

UngrabAllInput()

void FUnixPlatformMisc::UngrabAllInput ( )

static

Ungrabs input (useful before breaking into debugging)

Member Data Documentation

Result

TCHAR* FUnixPlatformMisc::Result

ResultLength

TCHAR int32 FUnixPlatformMisc::ResultLength

---

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

• Engine/Source/Runtime/Core/Public/Unix/UnixPlatformMisc.h
• Engine/Source/Runtime/Core/Private/Unix/UnixPlatformCrashContext.cpp
• Engine/Source/Runtime/Core/Private/Unix/UnixPlatformMisc.cpp
• Engine/Source/Runtime/Core/Private/Unix/UnixPlatformTime.cpp