FDummyViewport

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

API > API/Runtime > API/Runtime/Engine

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

   
Name FDummyViewport
Type class
Header File /Engine/Source/Runtime/Engine/Public/DummyViewport.h
Include Path #include "DummyViewport.h"

Syntax

class FDummyViewport : public FViewport

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
FDummyViewport DummyViewport.h  

FDummyViewport ( FViewportClient*const Client
)

   DummyViewport.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FDummyViewport()

   DummyViewport.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bSceneHDREnabled bool   DummyViewport.h  
DebugCanvas FCanvas *   DummyViewport.h  
DisplayColorGamut EDisplayColorGamut   DummyViewport.h  
DisplayOutputFormat EDisplayOutputFormat   DummyViewport.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

   DummyViewport.h  

Public Virtual

Overridden from FViewport

Name Remarks Include Path Unreal Specifiers

virtual void DeferInvalidateHitProxy()

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

virtual void Destroy()

   DummyViewport.h  

virtual FCanvas * GetDebugCanvas()

   DummyViewport.h  

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

   DummyViewport.h  

virtual int32 GetMouseX()

   DummyViewport.h  

virtual int32 GetMouseY()

   DummyViewport.h  

virtual void * GetWindow()

   DummyViewport.h  

virtual void InvalidateDisplay()

 Invalidates the viewport's displayed pixels. DummyViewport.h  

virtual bool KeyState ( FKey Key
) const

   DummyViewport.h  

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

   DummyViewport.h  

virtual void ProcessInput ( float DeltaTime
)

   DummyViewport.h  

virtual void SetInitialSize ( FIntPoint InitialSizeXY
)

 Sets the initial size of this viewport. Will do nothing if the viewport has already been sized DummyViewport.h  

virtual void SetMouse ( int32 x,
int32 y
)

   DummyViewport.h  

virtual bool SetUserFocus ( bool bFocus
)

   DummyViewport.h  

virtual FIntPoint ViewportToVirtualDesktopPixel ( FVector2D ViewportCoordinate
) const

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

virtual FVector2D VirtualDesktopPixelToViewport ( FIntPoint VirtualDesktopPointPx
) const

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

Overridden from FRenderTarget

Name Remarks Include Path Unreal Specifiers

virtual EDisplayColorGamut GetDisplayColorGamut()

   DummyViewport.h  

virtual EDisplayOutputFormat GetDisplayOutputFormat()

   DummyViewport.h  

virtual bool GetSceneHDREnabled()

   DummyViewport.h  

Overridden from FRenderResource

Name Remarks Include Path Unreal Specifiers

virtual FString GetFriendlyName()

   DummyViewport.h  

virtual void InitRHI ( FRHICommandListBase& RHICmdList
)

   DummyViewport.h  

Protected

Static

Name Remarks Include Path Unreal Specifiers
  DummyViewport.h  
  DummyViewport.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page