Navigation
API > API/Plugins > API/Plugins/DisplayCluster
Viewport manager configuration.
| Name | IDisplayClusterViewportConfiguration |
| Type | class |
| Header File | /Engine/Plugins/Runtime/nDisplay/Source/DisplayCluster/Public/Render/Viewport/IDisplayClusterViewportConfiguration.h |
| Include Path | #include "Render/Viewport/IDisplayClusterViewportConfiguration.h" |
Syntax
class IDisplayClusterViewportConfiguration
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IDisplayClusterViewportConfiguration() |
Render/Viewport/IDisplayClusterViewportConfiguration.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const FString & GetClusterNodeId() |
Return current cluster node id. | Render/Viewport/IDisplayClusterViewportConfiguration.h | |
const UDisplayClusterConfigurationData * GetConfigurationData() |
Gets a configuration data from the Configuration RootActor | Render/Viewport/IDisplayClusterViewportConfiguration.h | |
const FDisplayClusterConfigurationRenderFrame * GetConfigurationRenderFrameSettings() |
Gets a configuration render settings from the Configuration RootActor | Render/Viewport/IDisplayClusterViewportConfiguration.h | |
UWorld * GetCurrentWorld() |
Gets a reference to the current world being rendered in DCRA | Render/Viewport/IDisplayClusterViewportConfiguration.h | |
const FDisplayClusterViewport_PreviewSettings & GetPreviewSettings() |
Gets the current preview settings. | Render/Viewport/IDisplayClusterViewportConfiguration.h | |
const IDisplayClusterViewportConfigurationProxy & GetProxy() |
Return the configuration proxy object. | Render/Viewport/IDisplayClusterViewportConfiguration.h | |
EDisplayClusterRenderFrameMode GetRenderModeForPIE() |
Returns the rendering mode for PIE. | Render/Viewport/IDisplayClusterViewportConfiguration.h | |
ADisplayClusterRootActor * GetRootActor
(
const EDisplayClusterRootActorType InRootActorType |
Gets a reference to the DCRA by type. | Render/Viewport/IDisplayClusterViewportConfiguration.h | |
float GetRootActorWorldDeltaSeconds
(
const EDisplayClusterRootActorType InRootActorType |
Return value from the DCRA function GetWorldDeltaSeconds(). | Render/Viewport/IDisplayClusterViewportConfiguration.h | |
const FDisplayClusterConfigurationICVFX_StageSettings * GetStageSettings() |
Gets a configuration stage settings from the Configuration RootActor | Render/Viewport/IDisplayClusterViewportConfiguration.h | |
IDisplayClusterViewportManager * GetViewportManager() |
Return the viewport manager that used by this configuration. | Render/Viewport/IDisplayClusterViewportConfiguration.h | |
const float GetWorldToMeters() |
Return current value for WorldToMeters. | Render/Viewport/IDisplayClusterViewportConfiguration.h | |
bool IsClusterNodeRenderingOffscreen () |
Checks whether the current cluster node is rendering offscreen (headless). | Render/Viewport/IDisplayClusterViewportConfiguration.h | |
bool IsCurrentWorldHasAnyType
(
const EWorldType::Type InWorldType1, |
Returns true if the current world type is equal to one of the input types. | Render/Viewport/IDisplayClusterViewportConfiguration.h | |
bool IsExclusiveLocked () |
Returns true if this DCRA is under an exclusive lock. | Render/Viewport/IDisplayClusterViewportConfiguration.h | |
bool IsMediaAvailable () |
Returns true if media can be used. | Render/Viewport/IDisplayClusterViewportConfiguration.h | |
bool IsPreviewInGameEnabled() |
Returns true if the DCRA preview feature in Standalone/Package builds is used. | Render/Viewport/IDisplayClusterViewportConfiguration.h | |
bool IsPreviewRendering() |
Returns true if preview rendering mode is used. | Render/Viewport/IDisplayClusterViewportConfiguration.h | |
bool IsRootActorWorldHasAnyType
(
const EDisplayClusterRootActorType InRootActorType, |
Returns true if the given DCRA has a world type equal to one of the input types. | Render/Viewport/IDisplayClusterViewportConfiguration.h | |
bool IsSceneOpened() |
Returns true if the scene is open now (The current world is assigned and DCRA has already initialized for it). | Render/Viewport/IDisplayClusterViewportConfiguration.h | |
bool IsTechvisEnabled() |
Returns true, if Techvis is used. | Render/Viewport/IDisplayClusterViewportConfiguration.h | |
void ReleaseConfiguration() |
Release the current configuration and free resources. | Render/Viewport/IDisplayClusterViewportConfiguration.h | |
void SetPreviewSettings
(
const FDisplayClusterViewport_PreviewSettings& InPreviewSettings |
Assign new preview settings for rendering previews. | Render/Viewport/IDisplayClusterViewportConfiguration.h | |
void SetRootActor
(
const EDisplayClusterRootActorType InRootActorType, |
Sets a reference to the DCRA's | Render/Viewport/IDisplayClusterViewportConfiguration.h | |
bool UpdateConfigurationForClusterNode
(
EDisplayClusterRenderFrameMode InRenderMode, |
Update\Create\Delete local node viewports Updating the configuration to render a ClusterNode in the specified mode | Render/Viewport/IDisplayClusterViewportConfiguration.h | |
bool UpdateConfigurationForViewportsList
(
EDisplayClusterRenderFrameMode InRenderMode, |
Update\Create\Delete local node viewports Updating the configuration to render a list of viewports in a given mode | Render/Viewport/IDisplayClusterViewportConfiguration.h |