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
FIOSPlatformMisc Struct Reference

#include <IOSPlatformMisc.h>

+ Inheritance diagram for FIOSPlatformMisc:

Classes

struct  FNetworkConnectionCharacteristics
 

Public Types

enum  EIOSAuthNotificationStatus {
  NotDetermined , Denied , Authorized , Provisional ,
  Ephemeral , Unknown
}
 
enum  EIOSDevice {
  IOS_IPhone4 , IOS_IPhone4S , IOS_IPhone5 , IOS_IPhone5S ,
  IOS_IPodTouch5 , IOS_IPodTouch6 , IOS_IPad2 , IOS_IPad3 ,
  IOS_IPad4 , IOS_IPadMini , IOS_IPadMini2 , IOS_IPadMini4 ,
  IOS_IPadAir , IOS_IPadAir2 , IOS_IPhone6 , IOS_IPhone6Plus ,
  IOS_IPhone6S , IOS_IPhone6SPlus , IOS_IPhone7 , IOS_IPhone7Plus ,
  IOS_IPhone8 , IOS_IPhone8Plus , IOS_IPhoneX , IOS_IPadPro ,
  IOS_AppleTV , IOS_AppleTV4K , IOS_IPhoneSE , IOS_IPadPro_129 ,
  IOS_IPadPro_97 , IOS_IPadPro_105 , IOS_IPadPro2_129 , IOS_IPad5 ,
  IOS_IPhoneXS , IOS_IPhoneXSMax , IOS_IPhoneXR , IOS_IPhone11 ,
  IOS_IPhone11Pro , IOS_IPhone11ProMax , IOS_IPad6 , IOS_IPadPro_11 ,
  IOS_IPadPro3_129 , IOS_IPadAir3 , IOS_IPadMini5 , IOS_IPodTouch7 ,
  IOS_IPad7 , IOS_IPhoneSE2 , IOS_IPadPro2_11 , IOS_IPadPro4_129 ,
  IOS_NewDevice1 , IOS_NewDevice2 , IOS_NewDevice3 , IOS_NewDevice4 ,
  IOS_NewDevice5 , IOS_NewDevice6 , IOS_NewDevice7 , IOS_NewDevice8 ,
  IOS_RealityPro , IOS_Unknown
}
 

Static Public Member Functions

static void PlatformPreInit ()
 
static void PlatformInit ()
 
static void PlatformHandleSplashScreen (bool ShowSplashScreen=false)
 
static const TCHAR * GetPlatformFeaturesModuleName ()
 
static FORCEINLINE constexpr int32 GetMaxPathLength ()
 
static bool AllowThreadHeartBeat ()
 
static EAppReturnType::Type MessageBoxExt (EAppMsgType::Type MsgType, const TCHAR *Text, const TCHAR *Caption)
 
static void SetMemoryWarningHandler (void(*Handler)(const FGenericMemoryWarningContext &Context))
 
static bool HasMemoryWarningHandler ()
 
static bool HasPlatformFeature (const TCHAR *FeatureName)
 
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 GetValidTargetPlatforms (class TArray< class FString > &TargetPlatformNames)
 
static ENetworkConnectionType GetNetworkConnectionType ()
 
static bool HasActiveWiFiConnection ()
 
static const TCHAR * GamePersistentDownloadDir ()
 
static bool HasSeparateChannelForDebugOutput ()
 
static void RequestExit (bool Force, const TCHAR *CallSite=nullptr)
 
static void RequestExitWithStatus (bool Force, uint8 ReturnCode, const TCHAR *CallSite=nullptr)
 
static int GetAudioVolume ()
 
static bool AreHeadphonesPluggedIn ()
 
static int GetBatteryLevel ()
 
static bool IsRunningOnBattery ()
 
static float GetDeviceTemperatureLevel ()
 
static EDeviceScreenOrientation GetDeviceOrientation ()
 
static void SetDeviceOrientation (EDeviceScreenOrientation NewDeviceOrientation)
 
static void SetAllowedDeviceOrientation (EDeviceScreenOrientation NewAllowedDeviceOrientation)
 
