MacPlatformMisc.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================================
    MacPlatformMisc.h: Mac platform misc functions
==============================================================================================*/
 
#pragma once
#include "GenericPlatform/GenericPlatformMisc.h"
#include "Mac/MacSystemIncludes.h"
#include "Apple/ApplePlatformMisc.h"
 
struct CORE_API FMacPlatformMisc : public FApplePlatformMisc
{
    static void PlatformPreInit();
    static void PlatformInit();
    static void PlatformTearDown();
 
    UE_FORCEINLINE_HINT static constexpr int32 GetMaxPathLength()
    {
        return MAC_MAX_PATH;
    }
 
    static const TCHAR* GetPathVarDelimiter()
    {
        return TEXT(":");
    }
 
    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() { return true; }
    static bool NeedsNonoptionalCPUFeaturesCheck() { return PLATFORM_ENABLE_POPCNT_INTRINSIC; }
 
    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();
 
#if WITH_EDITOR
    static bool IsRunningOnRecommendedMinSpecHardware();
#endif // WITH_EDITOR
 
    static void MergeDefaultArgumentsIntoCommandLine(FString& CommandLine, FString DefaultArguments);
    
    template<typename T>
    class FGPUDescriptorCommon
    {
        public:
            virtual ~FGPUDescriptorCommon();
 
            FGPUDescriptorCommon& operator=(FGPUDescriptorCommon const& Other);
 
            TMap<FString, float> GetPerformanceStatistics() const;
 
        protected:
            FGPUDescriptorCommon() = default;
            FGPUDescriptorCommon(FGPUDescriptorCommon const& Other) = delete;
            FGPUDescriptorCommon(FGPUDescriptorCommon&& Other) = delete;
 
            void CopyFrom(FGPUDescriptorCommon const& Other);
 
        public:
            NSString*   GPUName         = nil;
            NSString*   GPUMetalBundle  = nil;
            NSString*   GPUOpenGLBundle = nil;
            NSString*   GPUBundleID     = nil;
            uint32      GPUVendorId     = 0;
            uint32      GPUDeviceId     = 0;
            uint32      GPUMemoryMB     = 0;
            uint32      GPUIndex        = 0;
 
            bool GPUHeadless            = false;
    };
 
#if PLATFORM_MAC_X86
    typedef class FGPUDescriptorX86_64 : public FGPUDescriptorCommon<FGPUDescriptorX86_64>
    {
        friend class FGPUDescriptorCommon<FGPUDescriptorX86_64>;
 
        public:
            FGPUDescriptorX86_64() = default;
            FGPUDescriptorX86_64(FGPUDescriptorX86_64 const& Other);
 
            virtual ~FGPUDescriptorX86_64();
 
        protected:
            void CopyFromImpl(FGPUDescriptorCommon const& Other);
            TMap<FString, float> GetPerformanceStatisticsImpl() const;
 
        public:
            uint64 RegistryID;
            uint32 PCIDevice; // This is really an io_registry_entry_t which is a mach port name
 
    } FGPUDescriptor;
 
#elif PLATFORM_MAC_ARM64
    typedef class FGPUDescriptorARM64 : public FGPUDescriptorCommon<FGPUDescriptorARM64>
    {
        friend class FGPUDescriptorCommon<FGPUDescriptorARM64>;
 
        public:
            FGPUDescriptorARM64() = default;
            FGPUDescriptorARM64(FGPUDescriptorARM64 const& Other);
 
            virtual ~FGPUDescriptorARM64();
 
        protected:
            void CopyFromImpl(FGPUDescriptorCommon const& Other);
            TMap<FString, float> GetPerformanceStatisticsImpl() const;
 
        public:
            uint64 RegistryID = 0;
 
    } FGPUDescriptor;
 
#else
    #error "Undefined Mac platform"
#endif
 
    enum class EMacGPUNotification : uint8
    {
        Added,
        RemovalRequested,
        Removed
    };
    
    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);
 
    inline static void ChooseHDRDeviceAndColorGamut(uint32 DeviceId, uint32 DisplayNitLevel, EDisplayOutputFormat& OutputDevice, EDisplayColorGamut& ColorGamut)
    {
        // ScRGB, 1000 or 2000 nits, DCI-P3
        OutputDevice = DisplayNitLevel == 1000 ? EDisplayOutputFormat::HDR_ACES_1000nit_ScRGB : EDisplayOutputFormat::HDR_ACES_2000nit_ScRGB;
        ColorGamut = EDisplayColorGamut::DCIP3_D65;
    }
};
 
typedef FMacPlatformMisc FPlatformMisc;
 
enum EMacModifierKeys
{
    MMK_RightCommand    = 0xF754,
    MMK_LeftCommand     = 0xF755,
    MMK_LeftShift       = 0xF756,
    MMK_CapsLock        = 0xF757,
    MMK_LeftAlt         = 0xF758,
    MMK_LeftControl     = 0xF759,
    MMK_RightShift      = 0xF760,
    MMK_RightAlt        = 0xF761,
    MMK_RightControl    = 0xF762
};