1. Epic GamesDeveloper
  3. UDisplayClusterPreviewComponent

UDisplayClusterPreviewComponent

NDisplay Viewport preview component (Editor)

API > API/Plugins > API/Plugins/DisplayCluster > API/Plugins/DisplayCluster/Components

Inheritance Hierarchy

References

   
Module DisplayCluster
Header /Engine/Plugins/Runtime/nDisplay/Source/DisplayCluster/Public/Components/DisplayClusterPreviewComponent.h
Include #include "Components/DisplayClusterPreviewComponent.h"

Syntax

UCLASS&40;ClassGroup&61;&40;DisplayCluster&41;&41;  
class UDisplayClusterPreviewComponent : public UActorComponent

Remarks

NDisplay Viewport preview component (Editor)

Variables

  Type Name Description
Protected variable UProperty Category, Meta BlueprintReadOnly Transient visibleanywhere TObjectPtr< UTextureRenderTarget2D > RenderTarget Texture for preview material.
Protected variable UProperty Category BlueprintReadOnly Transient visibleanywhere TObjectPtr< UTextureRenderTarget2D > RenderTargetPostProcess Texture when DCRA has post process disabled but is requesting a post process render target.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const const FString &  
Protected function Const IDisplayClusterViewport *  
Public function Const UTexture *  
Public function UMeshComponent *  
Protected function Const bool

GetPreviewTextureSettings ( FIntPoint& OutSize,
EPixelFormat& OutTextureFormat,
float& OutGamma,
bool& bOutSRGB
)

  
Public function Const UTextureRenderTarget2D *  
Public function Const UTextureRenderTarget2D *  
Public function Const UDisplayClusterConfigurationViewport *  
Public function Const const FString &  
Public function UTexture * Create and retrieve a render texture 2d from the render target.
Public function bool

InitializePreviewComponent ( ADisplayClusterRootActor* RootActor,
const FString& ClusterNodeId,
const FString& ViewportId,
UDisplayClusterConfigurationViewport* ViewportConfig
)

  
Protected function void  
Protected function Const bool Gets whether the preview render or override texture should be output to the screen meshes
Protected function Const bool Gets whether the root actor is requesting a preview render
Protected function void  
Protected function void  
Protected function void  
Public function void

ResetPreviewComponent ( bool bInRestoreSceneMaterial
)

  
Protected function void  
Public function void

SetOverrideTexture ( UTexture* InOverrideTexture
)

 Sets an override texture to display on the viewport instead of the render target
Protected function void  
Protected function void  
Protected function bool  
Protected function void  
Protected function void  
Public function void  

Overridden from UActorComponent

  Type Name Description
Public function Virtual void

DestroyComponent ( bool bPromoteChildren
)

 Unregister the component, remove it from its outer Actor's Components array and mark for pending kill.
Public function Virtual void Called when a component is created (not loaded). This can happen in the editor or during gameplay

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page