1. Epic GamesDeveloper
  3. FGenericPlatformApplicationMisc

FGenericPlatformApplicationMisc

API > API/Runtime > API/Runtime/ApplicationCore

   
Name FGenericPlatformApplicationMisc
Type struct
Header File /Engine/Source/Runtime/ApplicationCore/Public/GenericPlatform/GenericPlatformApplicationMisc.h
Include Path #include "GenericPlatform/GenericPlatformApplicationMisc.h"

Syntax

struct FGenericPlatformApplicationMisc

Derived Classes

Enums

Public

Name Remarks
EScreenSaverAction  

Constants

Name Type Remarks Include Path
CachedPhysicalScreenAccuracy EScreenPhysicalAccuracy   GenericPlatform/GenericPlatformApplicationMisc.h
CachedPhysicalScreenData bool   GenericPlatform/GenericPlatformApplicationMisc.h
CachedPhysicalScreenDensity int32   GenericPlatform/GenericPlatformApplicationMisc.h
CachedPhysicalScreenDimensions FVector2f   GenericPlatform/GenericPlatformApplicationMisc.h
CachedPhysicalScreenDimensionsAccuracy EScreenPhysicalAccuracy   GenericPlatform/GenericPlatformApplicationMisc.h
CachedPhysicalScreenSize float   GenericPlatform/GenericPlatformApplicationMisc.h
CVarAllowVirtualKeyboard FAutoConsoleVariableRef   GenericPlatform/GenericPlatformApplicationMisc.h
CVarEnableHighDPIAwareness FAutoConsoleVariableRef   GenericPlatform/GenericPlatformApplicationMisc.h

Functions

Static

Name Remarks Include Path Unreal Specifiers
UE expects mouse coordinates in screen space. GenericPlatform/GenericPlatformApplicationMisc.h  

static void ClipboardCopy ( const TCHAR* Str
)

 Copies text to the operating system clipboard. GenericPlatform/GenericPlatformApplicationMisc.h  

static void ClipboardPaste ( FString& Dest
)

 Pastes in text from the operating system clipboard. GenericPlatform/GenericPlatformApplicationMisc.h  

static void ComputePhysicalScreenData()

   GenericPlatform/GenericPlatformApplicationMisc.h  

static EScreenPhysicalAccuracy ComputePhysicalScreenDensity ( int32& OutScreenDensity
)

 Gets the physical size of the screen if possible. Some platforms lie, some platforms don't know. GenericPlatform/GenericPlatformApplicationMisc.h  

static EScreenPhysicalAccuracy ComputePhysicalScreenDimensions ( FVector2f& OutScreenDimensions,
float& OutScreenSize
)

   GenericPlatform/GenericPlatformApplicationMisc.h  

static bool ControlScreensaver ( EScreenSaverAction Action
)

 Disables screensaver (if platform supports such an API) GenericPlatform/GenericPlatformApplicationMisc.h  

static EScreenPhysicalAccuracy ConvertInchesToPixels ( T Inches,
T2& OutPixels
)

 If we know or can approximate the pixel density of the screen we will convert the incoming inches to pixels on the device. GenericPlatform/GenericPlatformApplicationMisc.h  

static EScreenPhysicalAccuracy ConvertPixelsToInches ( T Pixels,
T2& OutInches
)

 If we know or can approximate the pixel density of the screen we will convert the incoming pixels to inches on the device. GenericPlatform/GenericPlatformApplicationMisc.h  

static GenericApplication * CreateApplication()

 Creates an application instance. GenericPlatform/GenericPlatformApplicationMisc.h  

static FOutputDeviceConsole * CreateConsoleOutputDevice()

 Creates a console output device for this platform. Should only be called once. GenericPlatform/GenericPlatformApplicationMisc.h  

static IPlatformInputDeviceMapper * CreatePlatformInputDeviceManager()

 Gets a pointer to the default platform input device manager. GenericPlatform/GenericPlatformApplicationMisc.h  

static void EnableMotionData ( bool bEnable
)

 Whether to enable controller motion data polling (by default motion data is enabled) Some platforms may want to disable it to reduce battery drain GenericPlatform/GenericPlatformApplicationMisc.h  

static float GetDPIScaleFactorAtPoint ( float X,
float Y
)

 Returns monitor's DPI scale factor at given screen coordinates (expressed in pixels) GenericPlatform/GenericPlatformApplicationMisc.h  

static FOutputDeviceError * GetErrorOutputDevice()

 Gets a pointer to the platform error output device singleton. GenericPlatform/GenericPlatformApplicationMisc.h  

static FFeedbackContext * GetFeedbackContext()

 Gets a pointer to the default platform feedback context implementation. GenericPlatform/GenericPlatformApplicationMisc.h  

static UTexture2D * GetGamepadButtonGlyph ( const FGamepadKeyNames::Type& ButtonKey,
uint32 ControllerIndex
)

 Returns a texture of the glyph representing the specified button on the specified controller, or nullptr if not supported. GenericPlatform/GenericPlatformApplicationMisc.h  

