UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FAndroidMisc Struct Reference

#include <AndroidPlatformMisc.h>

+ Inheritance diagram for FAndroidMisc:

Classes

struct  FBatteryState
 
struct  FCPUState
 
struct  FCPUStatTime
 

Public Types

enum  EBatteryState {
  BATTERY_STATE_UNKNOWN = 1 , BATTERY_STATE_CHARGING , BATTERY_STATE_DISCHARGING , BATTERY_STATE_NOT_CHARGING ,
  BATTERY_STATE_FULL
}
 
enum class  ECoreFrequencyProperty { CurrentFrequency , MaxFrequency , MinFrequency }
 
typedef TFunction< void(void *NewNativeHandle)> ReInitWindowCallbackType
 
typedef TFunction< void()> ReleaseWindowCallbackType
 
typedef TFunction< void()> OnPauseCallBackType
 

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 RequestExit (bool Force, const TCHAR *CallSite=nullptr)
 
static CORE_API bool RestartApplication ()
 
static CORE_API void LocalPrint (const TCHAR *Message)
 
static bool IsLocalPrintThreadSafe ()
 
static CORE_API void PlatformPreInit ()
 
static CORE_API void PlatformInit ()
 
static CORE_API void PlatformTearDown ()
 
static CORE_API void PlatformHandleSplashScreen (bool ShowSplashScreen)
 
static EDeviceScreenOrientation GetDeviceOrientation ()
 
static CORE_API void SetDeviceOrientation (EDeviceScreenOrientation NewDeviceOrentation)
 
static CORE_API void SetAllowedDeviceOrientation (EDeviceScreenOrientation NewAllowedDeviceOrientation)
 
static CORE_API void SetCellularPreference (int32 Value)
 
static CORE_API int32 GetCellularPreference ()
 
static UE_FORCEINLINE_HINT int32 GetMaxPathLength ()
 
static CORE_API FString GetEnvironmentVariable (const TCHAR *VariableName)
 
static CORE_API const TCHARGetSystemErrorMessage (TCHAR *OutBuffer, int32 BufferCount, int32 Error)
 
static CORE_API EAppReturnType::Type MessageBoxExt (EAppMsgType::Type MsgType, const TCHAR *Text, const TCHAR *Caption)
 
static CORE_API bool UseRenderThread ()
 
static CORE_API bool HasPlatformFeature (const TCHAR *FeatureName)
 
static CORE_API bool SupportsES30 ()
 
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 bool AllowThreadHeartBeat ()
 
static CORE_API FCPUStateGetCPUState ()
 
static CORE_API int32 NumberOfCores ()
 
static CORE_API int32 NumberOfCoresIncludingHyperthreads ()
 
static CORE_API bool SupportsLocalCaching ()
 
static CORE_API void CreateGuid (struct FGuid &Result)
 
static CORE_API void SetCrashHandler (void(*CrashHandler)(const FGenericCrashContext &Context))
 
static CORE_API void GetValidTargetPlatforms (class TArray< class FString > &TargetPlatformNames)
 
static CORE_API bool GetUseVirtualJoysticks ()
 
static CORE_API bool SupportsTouchInput ()
 
static const TCHARGetDefaultDeviceProfileName ()
 
static CORE_API bool GetVolumeButtonsHandledBySystem ()
 
static CORE_API void SetVolumeButtonsHandledBySystem (bool enabled)
 
static CORE_API int GetVolumeState (double *OutTimeOfChangeInSec=nullptr)
 
static CORE_API int32 GetDeviceVolume ()
 
static CORE_API FString GetCPUVendor ()
 
static CORE_API FString GetCPUBrand ()
 
static CORE_API FString GetCPUChipset ()
 
static CORE_API FString GetPrimaryGPUBrand ()
 
static CORE_API void GetOSVersions (FString &out_OSVersionLabel, FString &out_OSSubVersionLabel)
 
