UDisplayClusterDisplayDeviceBaseComponent | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/DisplayCluster

Display Device Components can be added to nDisplay root actors and assigned to viewport nodes to allow additional processing on the preview material.


Name	UDisplayClusterDisplayDeviceBaseComponent
Type	class
Header File	/Engine/Plugins/Runtime/nDisplay/Source/DisplayCluster/Public/Render/DisplayDevice/Components/DisplayClusterDisplayDeviceBaseComponent.h
Include Path	#include "Render/DisplayDevice/Components/DisplayClusterDisplayDeviceBaseComponent.h"

Syntax

UCLASS (Abstract, ClassGroup=(DisplayCluster),  
       HideCategories=(Transform, Rendering, Tags, Activation, Cooking, Physics, LOD, AssetUserData, Navigation))  
class UDisplayClusterDisplayDeviceBaseComponent : public USceneComponent

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UActorComponent → USceneComponent → UDisplayClusterDisplayDeviceBaseComponent

Implements Interfaces

Derived Classes

UDisplayClusterDisplayDeviceComponent

Constructors

Name	Remarks	Include Path	Unreal Specifiers
UDisplayClusterDisplayDeviceBaseComponent()		Render/DisplayDevice/Components/DisplayClusterDisplayDeviceBaseComponent.h

Functions

Public

Name	Remarks	Include Path
virtual TObjectPtr< UMaterial > GetDisplayDeviceMaterial ( const EDisplayClusterDisplayDeviceMeshType InMeshType, const EDisplayClusterDisplayDeviceMaterialType InMaterialType ) const	Receive material by type	Render/DisplayDevice/Components/DisplayClusterDisplayDeviceBaseComponent.h
virtual TSharedPtr< IDisplayClusterDisplayDeviceProxy, ESPMode::ThreadSafe > GetDisplayDeviceProxy ( IDisplayClusterViewportConfiguration& InConfiguration )	Update and Get proxy object for rendering thread.	Render/DisplayDevice/Components/DisplayClusterDisplayDeviceBaseComponent.h
virtual void OnUpdateDisplayDeviceMeshAndMaterialInstance ( IDisplayClusterViewportPreview& InViewportPreview, const EDisplayClusterDisplayDeviceMeshType InMeshType, const EDisplayClusterDisplayDeviceMaterialType InMaterialType, UMeshComponent* InMeshComponent, UMaterialInstanceDynamic* InMeshMaterialInstance ) const	Perform any operations on the material instance, such as setting parameter values.	Render/DisplayDevice/Components/DisplayClusterDisplayDeviceBaseComponent.h
virtual void SetupSceneView ( const IDisplayClusterViewportPreview& InViewportPreview, uint32 ContextNum, FSceneViewFamily& InOutViewFamily, FSceneView& InOutView ) const	Setup view for this Display Device	Render/DisplayDevice/Components/DisplayClusterDisplayDeviceBaseComponent.h

Overridden from UObject

Name	Remarks	Include Path	Unreal Specifiers
virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent )		Render/DisplayDevice/Components/DisplayClusterDisplayDeviceBaseComponent.h

Protected

Name	Remarks	Include Path	Unreal Specifiers
virtual bool ShouldUseDisplayDevice ( IDisplayClusterViewportConfiguration& InConfiguration ) const	Returns true if the display device should be used for rendering in nDisplay	Render/DisplayDevice/Components/DisplayClusterDisplayDeviceBaseComponent.h
virtual void UpdateDisplayDeviceProxyImpl ( IDisplayClusterViewportConfiguration& InConfiguration )	Updating the proxy object for the current configuration.	Render/DisplayDevice/Components/DisplayClusterDisplayDeviceBaseComponent.h