static FString GetGamepadControllerName ( int32 ControllerId
)

 Returns name of gamepad if controller id assigned to a gamepad GenericPlatform/GenericPlatformApplicationMisc.h  

static EScreenPhysicalAccuracy GetPhysicalScreenDensity ( int32& OutScreenDensity
)

 Gets the physical size of the screen if possible. Some platforms lie, some platforms don't know. GenericPlatform/GenericPlatformApplicationMisc.h  

static EScreenPhysicalAccuracy GetPhysicalScreenDimensions ( FVector2f& OutScreenDimensions
)

   GenericPlatform/GenericPlatformApplicationMisc.h  

static EScreenPhysicalAccuracy GetPhysicalScreenSize ( float& OutScreenSize
)

   GenericPlatform/GenericPlatformApplicationMisc.h  

static FLinearColor GetScreenPixelColor ( const FVector2D& InScreenPos,
float InGamma
)

 Sample the displayed pixel color from anywhere on the screen using the OS GenericPlatform/GenericPlatformApplicationMisc.h  

static bool GetWindowTitleMatchingText ( const TCHAR* TitleStartsWith,
FString& OutTitle
)

 Searches for a window that matches the window name or the title starts with a particular text. GenericPlatform/GenericPlatformApplicationMisc.h  

static void Init()

   GenericPlatform/GenericPlatformApplicationMisc.h  

static bool IsControllerAssignedToGamepad ( int32 ControllerId
)

 Returns true if controller id assigned to a gamepad GenericPlatform/GenericPlatformApplicationMisc.h  

static bool IsHighDPIAwarenessEnabled()

   GenericPlatform/GenericPlatformApplicationMisc.h  

static bool IsMotionDataEnabled()

 Whether controller motion data polling is enabled (by default motion data is enabled) GenericPlatform/GenericPlatformApplicationMisc.h  

static bool IsScreensaverEnabled()

 Returns state of screensaver (if platform supports it) GenericPlatform/GenericPlatformApplicationMisc.h  

static bool IsThisApplicationForeground()

 Returns true if the specified application has a visible window, and that window is active/has focus/is selected GenericPlatform/GenericPlatformApplicationMisc.h  

static void LoadPreInitModules()

 Load the preinit modules required by this platform, typically they are the renderer modules GenericPlatform/GenericPlatformApplicationMisc.h  

static void LoadStartupModules()

 Load the platform-specific startup modules GenericPlatform/GenericPlatformApplicationMisc.h  

static void PostInit()

   GenericPlatform/GenericPlatformApplicationMisc.h  

static void PreInit()

   GenericPlatform/GenericPlatformApplicationMisc.h  

static void PreventScreenSaver ()

 Prevents screen-saver from kicking in by moving the mouse by 0 pixels. GenericPlatform/GenericPlatformApplicationMisc.h  

static void PumpMessages ( bool bFromMainLoop
)

 Pumps Windows messages. GenericPlatform/GenericPlatformApplicationMisc.h  

static void RequestMinimize()

 Request application to minimize (goto background). GenericPlatform/GenericPlatformApplicationMisc.h  

static bool RequiresVirtualKeyboard()

 Returns whether the platform wants to use a touch screen for a virtual keyboard. GenericPlatform/GenericPlatformApplicationMisc.h  

static void ResetGamepadAssignments()

 Resets the gamepad to player controller id assignments GenericPlatform/GenericPlatformApplicationMisc.h  

static void ResetGamepadAssignmentToController ( int32 ControllerId
)

 Resets the gamepad assignment to player controller id GenericPlatform/GenericPlatformApplicationMisc.h  

static void SetGamepadsAllowed ( bool bAllowed
)

 Set whether gamepads are allowed at the platform level. GenericPlatform/GenericPlatformApplicationMisc.h  

static void SetGamepadsBlockDeviceFeedback ( bool bAllowed
)

 Set whether gamepads are allowed at the platform level. GenericPlatform/GenericPlatformApplicationMisc.h  

static void SetHighDPIMode()

 Allows the OS to enable high DPI mode GenericPlatform/GenericPlatformApplicationMisc.h  

static bool ShowInputDeviceSelector ( FPlatformUserId InitiatingUserId,
FShowInputDeviceSelectorComplete OnShowInputDeviceSelectorComplete
)

 Asyncronously display the platform-specific input device selection UI, if supported. GenericPlatform/GenericPlatformApplicationMisc.h  

static bool ShowPlatformUserSelector ( FInputDeviceId InitiatingInputDeviceId,
EPlatformUserSelectorFlags Flags,
FPlatformUserSelectionComplete OnUserSelectionComplete
)

 Asyncronously display the platform-specific user selection UI, if supported. GenericPlatform/GenericPlatformApplicationMisc.h  

static void TearDown()

   GenericPlatform/GenericPlatformApplicationMisc.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page