static int32 GetDeviceVolume ()
 
static void SetBrightness (float Brightness)
 
static float GetBrightness ()
 
static bool SupportsBrightness ()
 
static bool IsInLowPowerMode ()
 
static bool IsDesignedForIpadOnVisionOS ()
 
static bool IsDesignedForIpadOnMacOS ()
 
static void RegisterForRemoteNotifications ()
 
static bool IsRegisteredForRemoteNotifications ()
 
static void UnregisterForRemoteNotifications ()
 
static bool IsAllowedRemoteNotifications ()
 
static EIOSAuthNotificationStatus GetNotificationAuthorizationStatus ()
 
static FString GetPendingActivationProtocol ()
 
static bool IsEntitlementEnabled (const char *EntitlementToCheck)
 
static class IPlatformChunkInstall * GetPlatformChunkInstall ()
 
static bool SupportsForceTouchInput ()
 
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 FString LoadTextFileFromPlatformPackage (const FString &RelativePath)
 
static bool FileExistsInPlatformPackage (const FString &RelativePath)
 
static void EnableVoiceChat (bool bEnable)
 
static bool IsVoiceChatEnabled ()
 
static bool HasRecordPermission ()
 
static int GetDefaultStackSize ()
 
static void HandleLowMemoryWarning ()
 
static bool IsPackagedForDistribution ()
 
static FString GetDeviceId ()
 
static FString GetOSVersion ()
 
static FString GetUniqueAdvertisingId ()
 
static bool GetDiskTotalAndFreeSpace (const FString &InPath, uint64 &OutTotalNumberOfBytes, uint64 &OutNumberOfFreeBytes, bool bInIncludeFreeable=true)
 
static void RequestStoreReview ()
 
static bool IsUpdateAvailable ()
 
static EIOSDevice GetIOSDeviceType ()
 
static const TCHAR * GetDefaultDeviceProfileName ()
 
static FString GetCPUVendor ()
 
static FString GetCPUBrand ()
 
static void GetOSVersions (FString &out_OSVersionLabel, FString &out_OSSubVersionLabel)
 
static int32 IOSVersionCompare (uint8 Major, uint8 Minor, uint8 Revision)
 
static FString GetProjectVersion ()
 
static FString GetBuildNumber ()
 
static bool IsBackgroundAppRefreshAvailable ()
 
static void OpenAppNotificationSettings ()
 
static void OpenAppCustomSettings ()
 
static void SetGracefulTerminationHandler ()
 
static void SetCrashHandler (void(*CrashHandler)(const FGenericCrashContext &Context))
 
static bool SupportsDeviceCheckToken ()
 
static bool RequestDeviceCheckToken (TFunction< void(const TArray< uint8 > &)> QuerySucceededFunc, TFunction< void(const FString &, const FString &)> QueryFailedFunc)
 
static TMulticastDelegateRegistration< void(FNetworkConnectionCharacteristics), FDefaultTSDelegateUserPolicy > & OnNetworkConnectionCharacteristicsChanged ()
 
static FORCEINLINE void ChooseHDRDeviceAndColorGamut (uint32 DeviceId, uint32 DisplayNitLevel, EDisplayOutputFormat &OutputDevice, EDisplayColorGamut &ColorGamut)
 
static int32 GetMaxRefreshRate ()
 
static FORCENOINLINE CA_NO_RETURN void GPUAssert ()
 
static FORCENOINLINE CA_NO_RETURN void MetalAssert ()
 
static bool CPUHasHwCrcSupport ()
 
static bool CPUHasHwAesSupport ()
 
static FString GetDiscardableCacheDir ()
 
static bool IsConsoleOpen ()
 
static const class TMap< FString, FString > & GetConfigRuleVars ()
 
- 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

iOS implementation of the misc OS functions

Member Enumeration Documentation

◆ EIOSAuthNotificationStatus

enum FIOSPlatformMisc::EIOSAuthNotificationStatus
Enumerator
NotDetermined 
Denied 
Authorized 
Provisional 
Ephemeral 
Unknown 

◆ EIOSDevice

