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 > Engine > Engine > UGameViewportClient

Light Theme

Dark Theme

UGameViewportClient

A game viewport ([FViewport](API\Runtime\Engine\FViewport)) is a high-level abstract interface for the platform specific rendering, audio, and input subsystems.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UScriptViewportClient

UGameViewportClient

	UCommonGameViewportClient
	UDisplayClusterViewportClient

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Engine/GameViewportClient.h
Include	#include "Engine/GameViewportClient.h"

Syntax

class UGameViewportClient :
public UScriptViewportClient,
public FExec

Remarks

A game viewport (FViewport) is a high-level abstract interface for the platform specific rendering, audio, and input subsystems. GameViewportClient is the engine's interface to a game viewport. Exactly one GameViewportClient is created for each instance of the game. The only case (so far) where you might have a single instance of Engine, but multiple instances of the game (and thus multiple GameViewportClients) is when you have more than one PIE window running.

Responsibilities: propagating input events to the global interactions list

Variables

	Name	Description
TEnumAsByte< ES...	ActiveSplitscreenType	The splitscreen type that is actually being used; takes into account the number of players and other factors (such as cinematic mode) that could affect the splitscreen mode that is actually used.
FAudioDeviceHan...	AudioDevice	Strong handle to the audio device used by this viewport.
FDelegateHandle	AudioDeviceDestroyedHandle	Handle to delegate in case audio device is destroyed.
uint32	AudioDeviceHandle	Handle to the audio device created for this viewport.
uint32: 1	bDisableWorldRendering	Set to disable world rendering
bool	bHasAudioFocus	Whether or not this audio device is in audio-focus
uint32: 1	bIsPlayInEditorViewport	If true, this viewport is a play in editor viewport
bool	bSuppressTransitionMessage	If true will suppress the blue transition text messages.
TArray< struct ...	DebugProperties	Debug properties that have been added via one of the "displayall" commands
FEngineShowFlag...	EngineShowFlags	The show flags used by the viewport's players.
UGameInstance &...	GameInstance
int32	MaxSplitscreenPlayers
TArray< struct ...	SplitscreenInfo	Array of the screen data needed for all the different splitscreen configurations
int32	ViewModeIndex	See enum EViewModeIndex
FViewport *	Viewport	The platform-specific viewport which this viewport client is attached to.
UConsole *	ViewportConsole	The viewport's console. Might be null on consoles
FViewportFrame ...	ViewportFrame	The platform-specific viewport frame which this viewport is contained by.
UWorld *	World	The relative world context for this viewport

Constructors

	Name	Description
	UGameViewportClient ( const FObjectInitializer& ObjectIn... )
	UGameViewportClient ( FVTableHelper& Helper )	DO NOT USE. This constructor is for internal usage only for hot-reload purposes.

Destructors

	Name	Description
	~UGameViewportClient()

Functions

	Name	Description
