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 bIsBeingCaptured Is this viewport being captured by a media capture device?
Public variable bool bPreviewReadPixels Read viewport pixels for preview (this flag is cleared at the end of the frame)
Public variable bool bSkipRendering Skip rendering for this viewport.
Public variable bool bSkipSceneRenderingButLeaveResourcesAvailable This flag means no scene rendering required, but all internal resources should still be valid for the media subsystem.
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 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.
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 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 FString ViewportOverrideId  
Public variable EDisplayClusterViewportOverrideMode ViewportOverrideMode Override resources from this viewport.

Functions

  Type Name Description
Public function void

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

 Call this after UpdateSettings()
Public function void Reset runtime values from prev frame.
Public function void  
Public function Const const FString &  
Public function Const bool  
Public function Const bool  
Public function void

SetViewportOverride ( const FString& InViewportOverrideId,
const EDisplayClusterViewportOverrideMode InViewportOverrideMode
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page