static CORE_API bool GetDiskTotalAndFreeSpace (const FString &InPath, uint64 &TotalNumberOfBytes, uint64 &NumberOfFreeBytes)
 
static CORE_API FBatteryState GetBatteryState ()
 
static CORE_API int GetBatteryLevel ()
 
static CORE_API bool IsRunningOnBattery ()
 
static CORE_API bool IsInLowPowerMode ()
 
static CORE_API float GetDeviceTemperatureLevel ()
 
static CORE_API bool AreHeadPhonesPluggedIn ()
 
static CORE_API ENetworkConnectionType GetNetworkConnectionType ()
 
static CORE_API void RegisterForRemoteNotifications ()
 
static CORE_API void UnregisterForRemoteNotifications ()
 
static CORE_API bool IsAllowedRemoteNotifications ()
 
static CORE_API void HandleNewIntentUri (const FString &IntentUri)
 
static CORE_API FString GetPendingActivationProtocol ()
 
static CORE_API TArray< uint8GetSystemFontBytes ()
 
static CORE_API IPlatformChunkInstallGetPlatformChunkInstall ()
 
static CORE_API void PrepareMobileHaptics (EMobileHapticsType Type)
 
static CORE_API void TriggerMobileHaptics ()
 
static CORE_API void ReleaseMobileHaptics ()
 
static CORE_API void ShareURL (const FString &URL, const FText &Description, int32 LocationHintX, int32 LocationHintY)
 
static CORE_API FString LoadTextFileFromPlatformPackage (const FString &RelativePath)
 
static CORE_API bool FileExistsInPlatformPackage (const FString &RelativePath)
 
static CORE_API void SetVersionInfo (FString AndroidVersion, int32 InTargetSDKVersion, FString DeviceMake, FString DeviceModel, FString DeviceBuildNumber, FString OSLanguage, FString ProductName)
 
static CORE_API const FString GetAndroidVersion ()
 
static CORE_API int32 GetAndroidMajorVersion ()
 
static CORE_API int32 GetTargetSDKVersion ()
 
static CORE_API const FString GetDeviceMake ()
 
static CORE_API const FString GetDeviceModel ()
 
static CORE_API const FString GetOSLanguage ()
 
static CORE_API const FString GetProductName ()
 
static CORE_API const FString GetDeviceBuildNumber ()
 
static CORE_API const FString GetProjectVersion ()
 
static CORE_API FString GetDefaultLocale ()
 
static CORE_API FString GetGPUFamily ()
 
static CORE_API FString GetGLVersion ()
 
static CORE_API bool SupportsFloatingPointRenderTargets ()
 
static CORE_API bool SupportsShaderFramebufferFetch ()
 
static CORE_API bool SupportsShaderIOBlocks ()
 
static CORE_API bool IsSupportedAndroidDevice ()
 
static CORE_API void SetForceUnsupported (bool bInOverride)
 
static CORE_API const TMap< FString, FString > & GetConfigRuleVars ()
 
static CORE_API bool HasVulkanDriverSupport ()
 
static CORE_API bool IsVulkanAvailable ()
 
static CORE_API bool IsDesktopVulkanAvailable ()
 
static CORE_API bool ShouldUseVulkan ()
 
static CORE_API bool ShouldUseDesktopVulkan ()
 
static CORE_API FString GetVulkanVersion ()
 
static CORE_API FString GetVKQualityRecommendation ()
 
static CORE_API FString GetVulkanDeviceNameString ()
 
static CORE_API bool IsExternalMemoryAndroidHardwareBufferExtensionLoaded ()
 
static CORE_API ReInitWindowCallbackType GetOnReInitWindowCallback ()
 
static CORE_API void SetOnReInitWindowCallback (ReInitWindowCallbackType InOnReInitWindowCallback)
 
static CORE_API ReleaseWindowCallbackType GetOnReleaseWindowCallback ()
 