void	AddCursorWidget ( EMouseCursor::Type Cursor, UUserWidget* CursorWidget )	Sets the widget to use fore the cursor.
void	AddSoftwareCursor ( EMouseCursor::Type Cursor, const FSoftClassPath& CursorClass )	Adds a cursor to the set based on the enum and the class reference to it.
void	AddSoftwareCursorFromSlateWidget ( EMouseCursor::Type InCursorType, TSharedPtr< SWidget > CursorWidgetP... )	Add a cursor to the set based on the enum and a slate widget
void	AddViewportWidgetContent ( TSharedRef< class SWidget > Viewpor..., const int32 ZOrder )	Adds a widget to the Slate viewport's overlay (i.e for in game UI or tools) at the specified Z-order
void	AddViewportWidgetForPlayer ( ULocalPlayer* Player, TSharedRef< SWidget > ViewportConte..., const int32 ZOrder )	Adds a widget to the Slate viewport's overlay (i.e for in game UI or tools) at the specified Z-order.
bool	CalculateDeadZoneForAllSides ( ULocalPlayer* LPlayer, UCanvas* Canvas, float& fTopSafeZone, float& fBottomSafeZone, float& fLeftSafeZone, float& fRightSafeZone, bool bUseMaxPercent )	Pixel size of the deadzone for all sides (right/left/top/bottom) based on which local player it is
void	CalculateSafeZoneValues ( FMargin& SafeZone, UCanvas* Canvas, int32 LocalPlayerIndex, bool bUseMaxPercent )	Calculate the amount of safezone needed for a single side for both vertical and horizontal dimensions
FString	ConsoleCommand ( const FString& Command )	Process Console Command
int32	ConvertLocalPlayerToGamePlayerIndex ( ULocalPlayer* LPlayer )	Convert a LocalPlayer to it's index in the GamePlayer array
void	DetachViewportClient()	Cleans up all rooted or referenced objects created or managed by the GameViewportClient.
void	DrawTitleSafeArea ( UCanvas* Canvas )	Draws the safe area using the current r.DebugSafeZone.Mode=1 when there is not a valid PlayerController HUD.
void	DrawTransition ( UCanvas* Canvas )	Displays the transition screen.
void	DrawTransitionMessage ( UCanvas* Canvas, const FString& Message )	Print a centered transition message with a drop shadow.
void	EnableCsvPlayerStats ( int32 LocalPlayerCount )
void	FinalizeViews ( FSceneViewFamily* ViewFamily, const TMap< ULocalPlayer*, FSc... )	Make any adjustments to the views after they've been completely set up
FName	GetCurrentBufferVisualizationMode()
ESplitScreen...	GetCurrentSplitscreenConfiguration()
UGameInstanc...	GetGameInstance()	Returns the relevant game instance for this viewport
TSharedPtr< ...	GetGameLayerManager()	Gets the layer manager for the UI.
const FScene...	GetGameViewport()	Returns the game viewport
FSceneViewpo...	GetGameViewport()	Returns the game viewport
TSharedPtr< ...	GetGameViewportWidget()	Returns the widget for this viewport
bool	GetIsUsingSoftwareCursorWidgets()	Get whether or not the viewport is currently using software cursor
bool	GetMousePosition ( FVector2D& MousePosition )
void	GetPixelSizeOfScreen ( float& Width, float& Height, UCanvas* Canvas, int32 LocalPlayerIndex )	Get the total pixel size of the screen.
TSharedPtr< ...	GetSoftwareCursorWidget ( EMouseCursor::Type Cursor )	Get the slate widget of the current software cursor
void	GetSubtitleRegion ( FVector2D& MinPos, FVector2D& MaxPos )	Called before rending subtitles to allow the game viewport to determine the size of the subtitle area
bool	GetUseMouseForTouch()
void	GetViewportSize ( FVector2D& ViewportSize )	Retrieve the size of the main viewport.
TSharedPtr< ...	GetWindow()	Returns access to this viewport's Slate window
bool	HandleBugScreenshotCommand ( const TCHAR* Cmd, FOutputDevice& Ar )
bool	HandleBugScreenshotwithHUDInfoCommand ( const TCHAR* Cmd, FOutputDevice& Ar )
bool	HandleDisplayAllCommand ( const TCHAR* Cmd, FOutputDevice& Ar )
bool	HandleDisplayAllLocationCommand ( const TCHAR* Cmd, FOutputDevice& Ar )
bool	HandleDisplayAllRotationCommand ( const TCHAR* Cmd, FOutputDevice& Ar )
bool	HandleDisplayClearCommand ( const TCHAR* Cmd, FOutputDevice& Ar )
bool	HandleDisplayCommand ( const TCHAR* Cmd, FOutputDevice& Ar )
bool	HandleForceFullscreenCommand ( const TCHAR* Cmd, FOutputDevice& Ar )	Exec command handlers
bool	HandleForceSkelLODCommand ( const TCHAR* Cmd, FOutputDevice& Ar, UWorld* InWorld )
bool	HandleGetAllLocationCommand ( const TCHAR* Cmd, FOutputDevice& Ar )
bool	HandleGetAllRotationCommand ( const TCHAR* Cmd, FOutputDevice& Ar )
bool	HandleHighresScreenshotCommand ( const TCHAR* Cmd, FOutputDevice& Ar )
bool	HandleHighresScreenshotUICommand ( const TCHAR* Cmd, FOutputDevice& Ar )
bool	HandleKillParticlesCommand ( const TCHAR* Cmd, FOutputDevice& Ar )
bool	HandleNextViewModeCommand ( const TCHAR* Cmd, FOutputDevice& Ar, UWorld* InWorld )
bool	HandlePauseRenderClockCommand ( const TCHAR* Cmd, FOutputDevice& Ar )
bool	HandlePreCacheCommand ( const TCHAR* Cmd, FOutputDevice& Ar )
bool	HandlePrevViewModeCommand ( const TCHAR* Cmd, FOutputDevice& Ar, UWorld* InWorld )
bool	HandleScreenshotCommand ( const TCHAR* Cmd, FOutputDevice& Ar )
bool	HandleSetResCommand ( const TCHAR* Cmd, FOutputDevice& Ar )
bool	HandleShowCommand ( const TCHAR* Cmd, FOutputDevice& Ar, UWorld* InWorld )
bool	HandleShowLayerCommand ( const TCHAR* Cmd, FOutputDevice& Ar, UWorld* InWorld )
bool	HandleTextureDefragCommand ( const TCHAR* Cmd, FOutputDevice& Ar )
bool	HandleToggleFullscreenCommand()
bool	HandleToggleMIPFadeCommand ( const TCHAR* Cmd, FOutputDevice& Ar )
bool	HandleViewModeCommand ( const TCHAR* Cmd, FOutputDevice& Ar, UWorld* InWorld )
bool	HasAudioFocus()
bool	HasBottomSafeZone ( int32 LocalPlayerIndex )	Whether the player at LocalPlayerIndex's viewport has a "bottom of viewport" safezone or not.
bool	HasLeftSafeZone ( int32 LocalPlayerIndex )	Whether the player at LocalPlayerIndex's viewport has a "left of viewport" safezone or not.
bool	HasRightSafeZone ( int32 LocalPlayerIndex )	Whether the player at LocalPlayerIndex's viewport has a "right of viewport" safezone or not.
bool	HasSoftwareCursor ( EMouseCursor::Type Cursor )	Does the viewport client have a software cursor set up for the given enum?
bool	HasTopSafeZone ( int32 LocalPlayerIndex )	Whether the player at LocalPlayerIndex's viewport has a "top of viewport" safezone or not.
void	Init ( FWorldContext& WorldContext, UGameInstance* OwningGameInsta..., bool bCreateNewAudioDevice )
bool	IsExclusiveFullscreenViewport()
bool	IsFullScreenViewport()
bool	IsSimulateInEditorViewport()
bool	IsSplitscreenForceDisabled()	Determines whether splitscreen is forced to be turned off
void	LayoutPlayers()	Called before rendering to allow the game viewport to allocate subregions to players.
void	NotifyPlayerAdded ( int32 PlayerIndex, ULocalPlayer* AddedPlayer )	Notifies all interactions that a new player has been added to the list of active players.
void	NotifyPlayerRemoved ( int32 PlayerIndex, ULocalPlayer* RemovedPlayer )	Notifies all interactions that a new player has been added to the list of active players.
FSimpleMulti...	OnBeginDraw()	Accessor for the delegate called when the engine starts drawing a game viewport.
FOnCloseRequ...	OnCloseRequested()	Accessor for the delegate called when a viewport is asked to close.
FSimpleMulti...	OnDrawn()	Accessor for the delegate called when the game viewport is drawn, before drawing the console.
FSimpleMulti...	OnEndDraw()	Accessor for the delegate called when the engine finishes drawing a game viewport.
FOnGameViewp...	OnGameViewportInputKey()	Accessor for delegate called when a game viewport received input key
FOnInputAxis...	OnInputAxis()	Fetches OnInputAxisEvent reference
FOnInputKeyS...	OnInputKey()	Fetches OnInputKeyEvent reference
FCustomNavig...	OnNavigationOverride()	Set an override handler for navigation.
FOnGameViewp...	OnPlayerAdded()	Accessor for the delegate called when a player is added to the game viewport.
FOnGameViewp...	OnPlayerRemoved()	Accessor for the delegate called when a player is removed from the game viewport.
FOnScreensho...	OnScreenshotCaptured()	Accessor for delegate called when a screenshot is captured
FOnGameViewp...	OnTick()	Accessor for the delegate called when ticking the game viewport.
FOnToggleFul...	OnToggleFullscreen()	Accessor for delegate called when the engine toggles fullscreen
FSimpleMulti...	OnViewportCreated()	Accessor for the delegate called when the game viewport is created.
FOnViewportR...	OnViewportRendered()	Accessor for delegate called when a viewport is rendered
FOnWindowClo...	OnWindowCloseRequested()	Accessor for the delegate called when the window owning the viewport is asked to close.
void	PeekNetworkFailureMessages ( UWorld* InWorld, UNetDriver* NetDriver, enum ENetworkFailure::Type FailureT..., const FString& ErrorString )	Notification of network error messages generally not expected to handle the failure here, but provide notification to the user
void	PeekTravelFailureMessages ( UWorld* InWorld, enum ETravelFailure::Type FailureTy..., const FString& ErrorString )	Notification of server travel error messages, generally network connection related (package verification, client server handshaking, etc) generally not expected to handle the failure here, but provide notification to the user
void	PostRender ( UCanvas* Canvas )	Called after rendering the player views and HUDs to render menus, the console, etc.
void	RebuildCursors()	Recreates cursor widgets from UISettings class.
void	RemoveAllViewportWidgets()	This function removes all widgets from the viewport overlay
void	RemoveViewportWidgetContent ( TSharedRef< class SWidget > Viewpor... )	Removes a previously-added widget from the Slate viewport
void	RemoveViewportWidgetForPlayer ( ULocalPlayer* Player, TSharedRef< SWidget > ViewportConte... )	Removes a previously-added widget from the Slate viewport, in the player's section.
void	SetConsoleTarget ( int32 PlayerIndex )	Sets the player which console commands will be executed in the context of.
void	SetCurrentBufferVisualizationMode ( FName NewBufferVisualizationMode )
void	SetDropDetail ( float DeltaSeconds )	Sets bDropDetail and other per-frame detail level flags on the current WorldSettings
void	SetForceDisableSplitscreen ( const bool bDisabled )	Allows game code to disable splitscreen (useful when in menus)
void	SetGameLayerManager ( TSharedPtr< IGameLayerManager > Lay... )	Assigns the viewport game layer manager for this viewport client.
bool	SetHardwareCursor ( EMouseCursor::Type CursorShape, FName GameContentPath, FVector2D HotSpot )
void	SetHideCursorDuringCapture ( bool InHideCursorDuringCapture )	Sets whether or not the cursor is hidden when the viewport captures the mouse
void	SetIgnoreInput ( bool Ignore )	Set whether to ignore input.
void	SetMouseCaptureMode ( EMouseCaptureMode Mode )	Set the mouse capture behavior for the viewport.
void	SetMouseLockMode ( EMouseLockMode InMouseLockMode )	Sets the current mouse cursor lock mode when the viewport is clicked
void	SetSuppressTransitionMessage ( bool bSuppress )	Controls suppression of the blue transition text messages
ULocalPlayer...	SetupInitialLocalPlayer ( FString& OutError )	Initialize the game viewport.
void	SetUseSoftwareCursorWidgets ( bool bInUseSoftwareCursorWidgets )	Sets whether or not the software cursor widgets are used.
void	SetViewport ( FViewport* InViewportFrame )	Set this GameViewportClient's viewport to the viewport specified
void	SetViewportFrame ( FViewportFrame* InViewportFram... )	Set this GameViewportClient's viewport and viewport frame to the viewport specified
void	SetViewportOverlayWidget ( TSharedPtr< SWindow > InWindow, TSharedRef< SOverlay > InViewportOv... )	Assigns the viewport overlay widget to use for this viewport client.
void	SetVirtualCursorWidget ( EMouseCursor::Type Cursor, UUserWidget* Widget )
bool	ShouldForceFullscreenViewport()	Determine whether a fullscreen viewport should be used in cases where there are multiple players.
void	SSSwapControllers()	Rotates controller ids among gameplayers, useful for testing splitscreen with only one controller.
void	Tick ( float DeltaTime )	Called every frame to allow the game viewport to update time based state.
bool	TryToggleFullscreenOnInputKey ( FKey Key, EInputEvent EventType )	Gives the game's custom viewport client a way to handle F11 or Alt+Enter before processing the input
void	UpdateActiveSplitscreenType()	Sets the value of ActiveSplitscreenConfiguration based on the desired split-screen layout type, current number of players, and any other factors that might affect the way the screen should be laid out.
void	UpdateCsvCameraStats ( const TMap< ULocalPlayer*, FSc... )	Updates CSVProfiler camera stats
void	VerifyPathRenderingComponents()	Make sure all navigation objects have appropriate path rendering components set.