enum FIOSPlatformMisc::EIOSDevice
Enumerator
IOS_IPhone4 
IOS_IPhone4S 
IOS_IPhone5 
IOS_IPhone5S 
IOS_IPodTouch5 
IOS_IPodTouch6 
IOS_IPad2 
IOS_IPad3 
IOS_IPad4 
IOS_IPadMini 
IOS_IPadMini2 
IOS_IPadMini4 
IOS_IPadAir 
IOS_IPadAir2 
IOS_IPhone6 
IOS_IPhone6Plus 
IOS_IPhone6S 
IOS_IPhone6SPlus 
IOS_IPhone7 
IOS_IPhone7Plus 
IOS_IPhone8 
IOS_IPhone8Plus 
IOS_IPhoneX 
IOS_IPadPro 
IOS_AppleTV 
IOS_AppleTV4K 
IOS_IPhoneSE 
IOS_IPadPro_129 
IOS_IPadPro_97 
IOS_IPadPro_105 
IOS_IPadPro2_129 
IOS_IPad5 
IOS_IPhoneXS 
IOS_IPhoneXSMax 
IOS_IPhoneXR 
IOS_IPhone11 
IOS_IPhone11Pro 
IOS_IPhone11ProMax 
IOS_IPad6 
IOS_IPadPro_11 
IOS_IPadPro3_129 
IOS_IPadAir3 
IOS_IPadMini5 
IOS_IPodTouch7 
IOS_IPad7 
IOS_IPhoneSE2 
IOS_IPadPro2_11 
IOS_IPadPro4_129 
IOS_NewDevice1 
IOS_NewDevice2 
IOS_NewDevice3 
IOS_NewDevice4 
IOS_NewDevice5 
IOS_NewDevice6 
IOS_NewDevice7 
IOS_NewDevice8 
IOS_RealityPro 
IOS_Unknown 

Member Function Documentation

◆ AllowThreadHeartBeat()

static bool FIOSPlatformMisc::AllowThreadHeartBeat ( )
inlinestatic

◆ AreHeadphonesPluggedIn()

bool FIOSPlatformMisc::AreHeadphonesPluggedIn ( )
static

◆ ChooseHDRDeviceAndColorGamut()

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

◆ CPUHasHwAesSupport()

bool FIOSPlatformMisc::CPUHasHwAesSupport ( )
static

◆ CPUHasHwCrcSupport()

bool FIOSPlatformMisc::CPUHasHwCrcSupport ( )
static

◆ DeleteStoredSection()

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

◆ DeleteStoredValue()

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

◆ EnableVoiceChat()

void FIOSPlatformMisc::EnableVoiceChat ( bool  bEnable)
static

◆ FileExistsInPlatformPackage()

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

◆ GamePersistentDownloadDir()

const TCHAR * FIOSPlatformMisc::GamePersistentDownloadDir ( )
static

◆ GetAudioVolume()

int FIOSPlatformMisc::GetAudioVolume ( )
static

◆ GetBatteryLevel()

int FIOSPlatformMisc::GetBatteryLevel ( )
static

◆ GetBrightness()

float FIOSPlatformMisc::GetBrightness ( )
static

◆ GetBuildNumber()

FString FIOSPlatformMisc::GetBuildNumber ( )
static

◆ GetConfigRuleVars()

const TMap< FString, FString > & FIOSPlatformMisc::GetConfigRuleVars ( )
static

◆ GetCPUBrand()

FString FIOSPlatformMisc::GetCPUBrand ( )
static

◆ GetCPUVendor()

FString FIOSPlatformMisc::GetCPUVendor ( )
static

◆ GetDefaultDeviceProfileName()

const TCHAR * FIOSPlatformMisc::GetDefaultDeviceProfileName ( )
static

◆ GetDefaultStackSize()

int FIOSPlatformMisc::GetDefaultStackSize ( )
static

◆ GetDeviceId()

FString FIOSPlatformMisc::GetDeviceId ( )
static

Implemented using UIDevice::identifierForVendor, so all the caveats that apply to that API call apply here.

◆ GetDeviceOrientation()

