UE::Tick::FSyncPointId Struct Reference

#include <TaskSyncManager.h>

Public Types
typedef int32	FInternalId

Public Member Functions
	FSyncPointId ()
	FSyncPointId (FInternalId InSyncId, FBatchContextId InBatchContext)
bool	IsValid () const
FBatchContextId	GetBatchContext () const
bool	operator== (const FSyncPointId &Other) const
bool	operator!= (const FSyncPointId &Other) const

Public Attributes
FInternalId	SyncId
FBatchContextId	BatchContext

Static Public Attributes
static constexpr FInternalId	InvalidSyncPoint = -1

Friends
uint32	GetTypeHash (const FSyncPointId &SyncPoint)

Detailed Description

Identifies a specific registered sync point and batch, this can be safely passed around threads

Member Typedef Documentation

FInternalId

typedef int32 UE::Tick::FSyncPointId::FInternalId

Constructor & Destructor Documentation

FSyncPointId() [1/2]

UE::Tick::FSyncPointId::FSyncPointId ( )

inline

Construct an invalid context

FSyncPointId() [2/2]

UE::Tick::FSyncPointId::FSyncPointId ( FInternalId  InSyncId, FBatchContextId  InBatchContext  )

inlineexplicit

Construct from explicit ids TODO: May make private

Member Function Documentation

GetBatchContext()

FBatchContextId UE::Tick::FSyncPointId::GetBatchContext ( ) const

inline

Returns the batch context this was initialized with

IsValid()

bool UE::Tick::FSyncPointId::IsValid ( ) const

inline

Returns true if this has been initialized to a registered sync point

operator!=()

bool UE::Tick::FSyncPointId::operator!= ( const FSyncPointId &  Other ) const

inline

operator==()

bool UE::Tick::FSyncPointId::operator== ( const FSyncPointId &  Other ) const

inline

Friends And Related Symbol Documentation

GetTypeHash

uint32 GetTypeHash ( const FSyncPointId &  SyncPoint )

friend

Member Data Documentation

BatchContext

FBatchContextId UE::Tick::FSyncPointId::BatchContext

InvalidSyncPoint

constexpr FInternalId UE::Tick::FSyncPointId::InvalidSyncPoint = -1

staticconstexpr

SyncId

FInternalId UE::Tick::FSyncPointId::SyncId

---

The documentation for this struct was generated from the following file:

• Engine/Source/Runtime/Engine/Public/TaskSyncManager.h