Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > DisplayCluster > Components > UDisplayClusterPreviewComponent

Light Theme

Dark Theme

UDisplayClusterPreviewComponent

NDisplay Viewport preview component (Editor)

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

UDisplayClusterPreviewComponent

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(ClassGroup=(DisplayCluster))
class UDisplayClusterPreviewComponent : public UActorComponent

Remarks

NDisplay Viewport preview component (Editor)

Variables

	Name	Description
bool	bIsEditingProperty
UTextureRenderT...	RenderTarget
int32	RenderTargetSurfaceChangedCnt	Set to true, when RTT surface updated.

Constructors

	Name	Description
	UDisplayClusterPreviewComponent ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
IDisplayClus...	GetCurrentViewport()
UTexture2D &...	GetOrCreateRenderTexture2D()	Create and retrieve a render texture 2d from the render target.
UMeshCompone...	GetPreviewMesh()
bool	GetPreviewTextureSettings ( FIntPoint& OutSize, float& OutGamma )
UTextureRend...	GetRenderTargetTexture()
UDisplayClus...	GetViewportConfig()
const FStrin...	GetViewportId()
void	HandleRenderTargetTextureDeferredUpdate()
void	InitializeInternals()
bool	InitializePreviewComponent ( ADisplayClusterRootActor* Root..., const FString& ViewportId, UDisplayClusterConfigurationViewpor... )
bool	IsPreviewAvailable()
void	RemovePreviewTexture()
bool	UpdatePreviewMesh()
void	UpdatePreviewRenderTarget()
void	UpdatePreviewResources()
bool	UpdatePreviewTexture()

Overridden from UActorComponent

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

Constants

Name	Description
MaxRenderTargetDimension	The maximum dimension that the preview render target can be, which helps ensure good performance even if viewports are very large.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss