UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::Tick::FBatchContextId Struct Referencefinal

#include <TaskSyncManager.h>

Public Types

typedef int32 FInternalId
 

Public Member Functions

 FBatchContextId ()
 
 FBatchContextId (FInternalId InBatchId)
 
bool IsValid () const
 
bool operator== (const FBatchContextId &Other) const
 
bool operator!= (const FBatchContextId &Other) const
 

Public Attributes

FInternalId BatchId
 

Static Public Attributes

static constexpr FInternalId InvalidBatch = -1
 

Friends

uint32 GetTypeHash (const FBatchContextId &Context)
 

Detailed Description

Identifies a specific batch of tasks, which will be associated with a set of objects in a world context

Member Typedef Documentation

◆ FInternalId

Constructor & Destructor Documentation

◆ FBatchContextId() [1/2]

UE::Tick::FBatchContextId::FBatchContextId ( )
inline

Construct an invalid batch

◆ FBatchContextId() [2/2]

UE::Tick::FBatchContextId::FBatchContextId ( FInternalId  InBatchId)
inlineexplicit

Construct from an internal id TODO: May make private

Member Function Documentation

◆ IsValid()

bool UE::Tick::FBatchContextId::IsValid ( ) const
inline

Returns true if this has been initialized to a valid batch

◆ operator!=()

bool UE::Tick::FBatchContextId::operator!= ( const FBatchContextId Other) const
inline

◆ operator==()

bool UE::Tick::FBatchContextId::operator== ( const FBatchContextId Other) const
inline

Friends And Related Symbol Documentation

◆ GetTypeHash

uint32 GetTypeHash ( const FBatchContextId Context)
friend

Member Data Documentation

◆ BatchId

FInternalId UE::Tick::FBatchContextId::BatchId

◆ InvalidBatch

constexpr FInternalId UE::Tick::FBatchContextId::InvalidBatch = -1
staticconstexpr

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