FDisplayClusterViewport_RenderSettings


Name	FDisplayClusterViewport_RenderSettings
Type	class
Header File	/Engine/Plugins/Runtime/nDisplay/Source/DisplayCluster/Public/Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
Include Path	#include "Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h"

Name	Type	Remarks	Include Path
bDisableCustomFrustumFeature	bool	Disable CustomFrustum feature from viewport settings.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
bDisableFrustumOverscanFeature	bool	Disable viewport overscan feature from settings.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
bEnable	bool	Enable this viewport and related resources rendering.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
bEnableCrossGPUTransfer	bool	Enable cross-GPU transfer for this viewport.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
bForceMono	bool	Useful to render some viewports in mono, then copied to stereo backbuffers identical image.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
bFreezeRendering	bool	Freeze viewport resources, skip rendering internal viewport resources. But still use it for final compositing.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
bSkipRendering	bool	Skip rendering for this viewport.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
BufferRatio	float	Allow ScreenPercentage.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
bVisible	bool	This viewport visible on final frame texture (backbuffer)	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
bWarpBlendRenderAlphaChannel	bool	Render alpha channel from input texture to warp output.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
CameraId	FString	Assigned camera. If empty, the currently active camera must be used.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
CaptureMode	EDisplayClusterViewportCaptureMode	Special capture modes (chromakey, lightcard) change RTT format and render flags.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
CustomFrustumSettings	FDisplayClusterViewport_CustomFrustumSettings	Viewport custom frustum settings.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
DisplayDeviceId	FString	Assigned display device. If empty, the currently active display device must be used.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
GPUIndex	int32	Performance, Multi-GPU: Asign GPU for viewport rendering. The Value '-1' used to default gpu mapping.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
OverlapOrder	int32	Viewport can overlap each other on backbuffer. This value uses to sorting order.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
OverscanSettings	FDisplayClusterViewport_OverscanSettings	Viewport frustum overscan settings.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
Rect	FIntRect	Location and size on a backbuffer.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
RenderTargetAdaptRatio	float	Performance: Render target adaptive resolution multiplier.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
RenderTargetRatio	float	Performance: Render target base resolution multiplier.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
StereoGPUIndex	int32	Performance, Multi-GPU: Customize GPU for stereo mode second view (EYE_RIGHT)	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
TileSettings	FDisplayClusterViewport_TileSettings	Viewport tile rendering settings.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
UpscalerSettings	FDisplayClusterUpscalerSettings	Upscaler settings.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h

Name	Remarks	Include Path
void AssignMediaStates ( const EDisplayClusterViewportMediaState InMediaStates )	Set media state for this viewport.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
void AssignParentViewport ( const FString& InParentViewportId, const FDisplayClusterViewport_RenderSettings& InParentSettings )	Assign parent viewport to this.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
void BeginUpdateSettings()	Resets the viewport settings. This function is called every frame at the beginning of the frame.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
void FinishUpdateSettings()	Finishes setting the viewport in the game thread. Called once per frame at the end.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
EDisplayClusterViewportMediaState GetMediaStates()	Returns current media states.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
const FString & GetParentViewportId()	Get the name of the parent viewport.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
const FString & GetViewportOverrideId()	Get the name of the viewport used as the image source.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
EDisplayClusterViewportOverrideMode GetViewportOverrideMode()	Getting the override mode that is currently in use.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
bool HasAnyMediaStates ( const EDisplayClusterViewportMediaState InMediaStates ) const	Returns true if the media state of this viewport is set to any of the requested states.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
bool IsViewportHasParent()	Returns true if the viewport is assigned to a parent viewport.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
bool IsViewportOverridden()	The viewport can be overridden from another viewport. This function returns true if it is.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h
void SetViewportOverride ( const FString& InViewportOverrideId, const EDisplayClusterViewportOverrideMode InViewportOverrideMode )	Set an override for viewport images from another viewport.	Render/Viewport/Containers/DisplayClusterViewport_RenderSettings.h

Navigation

Syntax

Variables

Public

Functions

Public