#include <DummyViewport.h>

Inheritance diagram for FDummyViewport:

Public Member Functions
ENGINE_API	FDummyViewport (FViewportClient *InViewportClient)

virtual ENGINE_API	~FDummyViewport ()

virtual void	BeginRenderFrame (FRHICommandListImmediate &RHICmdList) override

virtual void	EndRenderFrame (FRHICommandListImmediate &RHICmdList, bool bPresent, bool bLockToVsync) override

void	SetupHDR (EDisplayColorGamut InDisplayColorGamut, EDisplayOutputFormat InDisplayOutputFormat, bool bInSceneHDREnabled)

virtual void *	GetWindow () override

virtual void	MoveWindow (int32 NewPosX, int32 NewPosY, int32 NewSizeX, int32 NewSizeY) override

virtual void	Destroy () override

virtual bool	SetUserFocus (bool bFocus) override

virtual bool	KeyState (FKey Key) const override

virtual int32	GetMouseX () const override

virtual int32	GetMouseY () const override

virtual void	GetMousePos (FIntPoint &MousePosition, const bool bLocalPosition=true) override

virtual void	SetMouse (int32 x, int32 y) override

virtual void	ProcessInput (float DeltaTime) override

virtual FVector2D	VirtualDesktopPixelToViewport (FIntPoint VirtualDesktopPointPx) const override

virtual FIntPoint	ViewportToVirtualDesktopPixel (FVector2D ViewportCoordinate) const override

virtual void	InvalidateDisplay () override

virtual void	DeferInvalidateHitProxy () override

virtual FViewportFrame *	GetViewportFrame () override

virtual FCanvas *	GetDebugCanvas () override

virtual ENGINE_API EDisplayColorGamut	GetDisplayColorGamut () const

virtual ENGINE_API EDisplayOutputFormat	GetDisplayOutputFormat () const

virtual ENGINE_API bool	GetSceneHDREnabled () const

virtual ENGINE_API void	InitRHI (FRHICommandListBase &RHICmdList) override

virtual FString	GetFriendlyName () const override

Public Member Functions inherited from FViewport
	DECLARE_MULTICAST_DELEGATE_TwoParams (FOnViewportResized, FViewport *, uint32)

ENGINE_API	FViewport (FViewportClient *InViewportClient)

virtual ENGINE_API	~FViewport ()

virtual bool	HasMouseCapture () const

virtual bool	HasFocus () const

virtual bool	IsForegroundWindow () const

virtual void	CaptureMouse (bool bCapture)

virtual void	LockMouseToViewport (bool bLock)

virtual void	ShowCursor (bool bVisible)

virtual bool	UpdateMouseCursor (bool bSetCursor)

virtual void	ShowSoftwareCursor (bool bVisible)

virtual void	SetSoftwareCursorPosition (FVector2D Position)

virtual bool	IsSoftwareCursorVisible () const

virtual bool	IsCursorVisible () const

virtual float	GetTabletPressure ()

virtual bool	IsPenActive ()

virtual bool	IsFullscreen () const

virtual bool	IsExclusiveFullscreen () const

virtual EWindowMode::Type	GetWindowMode () const

virtual void	SetRequiresVsync (bool bShouldVsync)

virtual void	SetPreCaptureMousePosFromSlateCursor ()

virtual ENGINE_API void	EnqueueBeginRenderFrame (const bool bShouldPresent)

virtual ENGINE_API void	EnqueueEndRenderFrame (const bool bLockToVsync, const bool bShouldPresent)

virtual ENGINE_API FRHIGPUMask	GetGPUMask (FRHICommandListImmediate &RHICmdList) const override

virtual bool	IsKeyboardAvailable (int32 ControllerID) const

virtual bool	IsMouseAvailable (int32 ControllerID) const

virtual float	GetDesiredAspectRatio () const

ENGINE_API void	Draw (bool bShouldPresent=true)

ENGINE_API void	InvalidateHitProxy ()

