Navigation
API > API/Plugins > API/Plugins/DisplayCluster
Viewport context with cahched data and states
| Name | FDisplayClusterViewport_Context |
| Type | class |
| Header File | /Engine/Plugins/Runtime/nDisplay/Source/DisplayCluster/Public/Render/Viewport/Containers/DisplayClusterViewport_Context.h |
| Include Path | #include "Render/Viewport/Containers/DisplayClusterViewport_Context.h" |
Syntax
class FDisplayClusterViewport_Context
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FDisplayClusterViewport_Context
(
const uint32 InContextNum, |
Render/Viewport/Containers/DisplayClusterViewport_Context.h |
Structs
| Name | Remarks |
|---|---|
| FCachedProjectionData | Cached projection data |
| FCachedViewData | |
| FDepthOfFieldSettings | Additional data for the Depth of Field (DoF). |
| FRenderThreadData | Viewport context data for rendering thread |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bCalculated | uint8 | Is this data have been calculated. | Render/Viewport/Containers/DisplayClusterViewport_Context.h | |
| bDisableRender | uint8 | Disable render for this viewport (Overlay) | Render/Viewport/Containers/DisplayClusterViewport_Context.h | |
| bOverrideCrossGPUTransfer | uint8 | Enables nDisplay's native implementation of cross-GPU transfer. | Render/Viewport/Containers/DisplayClusterViewport_Context.h | |
| bValidData | uint8 | True if this ViewData have a valid data. | Render/Viewport/Containers/DisplayClusterViewport_Context.h | |
| CachedViewPoint | TOptional< FMinimalViewInfo > | Cached ViewInfo. | Render/Viewport/Containers/DisplayClusterViewport_Context.h | |
| ContextNum | const uint32 | Index of context (eye #) | Render/Viewport/Containers/DisplayClusterViewport_Context.h | |
| ContextSize | FIntPoint | Context size. | Render/Viewport/Containers/DisplayClusterViewport_Context.h | |
| CustomBufferRatio | float | Buffer ratio. | Render/Viewport/Containers/DisplayClusterViewport_Context.h | |
| DepthOfField | FDisplayClusterViewport_Context::FDepthOfFieldSettings | Render/Viewport/Containers/DisplayClusterViewport_Context.h | ||
| FrameTargetRect | FIntRect | Location and size on a frame target texture. | Render/Viewport/Containers/DisplayClusterViewport_Context.h | |
| GeometryToMeters | float | Geometry scale: how many Geometry Units in one meter. | Render/Viewport/Containers/DisplayClusterViewport_Context.h | |
| GPUIndex | int32 | GPU index for this context render target. | Render/Viewport/Containers/DisplayClusterViewport_Context.h | |
| NumMips | int32 | Mips number for additional MipsShader resources. | Render/Viewport/Containers/DisplayClusterViewport_Context.h | |
| OriginToWorld | FTransform | Origin component to world transform This component is defined in the projection policy | Render/Viewport/Containers/DisplayClusterViewport_Context.h | |
| OverscanInnerRenderTargetRect | FIntRect | Inner rectangle inside RenderTargetRect. | Render/Viewport/Containers/DisplayClusterViewport_Context.h | |
| OverscanProjectionMatrix | FMatrix | Overscan Projection Matrix (internal use) | Render/Viewport/Containers/DisplayClusterViewport_Context.h | |
| ProjectionData | FCachedProjectionData | Cached projection values This values updated from function FDisplayClusterViewport::CalculateProjectionMatrix() | Render/Viewport/Containers/DisplayClusterViewport_Context.h | |
| ProjectionMatrix | FMatrix | Projection Matrix. | Render/Viewport/Containers/DisplayClusterViewport_Context.h | |
| RenderTargetRect | FIntRect | Location and size on a render target texture. | Render/Viewport/Containers/DisplayClusterViewport_Context.h | |
| RenderThreadData | FRenderThreadData | This data updated only on rendering thread. | Render/Viewport/Containers/DisplayClusterViewport_Context.h | |
| RootActorToWorld | FTransform | RootActor to world transform. | Render/Viewport/Containers/DisplayClusterViewport_Context.h | |
| StereoscopicPass | EStereoscopicPass | References to IStereoRendering. | Render/Viewport/Containers/DisplayClusterViewport_Context.h | |
| StereoViewIndex | int32 | Render/Viewport/Containers/DisplayClusterViewport_Context.h | ||
| TileDestRect | FIntRect | Tile location and size in the source viewport. | Render/Viewport/Containers/DisplayClusterViewport_Context.h | |
| ViewData | FCachedViewData | View data for this context. | Render/Viewport/Containers/DisplayClusterViewport_Context.h | |
| ViewLocation | FVector | View location used in world space. | Render/Viewport/Containers/DisplayClusterViewport_Context.h | |
| ViewRotation | FRotator | View rotation used in world space. | Render/Viewport/Containers/DisplayClusterViewport_Context.h | |
| WorldToMeters | float | UE scale: how many UE Units in one meter. | Render/Viewport/Containers/DisplayClusterViewport_Context.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const FVector4 & GetRenderNearPlaneExtents() |
Returns the effective near-plane frustum extents for rendering (X=Left, Y=Right, Z=Top, W=Bottom), in world units. | Render/Viewport/Containers/DisplayClusterViewport_Context.h | |
const FMatrix & GetRenderProjectionMatrix() |
Returns the effective projection matrix for rendering. | Render/Viewport/Containers/DisplayClusterViewport_Context.h | |
const FIntRect & GetViewportContentRect() |
Returns the viewport content rect within the render target, excluding overscan padding. | Render/Viewport/Containers/DisplayClusterViewport_Context.h |