UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::GC::TThreadedGather< PayloadType, PayloadOps > Class Template Reference

#include <ReachabilityAnalysisState.h>

Public Types

typedef TGatherIterator< PayloadType > FIterator
 
typedef TArray< FIterator, TInlineAllocator< 32 > > FThreadIterators
 

Public Member Functions

FORCEINLINE FThreadIteratorsGetThreadIterators ()
 
FORCEINLINE bool IsSuspended () const
 
FORCEINLINE bool IsPending () const
 
void Init ()
 
FORCENOINLINE void Start (const EGatherOptions Options, const int32 TotalNumObjects, const int32 FirstIndex=0, const int32 DesiredNumThreads=0)
 
FORCENOINLINE void Finish (PayloadType &OutGatheredObjects)
 
FORCEINLINE int32 NumWorkerThreads () const
 
int32 NumScanned () const
 
int32 NumGathered () const
 

Detailed Description

template<typename PayloadType, typename PayloadOps = TDefaultPayloadOps<PayloadType>>
class UE::GC::TThreadedGather< PayloadType, PayloadOps >

Helper class that holds the current state of Object Gathering phases

Member Typedef Documentation

◆ FIterator

template<typename PayloadType , typename PayloadOps = TDefaultPayloadOps<PayloadType>>
typedef TGatherIterator<PayloadType> UE::GC::TThreadedGather< PayloadType, PayloadOps >::FIterator

◆ FThreadIterators

template<typename PayloadType , typename PayloadOps = TDefaultPayloadOps<PayloadType>>
typedef TArray<FIterator, TInlineAllocator<32> > UE::GC::TThreadedGather< PayloadType, PayloadOps >::FThreadIterators

Member Function Documentation

◆ Finish()

template<typename PayloadType , typename PayloadOps = TDefaultPayloadOps<PayloadType>>
FORCENOINLINE void UE::GC::TThreadedGather< PayloadType, PayloadOps >::Finish ( PayloadType &  OutGatheredObjects)
inline

◆ GetThreadIterators()

template<typename PayloadType , typename PayloadOps = TDefaultPayloadOps<PayloadType>>
FORCEINLINE FThreadIterators & UE::GC::TThreadedGather< PayloadType, PayloadOps >::GetThreadIterators ( )
inline

◆ Init()

template<typename PayloadType , typename PayloadOps = TDefaultPayloadOps<PayloadType>>
void UE::GC::TThreadedGather< PayloadType, PayloadOps >::Init ( )
inline

◆ IsPending()

template<typename PayloadType , typename PayloadOps = TDefaultPayloadOps<PayloadType>>
FORCEINLINE bool UE::GC::TThreadedGather< PayloadType, PayloadOps >::IsPending ( ) const
inline

◆ IsSuspended()

template<typename PayloadType , typename PayloadOps = TDefaultPayloadOps<PayloadType>>
FORCEINLINE bool UE::GC::TThreadedGather< PayloadType, PayloadOps >::IsSuspended ( ) const
inline

◆ NumGathered()

template<typename PayloadType , typename PayloadOps = TDefaultPayloadOps<PayloadType>>
int32 UE::GC::TThreadedGather< PayloadType, PayloadOps >::NumGathered ( ) const
inline

◆ NumScanned()

template<typename PayloadType , typename PayloadOps = TDefaultPayloadOps<PayloadType>>
int32 UE::GC::TThreadedGather< PayloadType, PayloadOps >::NumScanned ( ) const
inline

◆ NumWorkerThreads()

template<typename PayloadType , typename PayloadOps = TDefaultPayloadOps<PayloadType>>
FORCEINLINE int32 UE::GC::TThreadedGather< PayloadType, PayloadOps >::NumWorkerThreads ( ) const
inline

◆ Start()

template<typename PayloadType , typename PayloadOps = TDefaultPayloadOps<PayloadType>>
FORCENOINLINE void UE::GC::TThreadedGather< PayloadType, PayloadOps >::Start ( const EGatherOptions  Options,
const int32  TotalNumObjects,
const int32  FirstIndex = 0,
const int32  DesiredNumThreads = 0 
)
inline

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