ENGINE_API void	Invalidate ()

ENGINE_API const TArray< FColor > &	GetRawHitProxyData (FIntRect InRect)

ENGINE_API void	GetHitProxyMap (FIntRect InRect, TArray< HHitProxy * > &OutMap)

ENGINE_API HHitProxy *	GetHitProxy (int32 X, int32 Y)

ENGINE_API void	GetActorsAndModelsInHitProxy (FIntRect InRect, TSet< AActor * > &OutActors, TSet< UModel * > &OutModels)

ENGINE_API FTypedElementHandle	GetElementHandleAtPoint (int32 X, int32 Y)

ENGINE_API void	GetElementHandlesInRect (FIntRect InRect, FTypedElementListRef OutElementHandles)

ENGINE_API void	EnumerateHitProxiesInRect (FIntRect InRect, TFunctionRef< bool(HHitProxy *)> InCallback)

ENGINE_API FIntRect	CalculateViewExtents (float AspectRatio, const FIntRect &ViewRect)

virtual ENGINE_API void	SetViewportClient (FViewportClient *InViewportClient)

virtual FIntPoint	GetSizeXY () const override

FIntPoint	GetInitialPositionXY () const

FViewportClient *	GetClient () const

virtual ENGINE_API void	ProcessToggleFreezeCommand () override

virtual ENGINE_API bool	HasToggleFreezeCommand () override

const FViewportRHIRef &	GetViewportRHI () const

void	UpdateRenderTargetSurfaceRHIToCurrentBackBuffer ()

virtual int32	DrawStatsHUD (FCanvas *InCanvas, const int32 InX, const int32 InY)

ENGINE_API void	SetInitialSize (FIntPoint InitialSizeXY)

bool	IsPlayInEditorViewport () const

void	SetPlayInEditorViewport (bool bInPlayInEditorViewport)

bool	IsSlateViewport () const

bool	IsHDRViewport () const

void	SetHDRMode (bool bHDR)

ENGINE_API bool	TakeHighResScreenShot ()

virtual bool	IsStereoRenderingAllowed () const

virtual FIntPoint	GetRenderTargetTextureSizeXY () const

FName	GetViewportType () const

Public Member Functions inherited from FRenderTarget
ENGINE_API	FRenderTarget ()

virtual ENGINE_API	~FRenderTarget ()

virtual ENGINE_API const FTextureRHIRef &	GetRenderTargetTexture () const

virtual ENGINE_API FUnorderedAccessViewRHIRef	GetRenderTargetUAV () const

virtual ENGINE_API FRDGTextureRef	GetRenderTargetTexture (FRDGBuilder &GraphBuilder) const

virtual ENGINE_API const FTextureRHIRef &	GetShaderResourceTexture () const

virtual ENGINE_API float	GetDisplayGamma () const

virtual ENGINE_API bool	ReadPixels (TArray< FColor > &OutImageData, FReadSurfaceDataFlags InFlags=FReadSurfaceDataFlags(RCM_UNorm, CubeFace_MAX), FIntRect InSrcRect=FIntRect(0, 0, 0, 0))

ENGINE_API bool	ReadPixelsPtr (FColor *OutImageBytes, FReadSurfaceDataFlags InFlags=FReadSurfaceDataFlags(RCM_UNorm, CubeFace_MAX), FIntRect InSrcRect=FIntRect(0, 0, 0, 0))

ENGINE_API bool	ReadFloat16Pixels (TArray< FFloat16Color > &OutImageData, ECubeFace CubeFace)

virtual ENGINE_API bool	ReadFloat16Pixels (TArray< FFloat16Color > &OutImageData, FReadSurfaceDataFlags InFlags=FReadSurfaceDataFlags(RCM_UNorm, CubeFace_MAX), FIntRect InSrcRect=FIntRect(0, 0, 0, 0))