Overridden from UObject

		Name	Description
	void	BeginDestroy()	Called before destroying the object.
	void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Overridden from FCommonViewportClient

		Name	Description
	float	UpdateViewportClientWindowDPIScale()	FCommonViewportClient interface

Overridden from FViewportClient

	Name	Description
void	Activated ( FViewport* InViewport, const FWindowActivateEvent& InActi... )
bool	CaptureMouseOnLaunch()	Gets whether or not the viewport captures the Mouse on launch of the application Technically this controls capture on the first window activate, so in situations where the application is launched but isn't activated the effect is delayed until activation.
void	CloseRequested ( FViewport* Viewport )
void	Deactivated ( FViewport* InViewport, const FWindowActivateEvent& InActi... )
void	Draw ( FViewport* Viewport, FCanvas* SceneCanvas )
EMouseCursor...	GetCursor ( FViewport* Viewport, int32 X, int32 Y )	Retrieves the cursor that should be displayed by the OS
const TArray...	GetEnabledStats()	Get a ptr to the enabled stats list
FEngineShowF...	GetEngineShowFlags()	Return the engine show flags for this viewport
EMouseCaptur...	GetMouseCaptureMode()	Gets the mouse capture behavior when the viewport is clicked
FStatHitches...	GetStatHitchesData()	Get a ptr to the stat unit data for this viewport
FStatUnitDat...	GetStatUnitData()	Get a ptr to the stat unit data for this viewport
UWorld *	GetWorld()	Returns a relative world context for this viewport.
bool	HandleNavigation ( const uint32 InUserIndex, TSharedPtr< SWidget > InDestination )	Optionally do custom handling of a navigation.
bool	HideCursorDuringCapture()	Gets whether or not the cursor is hidden when the viewport captures the mouse
bool	IgnoreInput()	Check whether we should ignore input.
bool	InputAxis ( FViewport* Viewport, int32 ControllerId, FKey Key, float Delta, float DeltaTime, int32 NumSamples, bool bGamepad )	Check an axis movement received by the viewport.
bool	InputChar ( FViewport* Viewport, int32 ControllerId, TCHAR Character )	Check a character input received by the viewport.
bool	InputKey ( const FInputKeyEventArgs& EventArg... )	Check a key event received by the viewport.
bool	InputMotion ( FViewport* Viewport, int32 ControllerId, const FVector& Tilt, const FVector& RotationRate, const FVector& Gravity, const FVector& Acceleration )	Each frame, the input system will update the motion data.
bool	InputTouch ( FViewport* Viewport, int32 ControllerId, uint32 Handle, ETouchType::Type Type, const FVector2D& TouchLocation, float Force, FDateTime DeviceTimestamp, uint32 TouchpadIndex )	Check a key event received by the viewport.
bool	IsFocused ( FViewport* Viewport )
bool	IsInPermanentCapture()
bool	IsOrtho()	Returns true if this viewport is orthogonal.
bool	IsStatEnabled ( const FString& InName )	Check whether a specific stat is enabled for this viewport
bool	LockDuringCapture()	Gets whether or not the cursor is locked to the viewport when the viewport captures the mouse
void	LostFocus ( FViewport* Viewport )
TOptional< T...	MapCursor ( FViewport* Viewport, const FCursorReply& CursorReply )	Called to map a cursor reply to an actual widget to render.
void	MouseEnter ( FViewport* Viewport, int32 x, int32 y )
void	MouseLeave ( FViewport* Viewport )
FPopupMethod...	OnQueryPopupMethod()	Should we make new windows for popups or create an overlay in the current window.
void	Precache()
bool	ProcessScreenShots ( FViewport* Viewport )
TOptional< b...	QueryShowFocus ( const EFocusCause InFocusCause )	Called to determine if we should render the focus brush.
void	ReceivedFocus ( FViewport* Viewport )
void	RedrawRequested ( FViewport* InViewport )
bool	RequiresHitProxyStorage()
bool	RequiresUncapturedAxisInput()	Determines whether this viewport client should receive calls to InputAxis() if the game's window is not currently capturing the mouse.
void	SetEnabledStats ( const TArray< FString >& InEnabled... )	Sets all the stats that should be enabled for the viewport
void	SetIsSimulateInEditorViewport ( bool bInIsSimulateInEditorViewport )
bool	ShouldAlwaysLockMouse()	Gets whether or not the cursor should always be locked to the viewport
bool	ShouldDPIScaleSceneCanvas()	FViewport interface
bool	WindowCloseRequested()	Called when the top level window associated with the viewport has been requested to close.

