1. Epic GamesDeveloper
  3. FViewport

FViewport

Encapsulates the I/O of a viewport.

Unreal Engine C++ API Reference > Runtime > Engine

Inheritance Hierarchy

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

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

Constructors

  Type Name Description
Public function  

FViewport ( FViewportClient* InViewportClient
)

 Constructor.

Destructors

  Type Name Description
Public function Virtual   Destructor.

Functions

  Type Name Description
Public function Virtual void Starts a new rendering frame. Called from the rendering thread.
Public function FIntRect

CalculateViewExtents ( float AspectRatio,
const FIntRect& ViewRect
)

 Calculates the view inside the viewport when the aspect ratio is locked.
Public function Virtual void

CaptureMouse ( bool bCapture
)

  
Public function Virtual void Invalidates the viewport's cached hit proxies at the end of the frame.
Public function void

Destroy ()

  
Public function void

Draw ( bool bShouldPresent
)

 Updates the viewport's displayed pixels with the results of calling ViewportClient->Draw.
Public function Virtual int32

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

 First chance for viewports to render custom stats text
Public function Virtual void

EndRenderFrame ( FRHICommandListImmediate& RHICmdList,
bool bPresent,
bool bLockToVsync
)

 Ends a rendering frame. Called from the rendering thread.
Public function Virtual void

EnqueueBeginRenderFrame ( const bool bShouldPresent
)

 Starts a new rendering frame.
Public function Virtual void

EnqueueEndRenderFrame ( const bool bLockToVsync,
const bool bShouldPresent
)

 Ends a rendering frame. Called from the game thread.
Public function void

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

 Returns all actors and models found in the hit proxy within a specified region.
Public function Const FViewportClient * Accessors.
Public function Virtual FCanvas *  
Public function Virtual Const float  
Public function FTypedElementHandle

GetElementHandleAtPoint ( int32 X,
int32 Y
)

 Returns the dominant element handle at a given point.
Public function void

GetElementHandlesInRect ( FIntRect InRect,
FTypedElementListRef OutElementHandles
)

 Returns all element handles found within a specified region.
Public function HHitProxy *

GetHitProxy ( int32 X,
int32 Y
)

 Returns the dominant hit proxy at a given point.
Public function void

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

 Copies the hit proxies from an area of the screen into a buffer.
Public function Const FIntPoint  
Public function void

GetMousePos ( FIntPoint& MousePosition,
const bool bLocalPosition
)

  
Public function Const int32  
Public function Const int32  
Public function const TArray< FColor > &

GetRawHitProxyData ( FIntRect InRect
)

  
Public function Virtual Const FIntPoint Returns dimensions of RenderTarget texture. Can be called on a game thread.
Public function Virtual float  
Public function FViewportFrame * Retrieves the interface to the viewport's frame, if it has one.
Public function Const const FViewportRHIRef & Accessors for RHI resources
Public function Const FName  
Public function void *  
Public function Virtual Const EWindowMode::Type  
Public function Virtual Const bool  
Public function Virtual Const bool New MouseCapture/MouseLock API.
Protected function void Take a high-resolution screenshot and save to disk.
Public function void Invalidates cached hit proxies and the display.
Public function void Invalidates the viewport's displayed pixels.
Public function void Invalidates cached hit proxies
Public function Virtual Const bool Returns true if the mouse cursor is currently visible
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Static bool Returns whether rendering is globally enabled or disabled.
Public function Const bool Returns true if this viewport should be rendered in HDR
Public function Virtual Const bool

IsKeyboardAvailable ( int32 ControllerID
)

  
Public function Virtual Const bool

IsMouseAvailable ( int32 ControllerID
)

  
Public function Virtual bool  
Public function Const bool Returns true if the viewport is for play in editor
Public function Const bool Returns true if this is an FSlateSceneViewport
Public function Virtual Const bool  
Public function Virtual Const bool Should return true, if stereo rendering is allowed in this viewport
Public function Const bool

KeyState ( FKey Key
)

  
Public function Virtual void

LockMouseToViewport ( bool bLock
)

  
Public function void

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

  
Public function void

ProcessInput ( float DeltaTime
)

  
Public function Static void

SetGameRenderingEnabled ( bool bIsEnabled,
int32 PresentAndStopMovieDelay
)

 Globally enables/disables rendering
Public function void

SetHDRMode ( bool bHDR
)

 Sets HDR Status of Viewport
Public function void

SetInitialSize ( FIntPoint InitialSizeXY
)

 Sets the initial size of this viewport. Will do nothing if the viewport has already been sized
Public function void

SetMouse ( int32 x,
int32 y
)

  
Public function void

SetPlayInEditorViewport ( bool bInPlayInEditorViewport
)

 Sets this viewport as a play in editor viewport
Public function Virtual void Sets PreCapture coordinates from the current position of the slate cursor.
Public function Virtual void

SetRequiresVsync ( bool bShouldVsync
)

 Indicate that the viewport should be block for vsync.
Public function Virtual void

SetSoftwareCursorPosition ( FVector2D Position
)

  
Public function bool

SetUserFocus ( bool bFocus
)

  
Public function Virtual void

SetViewportClient ( FViewportClient* InViewportClient
)

 Sets a viewport client if one wasn't provided at construction time.
Public function Virtual void

ShowCursor ( bool bVisible
)

  
Public function Virtual void

ShowSoftwareCursor ( bool bVisible
)

  
Public function bool Trigger a high res screenshot.
Public function Virtual bool

UpdateMouseCursor ( bool bSetCursor
)

  
Public function void Update the render target surface RHI to the current back buffer
Protected function Virtual void

UpdateViewportRHI ( bool bDestroyed,
uint32 NewSizeX,
uint32 NewSizeY,
EWindowMode::Type NewWindowMode,
EPixelFormat PreferredPixelFormat
)

 Updates the viewport RHI with the current viewport state.
Public function Const FIntPoint

ViewportToVirtualDesktopPixel ( FVector2D ViewportCoordinate
)

 Transforms a coordinate in the local space of this viewport into a virtual desktop pixel.
Public function 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 FRenderTarget

  Type Name Description
Public function Virtual Const FRHIGPUMask Returns the GPU nodes on which to render this viewport.
Public function Virtual Const FIntPoint Properties.
Public function Virtual bool Returns if there is a command to freezeReturns if there is a command to toggle freezing
Public function Virtual void Handles freezing/unfreezing of rendering

Overridden from FRenderResource

  Type Name Description
Protected function Virtual void

InitRHI ( FRHICommandListBase& RHICmdList
)

 Initializes the RHI resources used by this resource.
Protected function Virtual void Releases the RHI resources used by this resource.

Classes

  Type Name Description
Protected class 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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page