Navigation
API > API/Plugins > API/Plugins/DisplayClusterConfiguration
| Name | UDisplayClusterConfigurationViewport |
| Type | class |
| Header File | /Engine/Plugins/Runtime/nDisplay/Source/DisplayClusterConfiguration/Public/DisplayClusterConfigurationTypes_Viewport.h |
| Include Path | #include "DisplayClusterConfigurationTypes_Viewport.h" |
Syntax
UCLASS (Blueprintable)
class UDisplayClusterConfigurationViewport : public UDisplayClusterConfigurationData_Base
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UDisplayClusterConfigurationData_Base → UDisplayClusterConfigurationViewport
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UDisplayClusterConfigurationViewport() |
DisplayClusterConfigurationTypes_Viewport.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnPostEditChangeChainProperty | TMulticastDelegate_OneParam< void, const FPropertyChangedChainEvent & > | DisplayClusterConfigurationTypes_Viewport.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| ViewportMaximumSize | const float | DisplayClusterConfigurationTypes_Viewport.h | |
| ViewportMinimumSize | const float | DisplayClusterConfigurationTypes_Viewport.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bAllowPreviewFrustumRendering | bool | DisplayClusterConfigurationTypes_Viewport.h |
|
|
| bAllowRendering | bool | Enables or disables rendering of this specific Viewport | DisplayClusterConfigurationTypes_Viewport.h |
|
| bFixedAspectRatio | bool | Locks the Viewport aspect ratio for easier resizing | DisplayClusterConfigurationTypes_Viewport.h |
|
| bIsUnlocked | bool | DisplayClusterConfigurationTypes_Viewport.h |
|
|
| bIsVisible | bool | DisplayClusterConfigurationTypes_Viewport.h |
|
|
| Camera | FString | Reference to the nDisplay View Point | DisplayClusterConfigurationTypes_Viewport.h |
|
| DisplayDeviceName | FString | Select a display device to use during preview. An empty string will use the default display device | DisplayClusterConfigurationTypes_Viewport.h |
|
| GPUIndex | int | Specifies the GPU index for the nDisplay viewport. | DisplayClusterConfigurationTypes_Viewport.h |
|
| ICVFX | FDisplayClusterConfigurationViewport_ICVFX | Configure ICVFX for this viewport. | DisplayClusterConfigurationTypes_Viewport.h |
|
| OnPostEditChangeChainProperty | FOnPostEditChangeChainProperty | DisplayClusterConfigurationTypes_Viewport.h | ||
| OverlapOrder | int | Allows Viewports to overlap and sets Viewport overlapping order priority | DisplayClusterConfigurationTypes_Viewport.h |
|
| ProjectionPolicy | FDisplayClusterConfigurationProjection | Specify your Projection Policy Settings | DisplayClusterConfigurationTypes_Viewport.h |
|
| Region | FDisplayClusterConfigurationRectangle | Define the Viewport 2D coordinates | DisplayClusterConfigurationTypes_Viewport.h |
|
| RenderSettings | FDisplayClusterConfigurationViewport_RenderSettings | Configure render for this viewport. | DisplayClusterConfigurationTypes_Viewport.h |
|
| ViewportRemap | FDisplayClusterConfigurationViewport_Remap | Define the Viewport Remap settings | DisplayClusterConfigurationTypes_Viewport.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bAllowPreviewTexture | bool | If this viewport is allowed to render a preview texture. | DisplayClusterConfigurationTypes_Viewport.h | |
| bIsManagingPreviewTexture | bool | If this object is managing the preview texture state. | DisplayClusterConfigurationTypes_Viewport.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool DisablePreviewTexture() |
Signal that the preview texture should be disabled. | DisplayClusterConfigurationTypes_Viewport.h | |
void EnablePreviewTexture() |
Enable the preview texture. Only should be called by the object managing the preview texture state. | DisplayClusterConfigurationTypes_Viewport.h | |
void GetReferencedMeshNames
(
TArray< FString >& OutMeshNames |
DisplayClusterConfigurationTypes_Viewport.h | ||
EDisplayClusterShaderParametersICVFX_ChromakeySource GetViewportChromakeyType
(
const FDisplayClusterConfigurationICVFX_StageSettings& InStageSettings, |
Returns the chromakey type for this viewport used by the specified ICVFX camera. | DisplayClusterConfigurationTypes_Viewport.h | |
EDisplayClusterViewportICVFXFlags GetViewportICVFXFlags
(
const FDisplayClusterConfigurationICVFX_StageSettings& InStageSettings |
Get ICVFX settings flags for viewport | DisplayClusterConfigurationTypes_Viewport.h | |
bool IsPreviewTextureAllowed() |
If this viewport is allowed to render a preview texture. Used with resizing viewports. | DisplayClusterConfigurationTypes_Viewport.h | |
bool IsViewportEnabled() |
The viewport object will only be created or updated if this function returns true. | DisplayClusterConfigurationTypes_Viewport.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeChainProperty
(
FPropertyChangedChainEvent& PropertyChangedEvent |
DisplayClusterConfigurationTypes_Viewport.h | ||
virtual void PostLoad() |
DisplayClusterConfigurationTypes_Viewport.h | ||
virtual void PreEditChange
(
FEditPropertyChain& PropertyAboutToChange |
DisplayClusterConfigurationTypes_Viewport.h |
Protected
Overridden from UDisplayClusterConfigurationData_Base
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnPreCompile
(
FCompilerResultsLog& MessageLog |
Called by nDisplay compiler prior to compilation. | DisplayClusterConfigurationTypes_Viewport.h |