UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Types | Static Public Member Functions | List of all members
FMacPlatformMisc Struct Reference

#include <MacPlatformMisc.h>

+ Inheritance diagram for FMacPlatformMisc:

Classes

class  FGPUDescriptorCommon
 

Public Types

enum class  EMacGPUNotification : uint8 { Added , RemovalRequested , Removed }
 

Static Public Member Functions

static void PlatformPreInit ()
 
static void PlatformInit ()
 
static void PlatformTearDown ()
 
static UE_FORCEINLINE_HINT constexpr int32 GetMaxPathLength ()
 
static const TCHAR * GetPathVarDelimiter ()
 
static TArray< uint8 > GetMacAddress ()
 
static void RequestExit (bool Force, const TCHAR *CallSite=nullptr)
 
static EAppReturnType::Type MessageBoxExt (EAppMsgType::Type MsgType, const TCHAR *Text, const TCHAR *Caption)
 
static bool CommandLineCommands ()
 
static int32 NumberOfCores ()
 
static int32 NumberOfCoresIncludingHyperthreads ()
 
static void NormalizePath (FString &InPath)
 
static void NormalizePath (FStringBuilderBase &InPath)
 
static FString GetPrimaryGPUBrand ()
 
static struct FGPUDriverInfo GetGPUDriverInfo (const FString &DeviceDescription, bool bVerbose=true)
 
static void GetOSVersions (FString &out_OSVersionLabel, FString &out_OSSubVersionLabel)
 
static FString GetOSVersion ()
 
static NSOperatingSystemVersion GetNSOperatingSystemVersion ()
 
static bool HasPlatformFeature (const TCHAR *FeatureName)
 
static bool GetDiskTotalAndFreeSpace (const FString &InPath, uint64 &TotalNumberOfBytes, uint64 &NumberOfFreeBytes)
 
static bool HasSeparateChannelForDebugOutput ()
 
static FString GetBonjourName ()
 
static CORE_API const TCHAR * GetNullRHIShaderFormat ()
 
static FString GetCPUVendor ()
 
static FString GetCPUBrand ()
 
static uint32 GetCPUInfo ()
 
static bool HasNonoptionalCPUFeatures ()
 
static bool NeedsNonoptionalCPUFeaturesCheck ()
 
static void SetGracefulTerminationHandler ()
 
static void SetCrashHandler (void(*CrashHandler)(const FGenericCrashContext &Context))
 
static FText GetFileManagerName ()
 
static bool IsRunningOnBattery ()
 
static IPlatformChunkInstall * GetPlatformChunkInstall ()
 
static int32 VersionCompare (const NSOperatingSystemVersion &VersionA, const NSOperatingSystemVersion &VersionB)
 
static int32 MacOSXVersionCompare (uint8 Major, uint8 Minor, uint8 Revision)
 
static FString GetOperatingSystemId ()
 
static FString GetXcodePath ()
 
static int32 XCodeVersionCompare (uint8 Major, uint8 Minor, uint8 Revision)
 
static bool IsSupportedXcodeVersionInstalled ()
 
static void MergeDefaultArgumentsIntoCommandLine (FString &CommandLine, FString DefaultArguments)
 
static void GPUChangeNotification (uint64_t DeviceRegistryID, EMacGPUNotification Notification)
 
static TArray< FGPUDescriptor > const & GetGPUDescriptors ()
 
static int32 GetExplicitRendererIndex ()
 
static void UpdateDriverMonitorStatistics (int32 DeviceIndex)
 
static int GetDefaultStackSize ()
 
static void PostInitMacAppInfoUpdate ()
 
static CGDisplayModeRef GetSupportedDisplayMode (CGDirectDisplayID DisplayID, uint32 Width, uint32 Height)
 
static void ChooseHDRDeviceAndColorGamut (uint32 DeviceId, uint32 DisplayNitLevel, EDisplayOutputFormat &OutputDevice, EDisplayColorGamut &ColorGamut)
 
- Static Public Member Functions inherited from FApplePlatformMisc
static void PlatformInit ()
 
static FString GetEnvironmentVariable (const TCHAR *VariableName)
 
static bool IsDebuggerPresent ()
 
static UE_FORCEINLINE_HINT void MemoryBarrier ()
 
static void LocalPrint (const TCHAR *Message)
 
static const TCHAR * GetSystemErrorMessage (TCHAR *OutBuffer, int32 BufferCount, int32 Error)
 