Overridden from FExec

		Name	Description
	bool	Exec ( UWorld* InWorld, const TCHAR* Cmd, FOutputDevice& Ar )	Exec handler

Constants

Name	Description
CreatedDelegate	Delegate called when the game viewport is created.
EnabledStats	A list of all the stat names which are enabled for this viewport (static so they persist between runs)
ScreenshotCapturedDelegate	Delegate called at the end of the frame when a screenshot is captured
ViewportRenderedDelegate	Delegate called right after the viewport is rendered

Deprecated Variables

		Name	Description
	uint32: 1	bShowTitleSafeZone	Use the cvar "r.DebugSafeZone.Mode=1".

Deprecated Functions

	Name	Description
bool	GetDisableSplitscreenOverride()	GetDisableSplitscreenOverride is deprecated. Please call UGameViewportClient::IsSplitscreenForceDisabled() instead.
bool	InputKey ( FViewport* InViewport, int32 ControllerId, FKey Key, EInputEvent Event, float AmountDepressed, bool bGamepad )	Use the new InputKey(const FInputKeyEventArgs& EventArgs) function.
void	SetCaptureMouseOnClick ( EMouseCaptureMode Mode )	Please call UGameViewportClient::SetMouseCaptureMode(EMouseCaptureMode) instead.
void	SetDisableSplitscreenOverride ( const bool bDisabled )	SetDisableSplitscreenOverride is deprecated. Please call UGameViewportClient::SetForceDisableSplitscreen(bDisabled) instead.
void	SetLockDuringCapture ( bool InLockDuringCapture )	Mouse locking is now controlled by an enum value. Please call UGameViewportClient::SetMouseLockMode(EMouseLockMode) instead.
void	ShowTitleSafeArea()	Use the cvar "r.DebugSafeZone.Mode=1".