1. Epic GamesDeveloper
  3. IDisplayClusterViewport

IDisplayClusterViewport

NDisplay: Viewport (interface for GameThread)

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

References

   
Module DisplayCluster
Header /Engine/Plugins/Runtime/nDisplay/Source/DisplayCluster/Public/Render/Viewport/IDisplayClusterViewport.h
Include #include "Render/Viewport/IDisplayClusterViewport.h"

Syntax

class IDisplayClusterViewport

Remarks

NDisplay: Viewport (interface for GameThread)

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

CalculateProjectionMatrix ( const uint32 InContextNum,
float Left,
float Right,
float Top,
float Bottom,
float ZNear,
float ZFar,
bool bIsAnglesInput
)

 Calculate projection matrices for viewport context (also created overscan matrices, etc)
Public function Virtual bool

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

 Calculate viewport projection (This function has been deprecated.)
Public function bool

CalculateView ( const uint32 InContextNum,
FVector& InOutViewLocation,
FRotator& InOutViewRotation,
const float WorldToMeters
)

 Calculate viewport projection
Public function Static bool

GetCameraComponentView ( UCameraComponent* InCameraComponent,
const float InDeltaTime,
const bool bUseCameraPostprocess,
FMinimalViewInfo& InOutViewInfo,
float* OutCustomNearClippingPlane
)

 Get View from CameraComponent
Public function Const FVector2D Get clipping planes used by this viewport
Public function Const FString  
Public function IDisplayClusterViewportConfiguration & Get viewport manager configuration interface.
Public function Const const IDisplayClusterViewportConfiguration & [const] Get viewport manager configuration interface.
Public function Const const TArray< FDisplayClusterViewport_Context > & Get viewport contexts
Public function Virtual Const UWorld * Return current world.
Public function Const UDisplayClusterDisplayDeviceBaseComponent * Return a DisplayDevice component for this viewport.
Public function Const FString

GetId ()

  
Public function Const bool Returns OCIO configuration if any set
Public function Virtual Const IDisplayClusterViewportManager &  
Public function Static bool

GetPlayerCameraView ( UWorld* InWorld,
const bool bUseCameraPostprocess,
FMinimalViewInfo& InOutViewInfo
)

 Get View from current player camera
Public function Const const FDisplayClusterViewport_PostRenderSettings & Get post-render settings.
Public function bool

GetProjectionMatrix ( const uint32 InContextNum,
FMatrix& OutPrjMatrix
)

 Get projection matrix for viewport context
Public function Const const TSharedPtr< class IDisplayClusterProjectionPolicy, ESPMode::ThreadSafe > & Get projection policy ref.
Public function Virtual Const EDisplayClusterRenderFrameMode Return current render mode.
Public function Const const FDisplayClusterViewport_RenderSettings & Get main viewport render settings.
Public function Const const FDisplayClusterViewport_RenderSettingsICVFX & Get ICVFX render settings.
Public function Virtual Const ADisplayClusterRootActor * Gets a reference to the DCRA with actual configuration inside.
Public function float

GetStereoEyeOffsetDistance ( const uint32 InContextNum
)

 Get the distance from the eye to the viewpoint location.
Public function Const UDisplayClusterCameraComponent * Return view point camera component for this viewport.
Public function Virtual Const UDisplayClusterCameraComponent * Return view point camera component for this viewport.
Public function bool

GetViewPointCameraEye ( const uint32 InContextNum,
FVector& OutViewLocation,
FRotator& OutViewRotation,
FVector& OutViewOffset
)

 Retrieves the view position from the ViewPoint component used by this viewport.
Public function IDisplayClusterViewport_CustomPostProcessSettings & Get custom postprocess settings for this viewport.
Public function Const const IDisplayClusterViewport_CustomPostProcessSettings & [const] Get custom postprocess settings for this viewport.
Public function Virtual Const IDisplayClusterViewportManager * Return the viewport manager that owns this viewport
Public function Const IDisplayClusterViewportPreview & Get viewport preview API
Public function Virtual Const bool

IsCurrentWorldHasAnyType ( const EWorldType::Type InWorldType1,
const EWorldType::Type InWorldType2,
const EWorldType::Type InWorldType3
)

 Returns true if the current world type is equal to one of the input types.
Public function Virtual Const bool Returns true if the scene is open now (The current world is assigned and DCRA has already initialized for it).
Public function Static FMatrix

MakeProjectionMatrix ( float InLeft,
float InRight,
float InTop,
float InBottom,
float ZNear,
float ZFar
)

 Make asymmetrical projection matrix for nDisplay.
Public function void Change viewport contexts data. This function must be called in a valid moment in time.
Public function void Change render setting for viewport. This function must be called in a valid moment in time.
Public function Const void

SetupSceneView ( uint32 ContextNum,
UWorld* World,
FSceneViewFamily& InViewFamily,
FSceneView& InView
)

 Setup scene view for rendering specified Context.
Public function Virtual bool

SetupViewPoint ( FMinimalViewInfo& InOutViewInfo
)

 Setup viewpoint for this viewport
Public function bool

SetupViewPoint ( const uint32 InContextNum,
FMinimalViewInfo& InOutViewInfo
)

 Setup viewpoint for this viewport
Public function TSharedPtr< IDisplayClusterViewport, ESPMode::ThreadSafe > Get TSharedPtr from self.
Public function Const TSharedPtr< const IDisplayClusterViewport, ESPMode::ThreadSafe >  
Public function TSharedRef< class FDisplayClusterViewport, ESPMode::ThreadSafe > Internal functions. Get TSharedRef from Self.
Public function Const TSharedRef< const class FDisplayClusterViewport, ESPMode::ThreadSafe >  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page