static uint32 GetLastError ()
 
static int32 NumberOfCores ()
 
static bool SupportsMultithreadedFileHandles ()
 
static void CreateGuid (struct FGuid &Result)
 
static TArray< uint8 > GetSystemFontBytes ()
 
static FString GetDefaultLocale ()
 
static FString GetDefaultLanguage ()
 
static FString GetLocalCurrencyCode ()
 
static FString GetLocalCurrencySymbol ()
 
static bool IsOSAtLeastVersion (const uint32 MacOSVersion[3], const uint32 IOSVersion[3], const uint32 TVOSVersion[3])
 
static void * CreateAutoreleasePool ()
 
static void ReleaseAutoreleasePool (void *Pool)
 
static CORE_API void SetEnvironmentVar (const TCHAR *InVariableName, const TCHAR *Value)
 
- 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)
 

Additional Inherited Members

- Public Member Functions inherited from FApplePlatformMisc
 UE_DEPRECATED (4.21, "void FPlatformMisc::GetEnvironmentVariable(Name, Result, Length) is deprecated. Use FString FPlatformMisc::GetEnvironmentVariable(Name) instead.") static 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)
 
- Public Attributes inherited from FApplePlatformMisc
TCHAR * Result
 
TCHAR int32 ResultLength
 
- 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

Mac implementation of the misc OS functions

Member Enumeration Documentation

◆ EMacGPUNotification

enum class FMacPlatformMisc::EMacGPUNotification : uint8
strong
Enumerator
Added 
RemovalRequested 
Removed 

Member Function Documentation

◆ ChooseHDRDeviceAndColorGamut()

static void FMacPlatformMisc::ChooseHDRDeviceAndColorGamut ( uint32  DeviceId,
uint32  DisplayNitLevel,
EDisplayOutputFormat &  OutputDevice,
EDisplayColorGamut &  ColorGamut 
)
inlinestatic

◆ CommandLineCommands()

bool FMacPlatformMisc::CommandLineCommands ( )
static

◆ GetBonjourName()

FString FMacPlatformMisc::GetBonjourName ( )
static

◆ GetCPUBrand()

FString FMacPlatformMisc::GetCPUBrand ( )
static

Uses cpuid instruction to get the CPU brand string

Returns
CPU brand string

◆ GetCPUInfo()

uint32 FMacPlatformMisc::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

◆ GetCPUVendor()

FString FMacPlatformMisc::GetCPUVendor ( )
static

Uses cpuid instruction to get the vendor string

Returns
CPU vendor name

◆ GetDefaultStackSize()

int FMacPlatformMisc::GetDefaultStackSize ( )
static

◆ GetDiskTotalAndFreeSpace()

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

◆ GetExplicitRendererIndex()

int32 FMacPlatformMisc::GetExplicitRendererIndex ( )
static

Returns the index of the GPU to use or -1 if we should just use the default.

◆ GetFileManagerName()

FText FMacPlatformMisc::GetFileManagerName ( )
static
Returns
Get the name of the platform specific file manager (Finder)

◆ GetGPUDescriptors()

TArray< FMacPlatformMisc::FGPUDescriptor > const & FMacPlatformMisc::GetGPUDescriptors ( )
static

Returns the static list of GPUs in the current machine.

◆ GetGPUDriverInfo()

FGPUDriverInfo FMacPlatformMisc::GetGPUDriverInfo ( const FString &  DeviceDescription,
bool  bVerbose = true 
)
static

◆ GetMacAddress()

TArray< uint8 > FMacPlatformMisc::GetMacAddress ( )
static

◆ GetMaxPathLength()

static UE_FORCEINLINE_HINT constexpr int32 FMacPlatformMisc::GetMaxPathLength ( )
inlinestaticconstexpr

◆ GetNSOperatingSystemVersion()

NSOperatingSystemVersion FMacPlatformMisc::GetNSOperatingSystemVersion ( )
static

◆ GetNullRHIShaderFormat()

const TCHAR * FMacPlatformMisc::GetNullRHIShaderFormat ( )
static

Determines the shader format for the plarform

Returns
Returns the shader format to be used by that platform

◆ GetOperatingSystemId()

FString FMacPlatformMisc::GetOperatingSystemId ( )
static

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

◆ GetOSVersion()

