1. Epic GamesDeveloper
  3. FDisplayClusterViewport_RenderSettings

FDisplayClusterViewport_RenderSettings

NDisplay viewport render settings.

API > API/Plugins > API/Plugins/DisplayCluster > API/Plugins/DisplayCluster/Render > API/Plugins/DisplayCluster/Render/Viewport > API/Plugins/DisplayCluster/Render/Viewport/Containers

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

Remarks

NDisplay viewport render settings. These are runtime settings, updated every frame from the cluster configuration.

Variables

  Type Name Description
Public variable bool bDisableCustomFrustumFeature Disable CustomFrustum feature from viewport settings.
Public variable bool bDisableFrustumOverscanFeature Disable viewport overscan feature from settings.
Public variable bool bEnable Enable this viewport and related resources rendering.
Public variable bool bEnableCrossGPUTransfer Enable cross-GPU transfer for this viewport.
Public variable bool bForceMono Useful to render some viewports in mono, then copied to stereo backbuffers identical image.
Public variable bool bFreezeRendering Freeze viewport resources, skip rendering internal viewport resources. But still use it for final compositing.
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 bool bWarpBlendRenderAlphaChannel Render alpha channel from input texture to warp output.
Public variable FString CameraId Assigned camera. If empty, the currently active camera must be used.
Public variable EDisplayClusterViewportCaptureMode CaptureMode Special capture modes (chromakey, lightcard) change RTT format and render flags.
Public variable FDisplayClusterViewport_CustomFrustumSettings CustomFrustumSettings Viewport custom frustum settings.
Public variable FString DisplayDeviceId Assigned display device. If empty, the currently active display device must be used.
Public variable int32 GPUIndex Performance, Multi-GPU: Asign GPU for viewport rendering. The Value '-1' used to default gpu mapping.
Protected variable EDisplayClusterViewportMediaState MediaState Viewport can be used by external media, and this affects its rules.
Public variable int32 OverlapOrder Viewport can overlap each other on backbuffer. This value uses to sorting order.
Public variable FDisplayClusterViewport_OverscanSettings OverscanSettings Viewport frustum overscan settings.
Protected variable FString ParentViewportId Parent viewport name.
Public variable FIntRect Rect Location and size on a backbuffer.
Public variable float RenderTargetAdaptRatio Performance: Render target adaptive resolution multiplier.
Public variable float RenderTargetRatio Performance: Render target base resolution multiplier.
Public variable int32 StereoGPUIndex Performance, Multi-GPU: Customize GPU for stereo mode second view (EYE_RIGHT)
Public variable FDisplayClusterViewport_TileSettings TileSettings Viewport tile rendering settings.
Protected variable FString ViewportOverrideId Override resources from another viewport. The name of the viewport used as the image source.
Protected variable EDisplayClusterViewportOverrideMode ViewportOverrideMode Override mode, which defines its rules.

Functions

  Type Name Description
Public function void Set media state for this viewport.
Public function void

AssignParentViewport ( const FString& InParentViewportId,
const FDisplayClusterViewport_RenderSettings& InParentSettings
)

 Assign parent viewport to this.
Public function void Resets the viewport settings. This function is called every frame at the beginning of the frame.
Public function void Finishes setting the viewport in the game thread. Called once per frame at the end.
Public function Const EDisplayClusterViewportMediaState Returns current media states.
Public function Const const FString & Get the name of the parent viewport.
Public function Const const FString & Get the name of the viewport used as the image source.
Public function Const EDisplayClusterViewportOverrideMode Getting the override mode that is currently in use.
Public function Const bool Returns true if the media state of this viewport is set to any of the requested states.
Public function Const bool Returns true if the viewport is assigned to a parent viewport.
Public function Const bool The viewport can be overridden from another viewport. This function returns true if it is.
Public function void

SetViewportOverride ( const FString& InViewportOverrideId,
const EDisplayClusterViewportOverrideMode InViewportOverrideMode
)

 Set an override for viewport images from another viewport.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page