static CORE_API void SetOnReleaseWindowCallback (ReleaseWindowCallbackType InOnReleaseWindowCallback)
 
static CORE_API FString GetOSVersion ()
 
static bool GetOverrideResolution (int32 &ResX, int32 &ResY)
 
static CORE_API OnPauseCallBackType GetOnPauseCallback ()
 
static CORE_API void SetOnPauseCallback (OnPauseCallBackType InOnPauseCallback)
 
static CORE_API void TriggerCrashHandler (ECrashContextType InType, const TCHAR *InErrorMessage, const TCHAR *OverrideCallstack=nullptr)
 
static CORE_API FString GetFatalSignalMessage (int Signal, siginfo *Info)
 
static CORE_API void OverrideFatalSignalHandler (void(*FatalSignalHandlerOverrideFunc)(int Signal, struct siginfo *Info, void *Context, uint32 CrashingThreadId))
 
static CORE_API bool IsInSignalHandler ()
 
static CORE_API bool IsDebuggerPresent ()
 
static UE_FORCEINLINE_HINT void MemoryBarrier ()
 
static CORE_API bool UseNewWindowBehavior ()
 
static CORE_API uint32 GetCoreFrequency (int32 CoreIndex, ECoreFrequencyProperty CoreFrequencyProperty)
 
static CORE_API float GetCPUTemperature ()
 
static CORE_API void UpdateDeviceOrientation ()
 
static void SaveDeviceOrientation (EDeviceScreenOrientation NewDeviceOrentation)
 
static CORE_API void UnlockAndroidWindow ()
 
static CORE_API TArray< int32GetSupportedNativeDisplayRefreshRates ()
 
static CORE_API bool SetNativeDisplayRefreshRate (int32 RefreshRate)
 
static CORE_API int32 GetNativeDisplayRefreshRate ()
 
static CORE_API bool Expand16BitIndicesTo32BitOnLoad ()
 
static CORE_API int GetMobilePropagateAlphaSetting ()
 
static CORE_API bool SupportsBackbufferSampling ()
 
static CORE_API void SetMemoryWarningHandler (void(*Handler)(const FGenericMemoryWarningContext &Context))
 
static CORE_API bool HasMemoryWarningHandler ()
 
static CORE_API void NonReentrantRequestExit ()
 
static CORE_API void RegisterThreadName (const char *Name, uint32 ThreadId)
 
static CORE_API const charGetThreadName (uint32 ThreadId)
 
static CORE_API void ShowConsoleWindow ()
 
static CORE_API FDelegateHandle AddNetworkListener (FOnNetworkConnectionChangedDelegate &&InNewDelegate)
 
static CORE_API bool RemoveNetworkListener (FDelegateHandle Handle)
 
static CORE_API float GetVirtualKeyboardInputHeight ()
 
- 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 TCHARGetPathVarDelimiter ()
 
static CORE_API TArray< uint8GetMacAddress ()
 
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 TCHARGetSystemErrorMessage (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 TCHARGetDefaultPathSeparator ()
 
static CORE_API bool UseRenderThread ()
 
static bool AllowAudioThread ()
 
static CORE_API bool AllowThreadHeartBeat ()
 
static CORE_API int32 NumberOfCores ()
 
static CORE_API const FProcessorGroupDescGetProcessorGroupDesc ()
 
static CORE_API int32 NumberOfCoresIncludingHyperthreads ()
 
static CORE_API int32 NumberOfWorkerThreadsToSpawn ()
 
static CORE_API int32 NumberOfIOWorkerThreadsToSpawn ()
 
static struct FAsyncIOSystemBaseGetPlatformSpecificAsyncIOSystem ()
 
static const TCHARGetPlatformFeaturesModuleName ()
 
static CORE_API const TCHARRootDir ()
 
static CORE_API TArray< FString > GetAdditionalRootDirectories ()
 
static CORE_API void AddAdditionalRootDirectory (const FString &RootDir)
 
static CORE_API const TCHAREngineDir ()
 
static CORE_API const TCHARLaunchDir ()
 
static CORE_API void CacheLaunchDir ()
 
static CORE_API const TCHARProjectDir ()
 
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 TCHARGamePersistentDownloadDir ()
 
static CORE_API const TCHARGameTemporaryDownloadDir ()
 
static CORE_API const TCHARGeneratedConfigDir ()
 
static CORE_API const TCHARGetUBTPlatform ()
 
static CORE_API const TCHARGetUBTTarget ()
 
static CORE_API const TCHARGetUBTArchitecture ()
 
static CORE_API void SetUBTTargetName (const TCHAR *InTargetName)
 
static CORE_API const TCHARGetUBTTargetName ()
 
static CORE_API const TCHARGetNullRHIShaderFormat ()
 
static CORE_API IPlatformChunkInstallGetPlatformChunkInstall ()
 
static CORE_API IPlatformCompressionGetPlatformCompression ()
 
static CORE_API IPlatformHostCommunicationGetPlatformHostCommunication ()
 
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 TCHARGetDefaultDeviceProfileName ()
 
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< uint8GetSystemFontBytes ()
 
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 TCHARGetEngineMode ()
 
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

TCHARResult
 
TCHAR int32 ResultLength
 

Static Public Attributes

static CORE_API FString AndroidVersion
 
static CORE_API int32 AndroidMajorVersion = 0
 
static CORE_API int32 TargetSDKVersion = 0
 
static CORE_API FString DeviceMake
 
static CORE_API FString DeviceModel
 
static CORE_API FString DeviceBuildNumber
 
static CORE_API FString OSLanguage
 
static CORE_API FString ProductName
 
static CORE_API int32 AndroidBuildVersion = 0
 
static CORE_API TMap< FString, FString > ConfigRulesVariables
 
static CORE_API bool VolumeButtonsHandledBySystem = true
 
static CORE_API bool bNeedsRestartAfterPSOPrecompile = false
 

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

Android implementation of the misc OS functions

Member Typedef Documentation

◆ OnPauseCallBackType

◆ ReInitWindowCallbackType

◆ ReleaseWindowCallbackType

Member Enumeration Documentation

◆ EBatteryState

Enumerator
BATTERY_STATE_UNKNOWN 
BATTERY_STATE_CHARGING 
BATTERY_STATE_DISCHARGING 
BATTERY_STATE_NOT_CHARGING 
BATTERY_STATE_FULL 

◆ ECoreFrequencyProperty

Enumerator
CurrentFrequency 
MaxFrequency 
MinFrequency 

Member Function Documentation

◆ AddNetworkListener()

FDelegateHandle FAndroidMisc::AddNetworkListener ( FOnNetworkConnectionChangedDelegate &&  InNewDelegate)
static

◆ AllowThreadHeartBeat()

bool FAndroidMisc::AllowThreadHeartBeat ( )
static

◆ AreHeadPhonesPluggedIn()

bool FAndroidMisc::AreHeadPhonesPluggedIn ( )
static

◆ CreateGuid()

void FAndroidMisc::CreateGuid ( struct FGuid Result)
static

Try to use SYS_getrandom which would be the fastest, otherwise fall back to use /proc/sys/kernel/random/uuid to get GUID; do NOT use JNI since this may be called too early

◆ DeleteStoredSection()

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

◆ DeleteStoredValue()

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

◆ Expand16BitIndicesTo32BitOnLoad()

bool FAndroidMisc::Expand16BitIndicesTo32BitOnLoad ( )
static

Returns whether or not a 16 bit index buffer should be promoted to 32 bit on load, needed for some Android devices

◆ FileExistsInPlatformPackage()

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

◆ GetAndroidMajorVersion()

int32 FAndroidMisc::GetAndroidMajorVersion ( )
static

◆ GetAndroidVersion()

const FString FAndroidMisc::GetAndroidVersion ( )
static

◆ GetBatteryLevel()

int FAndroidMisc::GetBatteryLevel ( )
static

◆ GetBatteryState()

FAndroidMisc::FBatteryState FAndroidMisc::GetBatteryState ( )
static

◆ GetCellularPreference()

int32 FAndroidMisc::GetCellularPreference ( )
static

◆ GetConfigRuleVars()

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

◆ GetCoreFrequency()

uint32 FAndroidMisc::GetCoreFrequency ( int32  CoreIndex,
ECoreFrequencyProperty  CoreFrequencyProperty 
)
static

◆ GetCPUBrand()

FString FAndroidMisc::GetCPUBrand ( )
static

◆ GetCPUChipset()

FString FAndroidMisc::GetCPUChipset ( )
static

◆ GetCPUState()

FAndroidMisc::FCPUState & FAndroidMisc::GetCPUState ( )
static

◆ GetCPUTemperature()

float FAndroidMisc::GetCPUTemperature ( )
static

◆ GetCPUVendor()

FString FAndroidMisc::GetCPUVendor ( )
static

◆ GetDefaultDeviceProfileName()

const TCHAR * FAndroidMisc::GetDefaultDeviceProfileName ( )
static

◆ GetDefaultLocale()

FString FAndroidMisc::GetDefaultLocale ( )
static

◆ GetDeviceBuildNumber()

const FString FAndroidMisc::GetDeviceBuildNumber ( )
static

◆ GetDeviceMake()

const FString FAndroidMisc::GetDeviceMake ( )
static

◆ GetDeviceModel()

const FString FAndroidMisc::GetDeviceModel ( )
static

◆ GetDeviceOrientation()

static EDeviceScreenOrientation FAndroidMisc::GetDeviceOrientation ( )
inlinestatic

◆ GetDeviceTemperatureLevel()

float FAndroidMisc::GetDeviceTemperatureLevel ( )
static

◆ GetDeviceVolume()

int32 FAndroidMisc::GetDeviceVolume ( )
static

◆ GetDiskTotalAndFreeSpace()

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

◆ GetEnvironmentVariable()

FString FAndroidMisc::GetEnvironmentVariable ( const TCHAR VariableName)
static

◆ GetFatalSignalMessage()

static CORE_API FString FAndroidMisc::GetFatalSignalMessage ( int  Signal,
siginfo Info 
)
static

◆ GetGLVersion()

FString FAndroidMisc::GetGLVersion ( )
static

◆ GetGPUFamily()

FString FAndroidMisc::GetGPUFamily ( )
static

◆ GetMaxPathLength()

static UE_FORCEINLINE_HINT int32 FAndroidMisc::GetMaxPathLength ( )
inlinestatic

◆ GetMobilePropagateAlphaSetting()

int FAndroidMisc::GetMobilePropagateAlphaSetting ( )
static

Will return true if we wish to propagate the alpha to the backbuffer

◆ GetNativeDisplayRefreshRate()

int32 FAndroidMisc::GetNativeDisplayRefreshRate ( )
static

◆ GetNetworkConnectionType()

ENetworkConnectionType FAndroidMisc::GetNetworkConnectionType ( )
static

◆ GetOnPauseCallback()

FAndroidMisc::OnPauseCallBackType FAndroidMisc::GetOnPauseCallback ( )
static

◆ GetOnReInitWindowCallback()

FAndroidMisc::ReInitWindowCallbackType FAndroidMisc::GetOnReInitWindowCallback ( )
static

◆ GetOnReleaseWindowCallback()

FAndroidMisc::ReleaseWindowCallbackType FAndroidMisc::GetOnReleaseWindowCallback ( )
static

◆ GetOSLanguage()

const FString FAndroidMisc::GetOSLanguage ( )
static

◆ GetOSVersion()

FString FAndroidMisc::GetOSVersion ( )
static

◆ GetOSVersions()

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

◆ GetOverrideResolution()

static bool FAndroidMisc::GetOverrideResolution ( int32 ResX,
int32 ResY 
)
inlinestatic

◆ GetPendingActivationProtocol()

FString FAndroidMisc::GetPendingActivationProtocol ( )
static

◆ GetPlatformChunkInstall()

class IPlatformChunkInstall * FAndroidMisc::GetPlatformChunkInstall ( )
static

◆ GetPrimaryGPUBrand()

FString FAndroidMisc::GetPrimaryGPUBrand ( )
static

◆ GetProductName()

const FString FAndroidMisc::GetProductName ( )
static

◆ GetProjectVersion()

const FString FAndroidMisc::GetProjectVersion ( )
static

◆ GetStoredValue()

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

◆ GetSupportedNativeDisplayRefreshRates()

TArray< int32 > FAndroidMisc::GetSupportedNativeDisplayRefreshRates ( )
static

◆ GetSystemErrorMessage()

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

◆ GetSystemFontBytes()

TArray< uint8 > FAndroidMisc::GetSystemFontBytes ( )
static
Returns
Memory representing a true type or open type font provided by the platform as a default font for unreal to consume; empty array if the default font failed to load.

◆ GetTargetSDKVersion()

int32 FAndroidMisc::GetTargetSDKVersion ( )
static

◆ GetThreadName()

const char * FAndroidMisc::GetThreadName ( uint32  ThreadId)
static

◆ GetUseVirtualJoysticks()

bool FAndroidMisc::GetUseVirtualJoysticks ( )
static

◆ GetValidTargetPlatforms()

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

◆ GetVirtualKeyboardInputHeight()

float FAndroidMisc::GetVirtualKeyboardInputHeight ( )
static

◆ GetVKQualityRecommendation()

FString FAndroidMisc::GetVKQualityRecommendation ( )
static

◆ GetVolumeButtonsHandledBySystem()

bool FAndroidMisc::GetVolumeButtonsHandledBySystem ( )
static

◆ GetVolumeState()

int FAndroidMisc::GetVolumeState ( double OutTimeOfChangeInSec = nullptr)
static

◆ GetVulkanDeviceNameString()

FString FAndroidMisc::GetVulkanDeviceNameString ( )
static

◆ GetVulkanVersion()

FString FAndroidMisc::GetVulkanVersion ( )
static

◆ HandleNewIntentUri()

void FAndroidMisc::HandleNewIntentUri ( const FString &  IntentUri)
static

◆ HasMemoryWarningHandler()

bool FAndroidMisc::HasMemoryWarningHandler ( )
static

◆ HasPlatformFeature()

bool FAndroidMisc::HasPlatformFeature ( const TCHAR FeatureName)
static

◆ HasVulkanDriverSupport()

bool FAndroidMisc::HasVulkanDriverSupport ( )
static

◆ IsAllowedRemoteNotifications()

bool FAndroidMisc::IsAllowedRemoteNotifications ( )
static

◆ IsDebuggerPresent()

bool FAndroidMisc::IsDebuggerPresent ( )
static

◆ IsDesktopVulkanAvailable()

bool FAndroidMisc::IsDesktopVulkanAvailable ( )
static

◆ IsExternalMemoryAndroidHardwareBufferExtensionLoaded()

bool FAndroidMisc::IsExternalMemoryAndroidHardwareBufferExtensionLoaded ( )
static

◆ IsInLowPowerMode()

bool FAndroidMisc::IsInLowPowerMode ( )
static

◆ IsInSignalHandler()

bool FAndroidMisc::IsInSignalHandler ( )
static

◆ IsLocalPrintThreadSafe()

static bool FAndroidMisc::IsLocalPrintThreadSafe ( )
inlinestatic

◆ IsRunningOnBattery()

bool FAndroidMisc::IsRunningOnBattery ( )
static

◆ IsSupportedAndroidDevice()

bool FAndroidMisc::IsSupportedAndroidDevice ( )
static

◆ IsVulkanAvailable()

bool FAndroidMisc::IsVulkanAvailable ( )
static

◆ LoadTextFileFromPlatformPackage()

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

◆ LocalPrint()

void FAndroidMisc::LocalPrint ( const TCHAR Message)
static

◆ MemoryBarrier()

static UE_FORCEINLINE_HINT void FAndroidMisc::MemoryBarrier ( )
inlinestatic

◆ MessageBoxExt()

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

◆ NonReentrantRequestExit()

void FAndroidMisc::NonReentrantRequestExit ( )
static

◆ NumberOfCores()

int32 FAndroidMisc::NumberOfCores ( )
static

◆ NumberOfCoresIncludingHyperthreads()

int32 FAndroidMisc::NumberOfCoresIncludingHyperthreads ( )
static

◆ OverrideFatalSignalHandler()

static CORE_API void FAndroidMisc::OverrideFatalSignalHandler ( void(*)(int Signal, struct siginfo *Info, void *Context, uint32 CrashingThreadId)  FatalSignalHandlerOverrideFunc)
static

◆ PlatformHandleSplashScreen()

void FAndroidMisc::PlatformHandleSplashScreen ( bool  ShowSplashScreen)
static

◆ PlatformInit()

void FAndroidMisc::PlatformInit ( )
static

◆ PlatformPreInit()

void FAndroidMisc::PlatformPreInit ( )
static

◆ PlatformTearDown()

void FAndroidMisc::PlatformTearDown ( )
static

◆ PrepareMobileHaptics()

void FAndroidMisc::PrepareMobileHaptics ( EMobileHapticsType  Type)
static

◆ RegisterForRemoteNotifications()

void FAndroidMisc::RegisterForRemoteNotifications ( )
static

◆ RegisterThreadName()

void FAndroidMisc::RegisterThreadName ( const char Name,
uint32  ThreadId 
)
static

◆ ReleaseMobileHaptics()

void FAndroidMisc::ReleaseMobileHaptics ( )
static

◆ RemoveNetworkListener()

bool FAndroidMisc::RemoveNetworkListener ( FDelegateHandle  Handle)
static

◆ RequestExit()

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

◆ RestartApplication()

bool FAndroidMisc::RestartApplication ( )
static

◆ SaveDeviceOrientation()

static void FAndroidMisc::SaveDeviceOrientation ( EDeviceScreenOrientation  NewDeviceOrentation)
inlinestatic

◆ SetAllowedDeviceOrientation()

void FAndroidMisc::SetAllowedDeviceOrientation ( EDeviceScreenOrientation  NewAllowedDeviceOrientation)
static

◆ SetCellularPreference()

void FAndroidMisc::SetCellularPreference ( int32  Value)
static

◆ SetCrashHandler()

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

◆ SetDeviceOrientation()

void FAndroidMisc::SetDeviceOrientation ( EDeviceScreenOrientation  NewDeviceOrentation)
static

◆ SetForceUnsupported()

void FAndroidMisc::SetForceUnsupported ( bool  bInOverride)
static

◆ SetMemoryWarningHandler()

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

◆ SetNativeDisplayRefreshRate()

bool FAndroidMisc::SetNativeDisplayRefreshRate ( int32  RefreshRate)
static

◆ SetOnPauseCallback()

void FAndroidMisc::SetOnPauseCallback ( FAndroidMisc::OnPauseCallBackType  InOnPauseCallback)
static

◆ SetOnReInitWindowCallback()

void FAndroidMisc::SetOnReInitWindowCallback ( FAndroidMisc::ReInitWindowCallbackType  InOnReInitWindowCallback)
static

◆ SetOnReleaseWindowCallback()

void FAndroidMisc::SetOnReleaseWindowCallback ( FAndroidMisc::ReleaseWindowCallbackType  InOnReleaseWindowCallback)
static

◆ SetStoredValue()

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

◆ SetVersionInfo()

void FAndroidMisc::SetVersionInfo ( FString  AndroidVersion,
int32  InTargetSDKVersion,
FString  DeviceMake,
FString  DeviceModel,
FString  DeviceBuildNumber,
FString  OSLanguage,
FString  ProductName 
)
static

◆ SetVolumeButtonsHandledBySystem()

void FAndroidMisc::SetVolumeButtonsHandledBySystem ( bool  enabled)
static

◆ ShareURL()

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

◆ ShouldUseDesktopVulkan()

bool FAndroidMisc::ShouldUseDesktopVulkan ( )
static

◆ ShouldUseVulkan()

bool FAndroidMisc::ShouldUseVulkan ( )
static

◆ ShowConsoleWindow()

void FAndroidMisc::ShowConsoleWindow ( )
static

◆ SupportsBackbufferSampling()

bool FAndroidMisc::SupportsBackbufferSampling ( )
static

◆ SupportsES30()

bool FAndroidMisc::SupportsES30 ( )
static

◆ SupportsFloatingPointRenderTargets()

bool FAndroidMisc::SupportsFloatingPointRenderTargets ( )
static

◆ SupportsLocalCaching()

bool FAndroidMisc::SupportsLocalCaching ( )
static

◆ SupportsShaderFramebufferFetch()

bool FAndroidMisc::SupportsShaderFramebufferFetch ( )
static

◆ SupportsShaderIOBlocks()

static CORE_API bool FAndroidMisc::SupportsShaderIOBlocks ( )
static

◆ SupportsTouchInput()

bool FAndroidMisc::SupportsTouchInput ( )
static

◆ TriggerCrashHandler()

void FAndroidMisc::TriggerCrashHandler ( ECrashContextType  InType,
const TCHAR InErrorMessage,
const TCHAR OverrideCallstack = nullptr 
)
static

◆ TriggerMobileHaptics()

void FAndroidMisc::TriggerMobileHaptics ( )
static

◆ UE_DEPRECATED()

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

◆ UnlockAndroidWindow()

static CORE_API void FAndroidMisc::UnlockAndroidWindow ( )
static

◆ UnregisterForRemoteNotifications()

void FAndroidMisc::UnregisterForRemoteNotifications ( )
static

◆ UpdateDeviceOrientation()

void FAndroidMisc::UpdateDeviceOrientation ( )
static

◆ UseNewWindowBehavior()

bool FAndroidMisc::UseNewWindowBehavior ( )
static

◆ UseRenderThread()

bool FAndroidMisc::UseRenderThread ( )
static

Member Data Documentation

◆ AndroidBuildVersion

int32 FAndroidMisc::AndroidBuildVersion = 0
static

◆ AndroidMajorVersion

int32 FAndroidMisc::AndroidMajorVersion = 0
static

◆ AndroidVersion

FString FAndroidMisc::AndroidVersion
static

◆ bNeedsRestartAfterPSOPrecompile

bool FAndroidMisc::bNeedsRestartAfterPSOPrecompile = false
static

◆ ConfigRulesVariables

TMap< FString, FString > FAndroidMisc::ConfigRulesVariables
static

◆ DeviceBuildNumber

FString FAndroidMisc::DeviceBuildNumber
static

◆ DeviceMake

FString FAndroidMisc::DeviceMake
static

◆ DeviceModel

FString FAndroidMisc::DeviceModel
static

◆ OSLanguage

FString FAndroidMisc::OSLanguage
static

◆ ProductName

FString FAndroidMisc::ProductName
static

◆ Result

TCHAR* FAndroidMisc::Result

◆ ResultLength

TCHAR int32 FAndroidMisc::ResultLength

◆ TargetSDKVersion

int32 FAndroidMisc::TargetSDKVersion = 0
static

◆ VolumeButtonsHandledBySystem

bool FAndroidMisc::VolumeButtonsHandledBySystem = true
static

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