Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > ApplicationCore > GenericPlatform > GenericApplication

Light Theme

Dark Theme

GenericApplication

Generic platform application interface

Windows

MacOS

Linux

Inheritance Hierarchy

GenericApplication

FHoloLensApplication

References

Module	ApplicationCore
Header	/Engine/Source/Runtime/ApplicationCore/Public/GenericPlatform/GenericApplication.h
Include	#include "GenericPlatform/GenericApplication.h"

Syntax

class GenericApplication

Remarks

Generic platform application interface

Variables

	Name	Description
TSharedRef< FGe...	AccessibleMessageHandler
const TSharedPt...	Cursor
TSharedRef< cla...	MessageHandler
FOnDisplayMetri...	OnDisplayMetricsChangedEvent	Notifies subscribers when any of the display metrics change: e.g. resolution changes or monitor sare re-arranged.
FVirtualKeyboar...	VirtualKeyboardHiddenEvent	Delegate for virtual keyboard being shown
FVirtualKeyboar...	VirtualKeyboardShownEvent	Delegate for virtual keyboard being shown

Constructors

	Name	Description
	GenericApplication ( const TSharedPtr< ICursor >& InCur... )

Destructors

	Name	Description
	~GenericApplication()

Functions

	Name	Description
void	AddPendingConsoleCommand ( const FString& InCommand )
bool	ApplicationLicenseValid ( FPlatformUserId PlatformUser )
void	BroadcastDisplayMetricsChanged ( const FDisplayMetrics& InMetrics )	Trigger the OnDisplayMetricsChanged event with the argument 'InMetrics'
void	DestroyApplication()
TSharedRef< ...	GetAccessibleMessageHandler()
void *	GetCapture()
void	GetInitialDisplayMetrics ( FDisplayMetrics& OutDisplayMetrics )
IInputInterf...	GetInputInterface()
TSharedRef< ...	GetMessageHandler()
FModifierKey...	GetModifierKeys()
ITextInputMe...	GetTextInputMethodSystem()	Function to return the current implementation of the Text Input Method System
EWindowTitle...	GetWindowTitleAlignment()	Gets the horizontal alignment of the window title bar's title text.
EWindowTrans...	GetWindowTransparencySupport()
TSharedPtr< ...	GetWindowUnderCursor()
FPlatformRec...	GetWorkArea ( const FPlatformRect& CurrentWindow )
void	InitializeWindow ( const TSharedRef< FGenericWindow > ..., const TSharedRef< FGenericWindowDef..., const TSharedPtr< FGenericWindow > ..., const bool bShowImmediately )
bool	IsAllowedToRender()
bool	IsCursorDirectlyOverSlateWindow()
bool	IsGamepadAttached()
bool	IsMinimized()
bool	IsMouseAttached()
bool	IsUsingHighPrecisionMouseMode()
bool	IsUsingTrackpad()
TSharedRef< ...	MakeWindow()
FOnDisplayMe...	OnDisplayMetricsChanged()	Notifies subscribers when any of the display metrics change: e.g. resolution changes or monitor sare re-arranged.
FVirtualKeyb...	OnVirtualKeyboardHidden()
FVirtualKeyb...	OnVirtualKeyboardShown()
void	PollGameDeviceState ( const float TimeDelta )
void	ProcessDeferredEvents ( const float TimeDelta )
void	PumpMessages ( const float TimeDelta )
void	RegisterConsoleCommandListener ( const FOnConsoleCommandListener& I... )
void	SendAnalytics ( IAnalyticsProvider* Provider )	Send any analytics captured by the application
void	SetAccessibleMessageHandler ( const TSharedRef< FGenericAccessibl... )
void	SetCapture ( const TSharedPtr< FGenericWindow > ... )
void	SetHighPrecisionMouseMode ( const bool Enable, const TSharedPtr< FGenericWindow > ... )
void	SetMessageHandler ( const TSharedRef< FGenericApplicati... )
void	ShowSystemHelp()
bool	SupportsSystemHelp()
void	Tick ( const float TimeDelta )
bool	TryCalculatePopupWindowPosition ( const FPlatformRect& InAnchor, const FVector2D& InSize, const FVector2D& ProposedPlacement, const EPopUpOrientation::Type Orien..., FVector2D*const CalculatedPopU... )

Classes

	Name	Description
	FOnDisplayMetricsChanged
	FVirtualKeyboardHiddenEvent
	FVirtualKeyboardShownEvent	Delegate for virtual keyboard being shown/hidden in case UI wants to slide out of the way

Typedefs

Name	Description
FOnConsoleCommandAdded
FOnConsoleCommandListener

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss