1. Epic GamesDeveloper
  3. IDisplayClusterProjectionPolicy

IDisplayClusterProjectionPolicy

NDisplay projection policy

API > API/Plugins > API/Plugins/DisplayCluster

NDisplay projection policy

   
Name IDisplayClusterProjectionPolicy
Type class
Header File /Engine/Plugins/Runtime/nDisplay/Source/DisplayCluster/Public/Render/Projection/IDisplayClusterProjectionPolicy.h
Include Path #include "Render/Projection/IDisplayClusterProjectionPolicy.h"

Syntax

class IDisplayClusterProjectionPolicy

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IDisplayClusterProjectionPolicy()

   Render/Projection/IDisplayClusterProjectionPolicy.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void ApplyClippingPlanesOverrides ( const IDisplayClusterViewport* InViewport,
float& InOutNCP,
float& InOutFCP
) const

 Projection policy can modify the clipping planes. Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual void ApplyWarpBlend_RenderThread ( FRHICommandListImmediate& RHICmdList,
const IDisplayClusterViewportProxy* InViewportProxy
)

 Performs Warp and Blend on the rendering thread Have to be called only if IsWarpBlendSupported_RenderThread() returns true Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual void BeginUpdateFrameContexts ( IDisplayClusterViewport* InViewport
) const

 Called before FDisplayClusterViewport::UpdateFrameContexts() From this function, the policy can override any viewport settings (custom overscan, etc). Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual void BeginWarpBlend_RenderThread ( FRHICommandListImmediate& RHICmdList,
const IDisplayClusterViewportProxy* InViewportProxy
)

 Initializing the projection policy logic for the current frame before applying warp blending. Render/Projection/IDisplayClusterProjectionPolicy.h  

bool CalculateView ( IDisplayClusterViewport* InViewport,
const uint32 InContextNum,
FVector& InOutViewLocation,
FRotator& InOutViewRotation,
const FVector& ViewOffset,
const float WorldToMeters,
const float NCP,
const float FCP
)

 Calculate view projection data Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual void EndUpdateFrameContexts ( IDisplayClusterViewport* InViewport
) const

 Called after FDisplayClusterViewport::UpdateFrameContexts() Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual void EndWarpBlend_RenderThread ( FRHICommandListImmediate& RHICmdList,
const IDisplayClusterViewportProxy* InViewportProxy
)

 Completing the projection policy logic for the current frame after applying warp blending. Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual bool GetCustomRenderTargetSize ( const IDisplayClusterViewport* InViewport,
FIntPoint& OutRenderTargetSize
) const

 This function can override the size of the RenderTarget texture for the viewport. Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual float GetGeometryToMeters ( const IDisplayClusterViewport* InViewport,
const float InWorldToMeters
) const

 If the projection policy uses a custom scale internally, this function returns that value. Render/Projection/IDisplayClusterProjectionPolicy.h  

const FString & GetId()

 Return projection policy instance ID Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual UMeshComponent * GetOrCreatePreviewEditableMeshComponent ( IDisplayClusterViewport* InViewport
)

 Build preview Editable mesh This MeshComponent is a copy of the preview mesh and can be moved freely with the UI visualization. Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual UMeshComponent * GetOrCreatePreviewMeshComponent ( IDisplayClusterViewport* InViewport,
bool& bOutIsRootActorComponent
)

 Build preview mesh This MeshComponent cannot be moved freely. Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual USceneComponent *const GetOriginComponent()

 Return Origin point component used by this viewport This component is used to convert from the local DCRA space to the local projection policy space, which contains the calibrated geometry data used for the warp. Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual FVector GetOriginLocationOffsetInGeometryUnits ( const IDisplayClusterViewport* InViewport
) const

 Returns Origin's location in geometry units. Render/Projection/IDisplayClusterProjectionPolicy.h  

const TMap< FString, FString > & GetParameters()

 Return projection policy configuration Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual USceneComponent *const GetPreviewEditableMeshOriginComponent ( IDisplayClusterViewport* InViewport
) const

 Return Origin point component used by preview Editable mesh Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual USceneComponent *const GetPreviewMeshOriginComponent ( IDisplayClusterViewport* InViewport
) const

 Return Origin point component used by preview mesh Render/Projection/IDisplayClusterProjectionPolicy.h  

bool GetProjectionMatrix ( IDisplayClusterViewport* InViewport,
const uint32 InContextNum,
FMatrix& OutPrjMatrix
)

 Gets projection matrix Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual EDisplayClusterProjectionPolicyFlags GetProjectionPolicyFlags ( const IDisplayClusterViewport* InViewport,
const uint32 InContextNum
) const

 Return Projection policy flags Render/Projection/IDisplayClusterProjectionPolicy.h  

const FString & GetType()

 Return projection policy type Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual bool GetWarpBlendInterface ( TSharedPtr< IDisplayClusterWarpBlend, ESPMode::ThreadSafe >& OutWarpBlendInterface
) const

 Return warpblend interface of this policy Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual bool GetWarpBlendInterface_RenderThread ( TSharedPtr< IDisplayClusterWarpBlend, ESPMode::ThreadSafe >& OutWarpBlendInterfaceProxy
) const

 Return warpblend interface proxy of this policy Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual IDisplayClusterWarpPolicy * GetWarpPolicy()

 Get warp policy Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual IDisplayClusterWarpPolicy * GetWarpPolicy_RenderThread()

 Get warp policy on rendering thread Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual void HandleEndScene ( IDisplayClusterViewport* InViewport
)

 Called when current level is going to be closed (i.e. before loading a new map) Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual bool HandleStartScene ( IDisplayClusterViewport* InViewport
)

 Called each time a new game level starts Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual bool HasPreviewEditableMesh ( IDisplayClusterViewport* InViewport
)

 Ask projection policy instance if it has any Editable mesh based preview Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual bool HasPreviewMesh ( IDisplayClusterViewport* InViewport
)

 Ask projection policy instance if it has any mesh based preview Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual bool HasPreviewMesh ()

 Ask projection policy instance if it has any mesh based preview Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual bool IsCameraProjectionVisible ( const FRotator& InViewRotation,
const FVector& InViewLocation,
const FMatrix& InProjectionMatrix
)

 Return true, if camera projection visible for this viewport geometry ICVFX Performance : if camera frame not visible on this node, disable render for this camera Render/Projection/IDisplayClusterProjectionPolicy.h  

bool IsConfigurationChanged ( const FDisplayClusterConfigurationProjection* InConfigurationProjectionPolicy
) const

 Check projection policy settings changes Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual bool IsFrustumRotatedToFitContextSize ( IDisplayClusterViewport* InViewport,
const uint32 InContextNum
)

 Returns true if the frustum has been rotated to fit the context size. Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual bool IsWarpBlendSupported ( const IDisplayClusterViewport* InViewport
) const

 Returns if a policy provides warp&blend feature Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual bool IsWarpBlendSupported ()

 Returns if a policy provides warp&blend feature Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual bool IsWarpBlendSupported_RenderThread ( const IDisplayClusterViewportProxy* InViewportProxy
) const

 Returns if a policy provides warp&blend feature ( Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual void PostUpdateBaseConfiguration ( IDisplayClusterViewport* InViewport
) const

 Called after the base configuration is completed, but before the ICVFX Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual bool ResolveInternalRenderTargetResource_RenderThread ( FRHICommandListImmediate& RHICmdList,
const IDisplayClusterViewportProxy* InViewportProxy,
const IDisplayClusterViewportProxy* InSourceViewportProxy
)

 Override copying 'InternalRenderTargetResource' to 'InputShaderResource'. Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual void SetupProjectionViewPoint ( IDisplayClusterViewport* InViewport,
const float InDeltaTime,
FMinimalViewInfo& InOutViewInfo,
float* OutCustomNearClippingPlane
)

 Override view from this projection policy Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual void SetWarpPolicy ( IDisplayClusterWarpPolicy* InWarpPolicy
)

 Set warp policy for this projection Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual bool ShouldSupportICVFX ( const IDisplayClusterViewport* InViewport
) const

 Returns true if this policy supports ICVFX rendering Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual bool ShouldSupportICVFX ()

 This policy can support ICVFX rendering Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual bool ShouldUseAdditionalTargetableResource ( const IDisplayClusterViewport* InViewport
) const

 Handle request for additional render targetable resource inside viewport api for projection policy. Render/Projection/IDisplayClusterProjectionPolicy.h  
Handle request for additional render targetable resource inside viewport api for projection policy Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual bool ShouldUseAnySizeScaleForRenderTarget ( const IDisplayClusterViewport* InViewport
) const

 This function controls the RTT size multipliers - if false is returned, all modifiers should be ignored. Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual bool ShouldUseSourceTextureWithMips ( const IDisplayClusterViewport* InViewport
) const

 Returns true if the policy supports input mip-textures. Render/Projection/IDisplayClusterProjectionPolicy.h  
Returns true if the policy supports input mip-textures. Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual bool ShouldUseViewPointComponentPostProcesses ( IDisplayClusterViewport* InViewport
) const

 Returns true if this projection policy should use post-processes from the ViewPoint component. Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual void UpdatePostProcessSettings ( IDisplayClusterViewport* InViewport
)

 Projection policy can override PP Render/Projection/IDisplayClusterProjectionPolicy.h  

virtual void UpdateProxyData ( IDisplayClusterViewport* InViewport
)

 Send projection policy game thread data to render thread proxy called once per frame from FDisplayClusterViewportManager::FinalizeNewFrame Render/Projection/IDisplayClusterProjectionPolicy.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page