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 > FViewport

Light Theme

Dark Theme

FViewport

Encapsulates the I/O of a viewport.

Inheritance Hierarchy

FRenderTarget

FRenderResource

FViewport

	FDummyViewport
	FSceneViewport

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/UnrealClient.h
Include	#include "UnrealClient.h"

Syntax

class FViewport :
public FRenderTarget,
protected FRenderResource

Remarks

Encapsulates the I/O of a viewport. The viewport display is implemented using the platform independent RHI.

Variables

	Name	Description
FString	AppVersionString	The current version of the running instance
uint32: 1	bHasRequestedToggleFreeze	If a toggle freeze request has been made
uint32: 1	bHitProxiesCached	True if the hit proxy buffer buffer has up to date hit proxies for this viewport.
uint32: 1	bIsHDR	If true this viewport is being displayed on a HDR monitor
uint32: 1	bIsPlayInEditorViewport	If true this viewport is for play in editor
uint32: 1	bIsSlateViewport	If true this viewport is an FSlateSceneViewport
uint32: 1	bRequiresHitProxyStorage	True if the viewport client requires hit proxy storage.
bool	bTakeHighResScreenShot	Triggers the taking of a high res screen shot for this viewport.
TArray< FColor ...	CachedHitProxyData	Cached hit proxy data.
FHitProxyMap	HitProxyMap	The viewport's hit proxy map.
uint32	HitProxySize	The size of the region to check hit proxies
uint32	InitialPositionX	The initial position of the viewport.
uint32	InitialPositionY	The initial position of the viewport.
uint32	SizeX	The width of the viewport.
uint32	SizeY	The height of the viewport.
FViewportClient...	ViewportClient	The viewport's client.
FViewportRHIRef	ViewportRHI	The RHI viewport.
FName	ViewportType	Used internally for testing runtime instance type before casting
EWindowMode::Ty...	WindowMode	What is the current window mode.

Constructors

	Name	Description
	FViewport ( FViewportClient* InViewportCli... )	Constructor.

Destructors

	Name	Description
	~FViewport()	Destructor.

Functions

	Name	Description
void	BeginRenderFrame ( FRHICommandListImmediate& RHICmdLi... )	Starts a new rendering frame. Called from the rendering thread.
FIntRect	CalculateViewExtents ( float AspectRatio, const FIntRect& ViewRect )	Calculates the view inside the viewport when the aspect ratio is locked.
void	CaptureMouse ( bool bCapture )
void	DeferInvalidateHitProxy()	Invalidates the viewport's cached hit proxies at the end of the frame.
void	Destroy()
void	Draw ( bool bShouldPresent )	Updates the viewport's displayed pixels with the results of calling ViewportClient->Draw.
int32	DrawStatsHUD ( FCanvas* InCanvas, const int32 InX, const int32 InY )	First chance for viewports to render custom stats text
void	EndRenderFrame ( FRHICommandListImmediate& RHICmdLi..., bool bPresent, bool bLockToVsync )	Ends a rendering frame. Called from the rendering thread.
void	EnqueueBeginRenderFrame ( const bool bShouldPresent )	Starts a new rendering frame.
void	EnqueueEndRenderFrame ( const bool bLockToVsync, const bool bShouldPresent )	Ends a rendering frame. Called from the game thread.
void	GetActorsAndModelsInHitProxy ( FIntRect InRect, TSet< AActor* >& OutActors, TSet< UModel* >& OutModels )	Returns all actors and models found in the hit proxy within a specified region.
FViewportCli...	GetClient()	Accessors.
FCanvas *...	GetDebugCanvas()
float	GetDesiredAspectRatio()
FTypedElemen...	GetElementHandleAtPoint ( int32 X, int32 Y )	Returns the dominant element handle at a given point.
void	GetElementHandlesInRect ( FIntRect InRect, FTypedElementListRef OutElementHand... )	Returns all element handles found within a specified region.
HHitProxy &#...	GetHitProxy ( int32 X, int32 Y )	Returns the dominant hit proxy at a given point.
void	GetHitProxyMap ( FIntRect InRect, TArray< HHitProxy* >& OutMap )	Copies the hit proxies from an area of the screen into a buffer.
FIntPoint	GetInitialPositionXY()
void	GetMousePos ( FIntPoint& MousePosition, const bool bLocalPosition )
int32	GetMouseX()
int32	GetMouseY()
const TArray...	GetRawHitProxyData ( FIntRect InRect )
FIntPoint	GetRenderTargetTextureSizeXY()	Returns dimensions of RenderTarget texture. Can be called on a game thread.
float	GetTabletPressure()
FViewportFra...	GetViewportFrame()	Retrieves the interface to the viewport's frame, if it has one.
const FViewp...	GetViewportRHI()	Accessors for RHI resources
FName	GetViewportType()
void *	GetWindow()
EWindowMode:...	GetWindowMode()
bool	HasFocus()
bool	HasMouseCapture()	New MouseCapture/MouseLock API.
void	HighResScreenshot()	Take a high-resolution screenshot and save to disk.
void	Invalidate()	Invalidates cached hit proxies and the display.
void	InvalidateDisplay()	Invalidates the viewport's displayed pixels.
void	InvalidateHitProxy()	Invalidates cached hit proxies
bool	IsCursorVisible()	Returns true if the mouse cursor is currently visible
bool	IsExclusiveFullscreen()
bool	IsForegroundWindow()
bool	IsFullscreen()
bool	IsGameRenderingEnabled()	Returns whether rendering is globally enabled or disabled.
bool	IsHDRViewport()	Returns true if this viewport should be rendered in HDR
bool	IsKeyboardAvailable ( int32 ControllerID )
bool	IsMouseAvailable ( int32 ControllerID )
bool	IsPenActive()
bool	IsPlayInEditorViewport()	Returns true if the viewport is for play in editor
bool	IsSlateViewport()	Returns true if this is an FSlateSceneViewport
bool	IsSoftwareCursorVisible()
bool	IsStereoRenderingAllowed()	Should return true, if stereo rendering is allowed in this viewport
bool	KeyState ( FKey Key )
void	LockMouseToViewport ( bool bLock )
void	MoveWindow ( int32 NewPosX, int32 NewPosY, int32 NewSizeX, int32 NewSizeY )
void	ProcessInput ( float DeltaTime )
void	SetGameRenderingEnabled ( bool bIsEnabled, int32 PresentAndStopMovieDelay )	Globally enables/disables rendering
void	SetHDRMode ( bool bHDR )	Sets HDR Status of Viewport
void	SetInitialSize ( FIntPoint InitialSizeXY )	Sets the initial size of this viewport. Will do nothing if the viewport has already been sized
void	SetMouse ( int32 x, int32 y )
void	SetPlayInEditorViewport ( bool bInPlayInEditorViewport )	Sets this viewport as a play in editor viewport
void	SetPreCaptureMousePosFromSlateCursor()	Sets PreCapture coordinates from the current position of the slate cursor.
void	SetRequiresVsync ( bool bShouldVsync )	Indicate that the viewport should be block for vsync.
void	SetSoftwareCursorPosition ( FVector2D Position )
bool	SetUserFocus ( bool bFocus )
void	SetViewportClient ( FViewportClient* InViewportCli... )	Sets a viewport client if one wasn't provided at construction time.
void	ShowCursor ( bool bVisible )
void	ShowSoftwareCursor ( bool bVisible )
bool	TakeHighResScreenShot()	Trigger a high res screenshot.
bool	UpdateMouseCursor ( bool bSetCursor )
void	UpdateRenderTargetSurfaceRHIToCurrentBackBuffer()	Update the render target surface RHI to the current back buffer
void	UpdateViewportRHI ( bool bDestroyed, uint32 NewSizeX, uint32 NewSizeY, EWindowMode::Type NewWindowMode, EPixelFormat PreferredPixelFormat )	Updates the viewport RHI with the current viewport state.
FIntPoint	ViewportToVirtualDesktopPixel ( FVector2D ViewportCoordinate )	Transforms a coordinate in the local space of this viewport into a virtual desktop pixel.
FVector2D	VirtualDesktopPixelToViewport ( FIntPoint VirtualDesktopPointPx )	Transforms a virtual desktop pixel (the origin is in the primary screen's top left corner) to the local space of this viewport

Overridden from FRenderTarget

	Name	Description
FRHIGPUMask	GetGPUMask ( FRHICommandListImmediate& RHICmdLi... )	Returns the GPU nodes on which to render this viewport.
FIntPoint	GetSizeXY()	Properties.
bool	HasToggleFreezeCommand()	Returns if there is a command to freeze Returns if there is a command to toggle freezing
void	ProcessToggleFreezeCommand()	Handles freezing/unfreezing of rendering

Overridden from FRenderResource

	Name	Description
void	InitDynamicRHI()	Initializes the dynamic RHI resource and/or RHI render target used by this resource.
void	InitRHI()	Initializes the RHI resources used by this resource.
void	ReleaseDynamicRHI()	Releases the dynamic RHI resource and/or RHI render target resources used by this resource.
void	ReleaseRHI()	Releases the RHI resources used by this resource.

Classes

	Name	Description
	FHitProxyMap	A map from 2D coordinates to cached hit proxies.

Typedefs

Name	Description
FOnViewportResized	Delegate type for viewport resize events ( Params: FViewport* Viewport, uint32 )

Constants

Name	Description
bIsGameRenderingEnabled	True if we should draw game viewports (has no effect on Editor viewports)
PresentAndStopMovieDelay	Delay in frames to disable present (but still render scene) and stopping of a movie.
ViewportResizedEvent	Send when a viewport is resized

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

Take our survey

Cancel