Navigation
API > API/Plugins > API/Plugins/DisplayCluster
NDisplay: Viewport (interface for GameThread)
| Name | IDisplayClusterViewport |
| Type | class |
| Header File | /Engine/Plugins/Runtime/nDisplay/Source/DisplayCluster/Public/Render/Viewport/IDisplayClusterViewport.h |
| Include Path | #include "Render/Viewport/IDisplayClusterViewport.h" |
Syntax
class IDisplayClusterViewport
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IDisplayClusterViewport() |
Render/Viewport/IDisplayClusterViewport.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CalculateProjectionMatrix
(
const uint32 InContextNum, |
Calculate projection matrices for viewport context (also created overscan matrices, etc) | Render/Viewport/IDisplayClusterViewport.h | |
bool CalculateView
(
const uint32 InContextNum, |
Calculate viewport projection | Render/Viewport/IDisplayClusterViewport.h | |
virtual bool CalculateView
(
const uint32 InContextNum, |
Calculate viewport projection (This function has been deprecated.) | Render/Viewport/IDisplayClusterViewport.h | |
bool CalculateViewData
(
const uint32 InContextNum, |
Calculate View data Updates data within the FDisplayClusterViewport_Context. | Render/Viewport/IDisplayClusterViewport.h | |
FVector2D GetClippingPlanes() |
Get clipping planes used by this viewport | Render/Viewport/IDisplayClusterViewport.h | |
FString GetClusterNodeId() |
Render/Viewport/IDisplayClusterViewport.h | ||
| [const] Get viewport manager configuration interface. | Render/Viewport/IDisplayClusterViewport.h | ||
| Get viewport manager configuration interface. | Render/Viewport/IDisplayClusterViewport.h | ||
| Get viewport manager configuration interface reference. | Render/Viewport/IDisplayClusterViewport.h | ||
const TSharedRef< const IDisplayClusterViewportConfiguration, ESPMode::ThreadSafe > GetConfigurationRef () |
[const] Get viewport manager configuration interface reference. | Render/Viewport/IDisplayClusterViewport.h | |
const TArray< FDisplayClusterViewport_Context > & GetContexts() |
Get viewport contexts | Render/Viewport/IDisplayClusterViewport.h | |
virtual UWorld * GetCurrentWorld() |
Return current world. | Render/Viewport/IDisplayClusterViewport.h | |
UDisplayClusterDisplayDeviceBaseComponent * GetDisplayDeviceComponent
(
const EDisplayClusterRootActorType InRootActorType |
Return a DisplayDevice component for this viewport. | Render/Viewport/IDisplayClusterViewport.h | |
FString GetId() |
Render/Viewport/IDisplayClusterViewport.h | ||
bool GetOCIOConversionSettings
(
FOpenColorIOColorConversionSettings& OutOCIOConversionSettings |
Returns OCIO configuration if any set | Render/Viewport/IDisplayClusterViewport.h | |
virtual IDisplayClusterViewportManager & GetOwner() |
Render/Viewport/IDisplayClusterViewport.h | ||
const FDisplayClusterViewport_PostRenderSettings & GetPostRenderSettings() |
Get post-render settings. | Render/Viewport/IDisplayClusterViewport.h | |
bool GetProjectionMatrix
(
const uint32 InContextNum, |
Get projection matrix for viewport context | Render/Viewport/IDisplayClusterViewport.h | |
const TSharedPtr< class IDisplayClusterProjectionPolicy, ESPMode::ThreadSafe > & GetProjectionPolicy() |
Get projection policy ref. | Render/Viewport/IDisplayClusterViewport.h | |
virtual EDisplayClusterRenderFrameMode GetRenderMode() |
Return current render mode. | Render/Viewport/IDisplayClusterViewport.h | |
const FDisplayClusterViewport_RenderSettings & GetRenderSettings() |
Get main viewport render settings. | Render/Viewport/IDisplayClusterViewport.h | |
const FDisplayClusterViewport_RenderSettingsICVFX & GetRenderSettingsICVFX() |
Get ICVFX render settings. | Render/Viewport/IDisplayClusterViewport.h | |
virtual ADisplayClusterRootActor * GetRootActor() |
Gets a reference to the DCRA with actual configuration inside. | Render/Viewport/IDisplayClusterViewport.h | |
float GetStereoEyeOffsetDistance
(
const uint32 InContextNum |
Get the distance from the eye to the viewpoint location. | Render/Viewport/IDisplayClusterViewport.h | |
UDisplayClusterCameraComponent * GetViewPointCameraComponent
(
const EDisplayClusterRootActorType InRootActorType |
Return view point camera component for this viewport. | Render/Viewport/IDisplayClusterViewport.h | |
| Return view point camera component for this viewport. | Render/Viewport/IDisplayClusterViewport.h | ||
bool GetViewPointCameraEye
(
const uint32 InContextNum, |
Retrieves the view position from the ViewPoint component used by this viewport. | Render/Viewport/IDisplayClusterViewport.h | |
| Get custom postprocess settings for this viewport. | Render/Viewport/IDisplayClusterViewport.h | ||
| [const] Get custom postprocess settings for this viewport. | Render/Viewport/IDisplayClusterViewport.h | ||
virtual IDisplayClusterViewportManager * GetViewportManager() |
Return the viewport manager that owns this viewport | Render/Viewport/IDisplayClusterViewport.h | |
IDisplayClusterViewportPreview & GetViewportPreview() |
Get viewport preview API | Render/Viewport/IDisplayClusterViewport.h | |
virtual bool IsCurrentWorldHasAnyType
(
const EWorldType::Type InWorldType1, |
Returns true if the current world type is equal to one of the input types. | Render/Viewport/IDisplayClusterViewport.h | |
virtual bool IsSceneOpened() |
Returns true if the scene is open now (The current world is assigned and DCRA has already initialized for it). | Render/Viewport/IDisplayClusterViewport.h | |
void SetContexts
(
TArray< FDisplayClusterViewport_Context >& InContexts |
Change viewport contexts data. This function must be called in a valid moment in time. | Render/Viewport/IDisplayClusterViewport.h | |
void SetRenderSettings
(
const FDisplayClusterViewport_RenderSettings& InRenderSettings |
Change render setting for viewport. This function must be called in a valid moment in time. | Render/Viewport/IDisplayClusterViewport.h | |
void SetupSceneView
(
uint32 ContextNum, |
Setup scene view for rendering specified Context. | Render/Viewport/IDisplayClusterViewport.h | |
virtual bool SetupViewPoint
(
FMinimalViewInfo& InOutViewInfo |
Setup viewpoint for this viewport | Render/Viewport/IDisplayClusterViewport.h | |
bool SetupViewPoint
(
const uint32 InContextNum, |
Setup viewpoint for this viewport | Render/Viewport/IDisplayClusterViewport.h | |
| Get TSharedPtr from self. | Render/Viewport/IDisplayClusterViewport.h | ||
TSharedPtr< const IDisplayClusterViewport, ESPMode::ThreadSafe > ToSharedPtr () |
Render/Viewport/IDisplayClusterViewport.h | ||
TSharedRef< class FDisplayClusterViewport, ESPMode::ThreadSafe > ToSharedRef () |
Internal functions. Get TSharedRef from Self. | Render/Viewport/IDisplayClusterViewport.h | |
TSharedRef< const class FDisplayClusterViewport, ESPMode::ThreadSafe > ToSharedRef () |
Render/Viewport/IDisplayClusterViewport.h | ||
bool UseSameOCIO
(
const IDisplayClusterViewport* InViewport |
Returns true if both viewports use the same OCIO. | Render/Viewport/IDisplayClusterViewport.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool GetCameraComponentView
(
UCameraComponent* InCameraComponent, |
Get View from CameraComponent | Render/Viewport/IDisplayClusterViewport.h | |
static bool GetPlayerCameraView
(
UWorld* InWorld, |
Get View from current player camera | Render/Viewport/IDisplayClusterViewport.h | |
static FMatrix MakeProjectionMatrix
(
float InLeft, |
Make asymmetrical projection matrix for nDisplay. | Render/Viewport/IDisplayClusterViewport.h |