Navigation
API > API/Plugins > API/Plugins/DisplayCluster
Generic barriers client interface
| Name | IDisplayClusterGenericBarriersClient |
| Type | class |
| Header File | /Engine/Plugins/Runtime/nDisplay/Source/DisplayCluster/Public/Cluster/IDisplayClusterGenericBarriersClient.h |
| Include Path | #include "Cluster/IDisplayClusterGenericBarriersClient.h" |
Syntax
class IDisplayClusterGenericBarriersClient
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IDisplayClusterGenericBarriersClient() |
Cluster/IDisplayClusterGenericBarriersClient.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnGenericBarrierSynchronizationDelegate | TBaseDelegate_OneParam< void, FGenericBarrierSynchronizationDelegateData & > | Synchronization delegate. It's called on the primary node only. | Cluster/IDisplayClusterGenericBarriersClient.h |
| FOnGenericBarrierTimeoutDelegate | TBaseDelegate_OneParam< void, const TSet< FString > & > | Barrier timeout delegate. It's called on the primary node only. | Cluster/IDisplayClusterGenericBarriersClient.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool Connect() |
Cluster/IDisplayClusterGenericBarriersClient.h | ||
bool CreateBarrier
(
const FString& BarrierId, |
Creates new barrier | Cluster/IDisplayClusterGenericBarriersClient.h | |
virtual bool CreateBarrier
(
const FString& BarrierId, |
Cluster/IDisplayClusterGenericBarriersClient.h | ||
virtual void Disconnect() |
Cluster/IDisplayClusterGenericBarriersClient.h | ||
FOnGenericBarrierSynchronizationDelegate * GetBarrierSyncDelegate
(
const FString& BarrierId |
Returns synchronization delegate of a specific barrier. | Cluster/IDisplayClusterGenericBarriersClient.h | |
FOnGenericBarrierTimeoutDelegate * GetBarrierTimeoutDelegate
(
const FString& BarrierId |
Returns timeout delegate of a specific barrier. This delegate is called on the primary node only. | Cluster/IDisplayClusterGenericBarriersClient.h | |
virtual FString GetName() |
Cluster/IDisplayClusterGenericBarriersClient.h | ||
bool IsBarrierAvailable
(
const FString& BarrierId |
Checks if a specific barrier exists | Cluster/IDisplayClusterGenericBarriersClient.h | |
virtual bool IsConnected() |
Cluster/IDisplayClusterGenericBarriersClient.h | ||
bool ReleaseBarrier
(
const FString& BarrierId |
Releases specific barrier | Cluster/IDisplayClusterGenericBarriersClient.h | |
bool Synchronize
(
const FString& BarrierId, |
Synchronize the calling thread on a specific barrier | Cluster/IDisplayClusterGenericBarriersClient.h | |
bool Synchronize
(
const FString& BarrierId, |
Synchronize the calling thread on a specific barrier with custom data | Cluster/IDisplayClusterGenericBarriersClient.h | |
bool WaitUntilBarrierIsCreated
(
const FString& BarrierId |
Wait until a barrier with specific ID is created and ready to go | Cluster/IDisplayClusterGenericBarriersClient.h |