1. Epic GamesDeveloper
  3. IDisplayClusterViewportManager

IDisplayClusterViewportManager

NDisplay ViewportManager (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/IDisplayClusterViewportManager.h
Include #include "Render/Viewport/IDisplayClusterViewportManager.h"

Syntax

class IDisplayClusterViewportManager

Remarks

NDisplay ViewportManager (interface for GameThread)

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void Add internal DCVM objects to the reference collector.
Public function Virtual bool

BeginNewFrame ( FViewport* InViewport,
UWorld* InWorld,
FDisplayClusterRenderFrame& OutRenderFrame
)

 Initialize new frame for all viewports on game thread, and update context, render resources with viewport new settings And finally build render frame structure and send to render thread proxy viewport objects [Game thread func]
Public function bool

BeginNewFrame ( FViewport* InViewport,
FDisplayClusterRenderFrame& OutRenderFrame
)

 Initialize new frame for all viewports on game thread, and update context, render resources with viewport new settings And finally build render frame structure and send to render thread proxy viewport objects [Game thread func]
Public function FSceneView *

CalcSceneView ( ULocalPlayer* LocalPlayer,
FSceneViewFamily* ViewFamily,
FVector& OutViewLocation,
FRotator& OutViewRotation,
FViewport* Viewport,
FViewElementDrawer* ViewDrawer,
int32 StereoViewIndex
)

 Call LocalPlayer->CalcSceneView() [Game thread func]
Public function void Initialize view family, using rules [Game thread func]
Public function Const FSceneViewFamily::ConstructionValues

CreateViewFamilyConstructionValues ( const FDisplayClusterRenderFrameTarget& InFrameTarget,
FSceneInterface* InScene,
FEngineShowFlags InEngineShowFlags,
const bool bInAdditionalViewFamily
)

 Create constructor values for viewfamily, using rules [Game thread func]
Public function Static TSharedRef< IDisplayClusterViewportManager, ESPMode::ThreadSafe > Static viewport manager instance constructor.
Public function void Finalize frame for render on game thread [Game thread func]
Public function Const IDisplayClusterViewport *

FindViewport ( const int32 StereoViewIndex,
uint32* OutContextNum
)

 Find viewport object and context number by stereoscopic pass index [Game thread func]
Public function Const IDisplayClusterViewport *

FindViewport ( const FString& InViewportId
)

 Find viewport object by name [Game thread func]
Public function IDisplayClusterViewportConfiguration & Get viewport manager configuration interface.
Public function Const const IDisplayClusterViewportConfiguration &  
Public function Const const TArrayView< TSharedPtr< IDisplayClusterViewport, ESPMode::ThreadSafe > > Return all exist viewports objects for current cluster node [Game thread func]
Public function Virtual Const UWorld *  
Public function Const const TArrayView< TSharedPtr< IDisplayClusterViewport, ESPMode::ThreadSafe > > Return entire cluster viewports objects [Game thread func]
Public function Const TArray< TSharedPtr< IDisplayClusterViewport, ESPMode::ThreadSafe > > Returns the viewports from the entire cluster associated with the specified warp policy [Game thread func]
Public function IDisplayClusterViewportManagerProxy *  
Public function Const const IDisplayClusterViewportManagerProxy * Get viewport manager proxy interface.
Public function Virtual Const EDisplayClusterRenderFrameMode Return current render mode.
Public function Virtual Const ADisplayClusterRootActor *  
Public function Const const IDisplayClusterViewportManagerPreview &  
Public function IDisplayClusterViewportManagerPreview & Get viewport manager preview API
Public function Virtual Const const TArrayView< IDisplayClusterViewport * >  
Public function void Initialize frame for render on game thread [Game thread func]
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 void

MarkComponentGeometryDirty ( const FName InComponentName
)

 Mark the geometry of the referenced component(s) as dirty (ProceduralMesh, etc) [Game thread func]
Public function void

RenderFrame ( FViewport* InViewport
)

 Send to render thread.
Public function Virtual bool

RenderInEditor ( FDisplayClusterRenderFrame& InRenderFrame,
FViewport* InViewport,
const uint32 InFirstViewportNum,
const int32 InViewportsAmount,
int32& OutViewportsAmount,
bool& bOutFrameRendered
)

 Render in editor (preview) [Game thread func]
Public function TSharedPtr< IDisplayClusterViewportManager, ESPMode::ThreadSafe > Get TSharedPtr from self.
Public function Const TSharedPtr< const IDisplayClusterViewportManager, ESPMode::ThreadSafe >  
Public function TSharedRef< class FDisplayClusterViewportManager, ESPMode::ThreadSafe > Internal functions. Get TSharedRef from Self.
Public function Const TSharedRef< const class FDisplayClusterViewportManager, ESPMode::ThreadSafe >  
Public function Virtual bool

UpdateConfiguration ( EDisplayClusterRenderFrameMode InRenderMode,
const FString& InClusterNodeId,
ADisplayClusterRootActor* InRootActorPtr,
const FDisplayClusterPreviewSettings* InPreviewSettings
)

 Update\Create\Delete local node viewports Update ICVFX configuration from root actor components [Game thread func]
Public function Virtual bool

UpdateCustomConfiguration ( EDisplayClusterRenderFrameMode InRenderMode,
const TArray< FString >& InViewportNames,
ADisplayClusterRootActor* InRootActorPtr
)

 Update\Create\Delete viewports for frame.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page