virtual ENGINE_API bool	ReadLinearColorPixels (TArray< FLinearColor > &OutImageData, FReadSurfaceDataFlags InFlags=FReadSurfaceDataFlags(RCM_MinMax, CubeFace_MAX), FIntRect InSrcRect=FIntRect(0, 0, 0, 0))

ENGINE_API bool	ReadLinearColorPixelsPtr (FLinearColor *OutImageBytes, FReadSurfaceDataFlags InFlags=FReadSurfaceDataFlags(RCM_MinMax, CubeFace_MAX), FIntRect InSrcRect=FIntRect(0, 0, 0, 0))

Additional Inherited Members
Static Public Member Functions inherited from FViewport
static ENGINE_API FIntRect	CalculateViewExtents (float AspectRatio, float DesiredAspectRatio, const FIntRect &ViewRect, const FIntPoint &DestSize)

static ENGINE_API void	SetGameRenderingEnabled (bool bIsEnabled, int32 PresentAndStopMovieDelay=0)

static bool	IsGameRenderingEnabled ()

Static Public Member Functions inherited from FRenderTarget
static float	GetEngineDisplayGamma ()

Public Attributes inherited from FViewport
FString	AppVersionString

Static Public Attributes inherited from FViewport
static ENGINE_API FOnViewportResized	ViewportResizedEvent

Protected Types inherited from FRenderResource
enum class	EInitPhase : uint8 { Pre , Default , MAX }

Protected Member Functions inherited from FViewport
virtual ENGINE_API void	UpdateViewportRHI (bool bDestroyed, uint32 NewSizeX, uint32 NewSizeY, EWindowMode::Type NewWindowMode, EPixelFormat PreferredPixelFormat)

void	HighResScreenshot ()

virtual ENGINE_API void	ReleaseRHI () override

Protected Member Functions inherited from FRenderResource
void	SetFeatureLevel (const FStaticFeatureLevel InFeatureLevel)

const FStaticFeatureLevel	GetFeatureLevel () const

bool	HasValidFeatureLevel () const

template<typename T >
FBufferRHIRef	CreateRHIBuffer (FRHICommandListBase &RHICmdList, T &InOutResourceObject, uint32 ResourceCount, EBufferUsageFlags InBufferUsageFlags, const TCHAR *InDebugName)

void	SetInitPhase (EInitPhase InInitPhase)

RENDERCORE_API	FRenderResource ()

RENDERCORE_API	FRenderResource (ERHIFeatureLevel::Type InFeatureLevel)

RENDERCORE_API	FRenderResource (const FRenderResource &)

RENDERCORE_API	FRenderResource (FRenderResource &&)

RENDERCORE_API FRenderResource &	operator= (const FRenderResource &Other)

RENDERCORE_API FRenderResource &	operator= (FRenderResource &&Other)

virtual RENDERCORE_API	~FRenderResource ()

virtual RENDERCORE_API void	InitResource (FRHICommandListBase &RHICmdList)

virtual RENDERCORE_API void	ReleaseResource ()

RENDERCORE_API void	UpdateRHI (FRHICommandListBase &RHICmdList)

bool	IsInitialized () const

int32	GetListIndex () const

EInitPhase	GetInitPhase () const

void	SetOwnerName (FName InOwnerName)

FName	GetOwnerName () const

void	SetResourceName (FName InResourceName)

FName	GetResourceName () const

Static Protected Member Functions inherited from FRenderResource
static RENDERCORE_API FRHICommandListBase &	GetImmediateCommandList ()

static RENDERCORE_API void	ReleaseRHIForAllResources ()

static RENDERCORE_API void	InitPreRHIResources ()

static RENDERCORE_API void	ChangeFeatureLevel (ERHIFeatureLevel::Type NewFeatureLevel)

static RENDERCORE_API FName	SetScopeName (FName Name)

Protected Attributes inherited from FViewport
FViewportClient *	ViewportClient

FHitProxyMap	HitProxyMap

TArray< FColor >	CachedHitProxyData

FViewportRHIRef	ViewportRHI

uint32	InitialPositionX

uint32	InitialPositionY

uint32	SizeX

uint32	SizeY

uint32	HitProxySize

EWindowMode::Type	WindowMode

uint32	bRequiresHitProxyStorage: 1

uint32	bHitProxiesCached: 1

uint32	bHasRequestedToggleFreeze: 1

uint32	bIsPlayInEditorViewport: 1

uint32	bIsSlateViewport: 1

uint32	bIsHDR: 1

FName	ViewportType

bool	bTakeHighResScreenShot

Protected Attributes inherited from FRenderTarget
FTextureRHIRef	RenderTargetTextureRHI

Protected Attributes inherited from FRenderResource
ERenderResourceState	ResourceState = ERenderResourceState::Default

Static Protected Attributes inherited from FViewport
static ENGINE_API bool	bIsGameRenderingEnabled = true

static int32	PresentAndStopMovieDelay = 0

Detailed Description

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

Constructor & Destructor Documentation

◆ FDummyViewport()

FDummyViewport::FDummyViewport ( FViewportClient * InViewportClient )

FDummyViewport

◆ ~FDummyViewport()

FDummyViewport::~FDummyViewport ( )

virtual

Member Function Documentation

◆ BeginRenderFrame()

virtual void FDummyViewport::BeginRenderFrame ( FRHICommandListImmediate & RHICmdList )

inlineoverridevirtual

Starts a new rendering frame. Called from the rendering thread.

Reimplemented from FViewport.

◆ DeferInvalidateHitProxy()

virtual void FDummyViewport::DeferInvalidateHitProxy ( )

inlineoverridevirtual

Invalidates the viewport's cached hit proxies at the end of the frame.

Reimplemented from FViewport.

◆ Destroy()

virtual void FDummyViewport::Destroy ( )

inlineoverridevirtual

Implements FViewport.

◆ EndRenderFrame()

virtual void FDummyViewport::EndRenderFrame	(	FRHICommandListImmediate &	RHICmdList,
		bool	bPresent,
		bool	bLockToVsync
	)

inlineoverridevirtual

Ends a rendering frame. Called from the rendering thread.

Parameters

bPresent	Whether the frame should be presented to the screen
bLockToVsync	Whether the GPU should block until VSYNC before presenting

Reimplemented from FViewport.

◆ GetDebugCanvas()

virtual FCanvas * FDummyViewport::GetDebugCanvas ( )

inlineoverridevirtual

Returns: A canvas that can be used while this viewport is being drawn to render debug elements on top of everything else

Reimplemented from FViewport.

◆ GetDisplayColorGamut()

EDisplayColorGamut FDummyViewport::GetDisplayColorGamut ( ) const

virtual

Reimplemented from FRenderTarget.

◆ GetDisplayOutputFormat()

EDisplayOutputFormat FDummyViewport::GetDisplayOutputFormat ( ) const

virtual

Reimplemented from FRenderTarget.

◆ GetFriendlyName()

virtual FString FDummyViewport::GetFriendlyName ( ) const

inlineoverridevirtual

Returns: The resource's friendly name. Typically a UObject name.

Reimplemented from FRenderResource.

◆ GetMousePos()

virtual void FDummyViewport::GetMousePos	(	FIntPoint &	MousePosition,
		const bool	bLocalPosition = `true`
	)

inlineoverridevirtual

Implements FViewport.

◆ GetMouseX()

virtual int32 FDummyViewport::GetMouseX ( ) const

inlineoverridevirtual

Implements FViewport.

◆ GetMouseY()

virtual int32 FDummyViewport::GetMouseY ( ) const

inlineoverridevirtual

Implements FViewport.

◆ GetSceneHDREnabled()

bool FDummyViewport::GetSceneHDREnabled ( ) const

virtual

Reimplemented from FRenderTarget.

◆ GetViewportFrame()

virtual FViewportFrame * FDummyViewport::GetViewportFrame ( )

inlineoverridevirtual

Retrieves the interface to the viewport's frame, if it has one.

Returns: The viewport's frame interface.

Implements FViewport.

◆ GetWindow()

virtual void * FDummyViewport::GetWindow ( )

inlineoverridevirtual

Implements FViewport.

◆ InitRHI()

void FDummyViewport::InitRHI ( FRHICommandListBase & RHICmdList )

overridevirtual

Initializes the RHI resources used by this resource. Called when entering the state where both the resource and the RHI have been initialized. This is only called by the rendering thread.

Reimplemented from FViewport.

◆ InvalidateDisplay()

virtual void FDummyViewport::InvalidateDisplay ( )

inlineoverridevirtual

Invalidates the viewport's displayed pixels.

Implements FViewport.

◆ KeyState()

virtual bool FDummyViewport::KeyState ( FKey Key ) const

inlineoverridevirtual

Implements FViewport.

◆ MoveWindow()

virtual void FDummyViewport::MoveWindow	(	int32	NewPosX,
		int32	NewPosY,
		int32	NewSizeX,
		int32	NewSizeY
	)

inlineoverridevirtual

Implements FViewport.

◆ ProcessInput()

virtual void FDummyViewport::ProcessInput ( float DeltaTime )

inlineoverridevirtual

Implements FViewport.

◆ SetMouse()

virtual void FDummyViewport::SetMouse	(	int32	x,
		int32	y
	)

inlineoverridevirtual

Implements FViewport.

◆ SetupHDR()

void FDummyViewport::SetupHDR	(	EDisplayColorGamut	InDisplayColorGamut,
		EDisplayOutputFormat	InDisplayOutputFormat,
		bool	bInSceneHDREnabled
	)

inline

◆ SetUserFocus()

virtual bool FDummyViewport::SetUserFocus ( bool bFocus )

inlineoverridevirtual

Implements FViewport.

◆ ViewportToVirtualDesktopPixel()

virtual FIntPoint FDummyViewport::ViewportToVirtualDesktopPixel ( FVector2D ViewportCoordinate ) const

inlineoverridevirtual

Transforms a coordinate in the local space of this viewport into a virtual desktop pixel.

Parameters

ViewportCoordiante Normalized coordniate in the rate [0..1]; (0,0) is upper left and (1,1) is lower right.

Returns: the transformed coordinate. It is in virtual desktop pixels.

Implements FViewport.

◆ VirtualDesktopPixelToViewport()

virtual FVector2D FDummyViewport::VirtualDesktopPixelToViewport ( FIntPoint VirtualDesktopPointPx ) const

inlineoverridevirtual

Transforms a virtual desktop pixel (the origin is in the primary screen's top left corner) to the local space of this viewport

Parameters

VirtualDesktopPointPx Coordinate on the virtual desktop in pixel units. Desktop is considered virtual because multiple monitors are supported.

Returns: The transformed pixel. It is normalized to the range [0, 1]

Implements FViewport.

The documentation for this class was generated from the following files:

Engine/Source/Runtime/Engine/Public/DummyViewport.h
Engine/Source/Runtime/Engine/Private/UnrealClient.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FDummyViewport()

◆ ~FDummyViewport()

Member Function Documentation

◆ BeginRenderFrame()

◆ DeferInvalidateHitProxy()

◆ Destroy()

◆ EndRenderFrame()

◆ GetDebugCanvas()

◆ GetDisplayColorGamut()

◆ GetDisplayOutputFormat()

◆ GetFriendlyName()

◆ GetMousePos()

◆ GetMouseX()

◆ GetMouseY()

◆ GetSceneHDREnabled()

◆ GetViewportFrame()

◆ GetWindow()

◆ InitRHI()

◆ InvalidateDisplay()

◆ KeyState()

◆ MoveWindow()

◆ ProcessInput()

◆ SetMouse()

◆ SetupHDR()

◆ SetUserFocus()

◆ ViewportToVirtualDesktopPixel()

◆ VirtualDesktopPixelToViewport()