Navigation
API > API/Plugins > API/Plugins/DisplayCluster
Type-independent base class for custom states
| Name | FCustomStateBase |
| Type | class |
| Header File | /Engine/Plugins/Runtime/nDisplay/Source/DisplayCluster/Public/Cluster/CustomStates/DisplayClusterCustomStateBase.h |
| Include Path | #include "Cluster/CustomStates/DisplayClusterCustomStateBase.h" |
Syntax
class FCustomStateBase : public IDisplayClusterCustomState
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Cluster/CustomStates/DisplayClusterCustomStateBase.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FCustomStateBase() |
Cluster/CustomStates/DisplayClusterCustomStateBase.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ClusterMgr | IDisplayClusterClusterManager * | DC cluster manager to speed up internal operations | Cluster/CustomStates/DisplayClusterCustomStateBase.h | |
| ClusterNodeId | const FName | Id of this cluster node to speed up internal operations | Cluster/CustomStates/DisplayClusterCustomStateBase.h | |
| StateCS | TSharedRef< FCriticalSection > | Main access guard for this state instance, wrapped in a shared reference to ensure thread-safe sharing. | Cluster/CustomStates/DisplayClusterCustomStateBase.h | |
| UniqueName | const FName | Unique ID of this state | Cluster/CustomStates/DisplayClusterCustomStateBase.h |
Functions
Public
Public Virtual
Overridden from IDisplayClusterCustomState
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FName GetName() |
Returns custom state's unique name | Cluster/CustomStates/DisplayClusterCustomStateBase.h | |
virtual void Lock() |
Lock this state to prevent any changes | Cluster/CustomStates/DisplayClusterCustomStateBase.h | |
virtual void Unlock() |
Enable any changes after Lock() call | Cluster/CustomStates/DisplayClusterCustomStateBase.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ExecuteOnRenderThread
(
TUniqueFunction< void()> FuncRT |
Type-independent private implementation of render task scheduler. | Cluster/CustomStates/DisplayClusterCustomStateBase.h | |
IDisplayClusterClusterManager * GetClusterMgr() |
Quick access for ClusterMgr cached pointer | Cluster/CustomStates/DisplayClusterCustomStateBase.h | |
FCriticalSection & GetCritSec() |
Access to the main access guard of the state instance | Cluster/CustomStates/DisplayClusterCustomStateBase.h | |
TSharedRef< FCriticalSection > GetCritSecRef() |
Access to the main access guard of the state instance | Cluster/CustomStates/DisplayClusterCustomStateBase.h | |
const FName & GetNodeId() |
Quick access for this cluster node ID | Cluster/CustomStates/DisplayClusterCustomStateBase.h |