FString FMacPlatformMisc::GetOSVersion ( )
static

◆ GetOSVersions()

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

◆ GetPathVarDelimiter()

static const TCHAR * FMacPlatformMisc::GetPathVarDelimiter ( )
inlinestatic

◆ GetPlatformChunkInstall()

IPlatformChunkInstall * FMacPlatformMisc::GetPlatformChunkInstall ( )
static

◆ GetPrimaryGPUBrand()

FString FMacPlatformMisc::GetPrimaryGPUBrand ( )
static

◆ GetSupportedDisplayMode()

CGDisplayModeRef FMacPlatformMisc::GetSupportedDisplayMode ( CGDirectDisplayID  DisplayID,
uint32  Width,
uint32  Height 
)
static

◆ GetXcodePath()

FString FMacPlatformMisc::GetXcodePath ( )
static

◆ GPUChangeNotification()

void FMacPlatformMisc::GPUChangeNotification ( uint64_t  DeviceRegistryID,
EMacGPUNotification  Notification 
)
static

Handle GPU change notifications.

◆ HasNonoptionalCPUFeatures()

static bool FMacPlatformMisc::HasNonoptionalCPUFeatures ( )
inlinestatic

◆ HasPlatformFeature()

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

◆ HasSeparateChannelForDebugOutput()

bool FMacPlatformMisc::HasSeparateChannelForDebugOutput ( )
static

◆ IsRunningOnBattery()

bool FMacPlatformMisc::IsRunningOnBattery ( )
static

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

◆ IsSupportedXcodeVersionInstalled()

bool FMacPlatformMisc::IsSupportedXcodeVersionInstalled ( )
static

◆ MacOSXVersionCompare()

int32 FMacPlatformMisc::MacOSXVersionCompare ( uint8  Major,
uint8  Minor,
uint8  Revision 
)
static

Returns if current < target returns 1, if current > target returns 1, else current == target and returns 0.

◆ MergeDefaultArgumentsIntoCommandLine()

static void FMacPlatformMisc::MergeDefaultArgumentsIntoCommandLine ( FString &  CommandLine,
FString  DefaultArguments 
)
static

◆ MessageBoxExt()

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

◆ NeedsNonoptionalCPUFeaturesCheck()

static bool FMacPlatformMisc::NeedsNonoptionalCPUFeaturesCheck ( )
inlinestatic

◆ NormalizePath() [1/2]

void FMacPlatformMisc::NormalizePath ( FString &  InPath)
static

◆ NormalizePath() [2/2]

void FMacPlatformMisc::NormalizePath ( FStringBuilderBase &  InPath)
static

◆ NumberOfCores()

int32 FMacPlatformMisc::NumberOfCores ( )
static

◆ NumberOfCoresIncludingHyperthreads()

int32 FMacPlatformMisc::NumberOfCoresIncludingHyperthreads ( )
static

◆ PlatformInit()

void FMacPlatformMisc::PlatformInit ( )
static

◆ PlatformPreInit()

void FMacPlatformMisc::PlatformPreInit ( )
static

◆ PlatformTearDown()

void FMacPlatformMisc::PlatformTearDown ( )
static

◆ PostInitMacAppInfoUpdate()

void FMacPlatformMisc::PostInitMacAppInfoUpdate ( )
static

Updates variables in GMacAppInfo that cannot be initialized before PlatformPostInit()

◆ RequestExit()

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

◆ SetCrashHandler()

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

◆ SetGracefulTerminationHandler()

void FMacPlatformMisc::SetGracefulTerminationHandler ( )
static

◆ UpdateDriverMonitorStatistics()

void FMacPlatformMisc::UpdateDriverMonitorStatistics ( int32  DeviceIndex)
static

Update the driver monitor statistics for the given GPU - called once a frame by the Mac RHI's, no need to call otherwise - use GetPerformanceStatistics instead.

◆ VersionCompare()

int32 FMacPlatformMisc::VersionCompare ( const NSOperatingSystemVersion &  VersionA,
const NSOperatingSystemVersion &  VersionB 
)
static

Returns if A < B returns -1, if A > B returns 1, else A == B and returns 0.

◆ XCodeVersionCompare()

int32 FMacPlatformMisc::XCodeVersionCompare ( uint8  Major,
uint8  Minor,
uint8  Revision 
)
static

Returns if current < target returns 1, if current > target returns 1, else current == target and returns 0.

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