EDeviceScreenOrientation FIOSPlatformMisc::GetDeviceOrientation ( )
static

◆ GetDeviceTemperatureLevel()

float FIOSPlatformMisc::GetDeviceTemperatureLevel ( )
static

◆ GetDeviceVolume()

int32 FIOSPlatformMisc::GetDeviceVolume ( )
static

◆ GetDiscardableCacheDir()

FString FIOSPlatformMisc::GetDiscardableCacheDir ( )
static

◆ GetDiskTotalAndFreeSpace()

bool FIOSPlatformMisc::GetDiskTotalAndFreeSpace ( const FString &  InPath,
uint64 &  OutTotalNumberOfBytes,
uint64 &  OutNumberOfFreeBytes,
bool  bInIncludeFreeable = true 
)
static

◆ GetIOSDeviceType()

FIOSPlatformMisc::EIOSDevice FIOSPlatformMisc::GetIOSDeviceType ( )
static

◆ GetMaxPathLength()

static FORCEINLINE constexpr int32 FIOSPlatformMisc::GetMaxPathLength ( )
inlinestaticconstexpr

◆ GetMaxRefreshRate()

int32 FIOSPlatformMisc::GetMaxRefreshRate ( )
static

◆ GetNetworkConnectionType()

ENetworkConnectionType FIOSPlatformMisc::GetNetworkConnectionType ( )
static

◆ GetNotificationAuthorizationStatus()

FIOSPlatformMisc::EIOSAuthNotificationStatus FIOSPlatformMisc::GetNotificationAuthorizationStatus ( )
static

◆ GetOSVersion()

FString FIOSPlatformMisc::GetOSVersion ( )
static

◆ GetOSVersions()

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

◆ GetPendingActivationProtocol()

FString FIOSPlatformMisc::GetPendingActivationProtocol ( )
static

◆ GetPlatformChunkInstall()

class IPlatformChunkInstall * FIOSPlatformMisc::GetPlatformChunkInstall ( )
static

◆ GetPlatformFeaturesModuleName()

const TCHAR * FIOSPlatformMisc::GetPlatformFeaturesModuleName ( )
static

◆ GetProjectVersion()

FString FIOSPlatformMisc::GetProjectVersion ( )
static

◆ GetStoredValue()

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

◆ GetUniqueAdvertisingId()

FString FIOSPlatformMisc::GetUniqueAdvertisingId ( )
static

Returns a unique string for advertising identification

Returns
the unique string generated by this platform for this device

◆ GetValidTargetPlatforms()

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

◆ GPUAssert()

void FIOSPlatformMisc::GPUAssert ( )
static

◆ HandleLowMemoryWarning()

void FIOSPlatformMisc::HandleLowMemoryWarning ( )
static

◆ HasActiveWiFiConnection()

bool FIOSPlatformMisc::HasActiveWiFiConnection ( )
static

◆ HasMemoryWarningHandler()

bool FIOSPlatformMisc::HasMemoryWarningHandler ( )
static

◆ HasPlatformFeature()

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

◆ HasRecordPermission()

bool FIOSPlatformMisc::HasRecordPermission ( )
static

◆ HasSeparateChannelForDebugOutput()

bool FIOSPlatformMisc::HasSeparateChannelForDebugOutput ( )
static

◆ IOSVersionCompare()

int32 FIOSPlatformMisc::IOSVersionCompare ( uint8  Major,
uint8  Minor,
uint8  Revision 
)
static

◆ IsAllowedRemoteNotifications()

bool FIOSPlatformMisc::IsAllowedRemoteNotifications ( )
static

◆ IsBackgroundAppRefreshAvailable()

bool FIOSPlatformMisc::IsBackgroundAppRefreshAvailable ( )
static
Returns
true if the app is able to refresh in the background

◆ IsConsoleOpen()

bool FIOSPlatformMisc::IsConsoleOpen ( )
static

◆ IsDesignedForIpadOnMacOS()

bool FIOSPlatformMisc::IsDesignedForIpadOnMacOS ( )
static

◆ IsDesignedForIpadOnVisionOS()

