FDisplayClusterViewport_RenderSettings

Choose your operating system:

Windows

macOS

Linux

References

Module

DisplayCluster

Header

/Engine/Plugins/Runtime/nDisplay/Source/DisplayCluster/Public/Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h

Include

#include "Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h"

Syntax

class FDisplayClusterViewport_RenderSettings

Variables

Name Description

Public variable

bool

 

bEnable

Enable this viewport and related resources rendering.

Public variable

bool

 

bForceMono

Useful to render some viewports in mono, then copied to stereo backbuffers identical image.

Public variable

bool

 

bSkipRendering

Skip rendering for this viewport.

Public variable

float

 

BufferRatio

Allow ScreenPercentage.

Public variable

bool

 

bVisible

This viewport visible on final frame texture (backbuffer)

Public variable

FString

 

CameraId

Assigned camera. If empty, the currently active camera must be used.

Public variable

EDisplayCluster...

 

CaptureMode

Special capture modes (chromakey, lightcard) change RTT format and render flags.

Public variable

int32

 

GPUIndex

Performance, Multi-GPU: Asign GPU for viewport rendering. The Value '-1' used to default gpu mapping.

Public variable

int32

 

OverlapOrder

Viewport can overlap each other on backbuffer. This value uses to sorting order.

Public variable

FString

 

OverrideViewportId

Override image from this viewport.

Protected variable

FString

 

ParentViewportId

Parent viewport name.

Public variable

FIntRect

 

Rect

Location and size on a backbuffer.

Public variable

int32

 

RenderFamilyGroup

Performance: Support special frame builder mode - merge viewports to single viewfamily by group num [not implemented yet] Experimental

Public variable

float

 

RenderTargetRatio

Performance: Render to scale RTT, resolved with shader to viewport (Custom value)

Public variable

int32

 

StereoGPUIndex

Performance, Multi-GPU: Customize GPU for stereo mode second view (EYE_RIGHT)

Functions

Name Description

Public function

void

 

AssignParentViewport

(
    const FString& InParentViewportId,
    const FDisplayClusterViewport_Rende...,
    bool Inherit
)

Call this after UpdateSettings()

Public function

void

 

BeginUpdateSettings()

Reset runtime values from prev frame.

Public function Const

const FStrin...

 

GetParentViewportId()