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

Light Theme

Dark Theme

FDummyViewport

Minimal viewport for assisting with taking screenshots (also used within a plugin)

Windows

MacOS

Linux

Inheritance Hierarchy

FRenderTarget

FRenderResource

FViewport

FDummyViewport

References

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

Syntax

class FDummyViewport : public FViewport

Remarks

Minimal viewport for assisting with taking screenshots (also used within a plugin)

Constructors

	Name	Description
	FDummyViewport ( FViewportClient* InViewportCli... )	FDummyViewport

Destructors

	Name	Description
	~FDummyViewport()

Overridden from FViewport

	Name	Description
void	BeginRenderFrame ( FRHICommandListImmediate& RHICmdLi... )	Starts a new rendering frame. Called from the rendering thread.
void	DeferInvalidateHitProxy()	Invalidates the viewport's cached hit proxies at the end of the frame.
void	Destroy()
void	EndRenderFrame ( FRHICommandListImmediate& RHICmdLi..., bool bPresent, bool bLockToVsync )	Ends a rendering frame. Called from the rendering thread.
FCanvas *...	GetDebugCanvas()
void	GetMousePos ( FIntPoint& MousePosition, const bool bLocalPosition )
int32	GetMouseX()
int32	GetMouseY()
FViewportFra...	GetViewportFrame()	Retrieves the interface to the viewport's frame, if it has one.
void *	GetWindow()
void	InvalidateDisplay()	Invalidates the viewport's displayed pixels.
bool	KeyState ( FKey Key )
void	MoveWindow ( int32 NewPosX, int32 NewPosY, int32 NewSizeX, int32 NewSizeY )
void	ProcessInput ( float DeltaTime )
void	SetMouse ( int32 x, int32 y )
bool	SetUserFocus ( bool bFocus )
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 FRenderResource

	Name	Description
FString	GetFriendlyName()
void	InitDynamicRHI()	Initializes the dynamic RHI resource and/or RHI render target used by this resource.
void	InitResource()	Initializes the resource. This is only called by the rendering thread.
void	InitRHI()	Initializes the RHI resources used by this resource.
void	ReleaseResource()	Prepares the resource for deletion. This is only called by the rendering thread.
void	ReleaseRHI()	Releases the RHI resources used by this resource.

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

Take our survey

Dismiss