bool FIOSPlatformMisc::IsDesignedForIpadOnVisionOS ( )
static

◆ IsEntitlementEnabled()

bool FIOSPlatformMisc::IsEntitlementEnabled ( const char *  EntitlementToCheck)
static

◆ IsInLowPowerMode()

bool FIOSPlatformMisc::IsInLowPowerMode ( )
static

◆ IsPackagedForDistribution()

bool FIOSPlatformMisc::IsPackagedForDistribution ( )
static

◆ IsRegisteredForRemoteNotifications()

bool FIOSPlatformMisc::IsRegisteredForRemoteNotifications ( )
static

◆ IsRunningOnBattery()

bool FIOSPlatformMisc::IsRunningOnBattery ( )
static

◆ IsUpdateAvailable()

bool FIOSPlatformMisc::IsUpdateAvailable ( )
static

◆ IsVoiceChatEnabled()

bool FIOSPlatformMisc::IsVoiceChatEnabled ( )
static

◆ LoadTextFileFromPlatformPackage()

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

◆ MessageBoxExt()

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

◆ MetalAssert()

void FIOSPlatformMisc::MetalAssert ( )
static

◆ OnNetworkConnectionCharacteristicsChanged()

TMulticastDelegateRegistration< void(FIOSPlatformMisc::FNetworkConnectionCharacteristics), FDefaultTSDelegateUserPolicy > & FIOSPlatformMisc::OnNetworkConnectionCharacteristicsChanged ( )
static

◆ OpenAppCustomSettings()

void FIOSPlatformMisc::OpenAppCustomSettings ( )
static

Open the app's custom settings in the Settings App.

◆ OpenAppNotificationSettings()

void FIOSPlatformMisc::OpenAppNotificationSettings ( )
static

Open the Settings app at the Notification page for this app.

◆ PlatformHandleSplashScreen()

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

◆ PlatformInit()

void FIOSPlatformMisc::PlatformInit ( )
static

◆ PlatformPreInit()

void FIOSPlatformMisc::PlatformPreInit ( )
static

◆ PrepareMobileHaptics()

void FIOSPlatformMisc::PrepareMobileHaptics ( EMobileHapticsType  Type)
static

◆ RegisterForRemoteNotifications()

void FIOSPlatformMisc::RegisterForRemoteNotifications ( )
static

◆ ReleaseMobileHaptics()

void FIOSPlatformMisc::ReleaseMobileHaptics ( )
static

◆ RequestDeviceCheckToken()

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

◆ RequestExit()

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

◆ RequestExitWithStatus()

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

◆ RequestStoreReview()

void FIOSPlatformMisc::RequestStoreReview ( )
static

◆ SetAllowedDeviceOrientation()

void FIOSPlatformMisc::SetAllowedDeviceOrientation ( EDeviceScreenOrientation  NewAllowedDeviceOrientation)
static

◆ SetBrightness()

void FIOSPlatformMisc::SetBrightness ( float  Brightness)
static

◆ SetCrashHandler()

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

◆ SetDeviceOrientation()

void FIOSPlatformMisc::SetDeviceOrientation ( EDeviceScreenOrientation  NewDeviceOrientation)
static

◆ SetGracefulTerminationHandler()

void FIOSPlatformMisc::SetGracefulTerminationHandler ( )
static

◆ SetMemoryWarningHandler()

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

◆ SetStoredValue()

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

◆ ShareURL()

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

◆ SupportsBrightness()

static bool FIOSPlatformMisc::SupportsBrightness ( )
inlinestatic

◆ SupportsDeviceCheckToken()

static bool FIOSPlatformMisc::SupportsDeviceCheckToken ( )
inlinestatic

◆ SupportsForceTouchInput()

bool FIOSPlatformMisc::SupportsForceTouchInput ( )
static

◆ TriggerMobileHaptics()

void FIOSPlatformMisc::TriggerMobileHaptics ( )
static

◆ UnregisterForRemoteNotifications()

void FIOSPlatformMisc::UnregisterForRemoteNotifications ( )
static
The documentation for this struct was generated from the following files: