FDummyViewport

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

Windows
MacOS
Linux

Inheritance Hierarchy

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

Public function

FDummyViewport

(
    FViewportClient* InViewportCli...
)

FDummyViewport

Destructors

Name Description

Public function Virtual

~FDummyViewport()

Overridden from FViewport

Name Description

Public function Virtual

void

 

BeginRenderFrame

(
    FRHICommandListImmediate& RHICmdLi...
)

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

Public function Virtual

void

 

DeferInvalidateHitProxy()

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

Public function Virtual

void

 

Destroy()

Public function Virtual

void

 

EndRenderFrame

(
    FRHICommandListImmediate& RHICmdLi...,
    bool bPresent,
    bool bLockToVsync
)

Ends a rendering frame. Called from the rendering thread.

Public function Virtual

FCanvas *...

 

GetDebugCanvas()

Public function Virtual

void

 

GetMousePos

(
    FIntPoint& MousePosition,
    const bool bLocalPosition
)

Public function Virtual Const

int32

 

GetMouseX()

Public function Virtual Const

int32

 

GetMouseY()

Public function Virtual

FViewportFra...

 

GetViewportFrame()

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

Public function Virtual

void *

 

GetWindow()

Public function Virtual

void

 

InvalidateDisplay()

Invalidates the viewport's displayed pixels.

Public function Virtual Const

bool

 

KeyState

(
    FKey Key
)

Public function Virtual

void

 

MoveWindow

(
    int32 NewPosX,
    int32 NewPosY,
    int32 NewSizeX,
    int32 NewSizeY
)

Public function Virtual

void

 

ProcessInput

(
    float DeltaTime
)

Public function Virtual

void

 

SetMouse

(
    int32 x,
    int32 y
)

Public function Virtual

bool

 

SetUserFocus

(
    bool bFocus
)

Public function Virtual Const

FIntPoint

 

ViewportToVirtualDesktopPixel

(
    FVector2D ViewportCoordinate
)

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

Public function Virtual Const

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

Public function Virtual Const

FString

 

GetFriendlyName()

Public function Virtual

void

 

InitDynamicRHI()

Initializes the dynamic RHI resource and/or RHI render target used by this resource.

Public function Virtual

void

 

InitResource()

Initializes the resource. This is only called by the rendering thread.

Public function Virtual

void

 

InitRHI()

Initializes the RHI resources used by this resource.

Public function Virtual

void

 

ReleaseResource()

Prepares the resource for deletion. This is only called by the rendering thread.

Public function Virtual

void

 

ReleaseRHI()

Releases the RHI resources used by this resource.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback