UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Member Functions | List of all members
FTaskThreadAnyThread Class Reference
+ Inheritance diagram for FTaskThreadAnyThread:

Public Member Functions

 FTaskThreadAnyThread (int32 InPriorityIndex)
 
virtual void ProcessTasksUntilQuit (int32 QueueIndex) override
 
virtual uint64 ProcessTasksUntilIdle (int32 QueueIndex) override
 
virtual void RequestQuit (int32 QueueIndex) override
 
virtual void WakeUp (int32 QueueIndex=0) final override
 
void StallForTuning (bool Stall)
 
virtual bool IsProcessingTasks (int32 QueueIndex) override
 
- Public Member Functions inherited from FTaskThreadBase
 FTaskThreadBase ()
 
void Setup (ENamedThreads::Type InThreadId, uint32 InPerThreadIDTLSSlot, FWorkerThread *InOwnerWorker)
 
void InitializeForCurrentThread ()
 
ENamedThreads::Type GetThreadId () const
 
virtual void EnqueueFromThisThread (int32 QueueIndex, FBaseGraphTask *Task)
 
virtual bool EnqueueFromOtherThread (int32 QueueIndex, FBaseGraphTask *Task)
 
virtual void Tick () override
 
virtual bool Init () override
 
virtual uint32 Run () override
 
virtual void Stop () override
 
virtual void Exit () override
 
virtual FSingleThreadRunnable * GetSingleThreadInterface () override
 
- Public Member Functions inherited from FRunnable
virtual ~FRunnable ()
 

Additional Inherited Members

- Protected Attributes inherited from FTaskThreadBase
ENamedThreads::Type ThreadId
 
uint32 PerThreadIDTLSSlot
 
FThreadSafeCounter IsStalled
 
TArray< FBaseGraphTask * > NewTasks
 
FWorkerThread * OwnerWorker
 

Detailed Description

FTaskThreadAnyThread A class for managing a worker threads.

Constructor & Destructor Documentation

◆ FTaskThreadAnyThread()

FTaskThreadAnyThread::FTaskThreadAnyThread ( int32  InPriorityIndex)
inline

Member Function Documentation

◆ IsProcessingTasks()

virtual bool FTaskThreadAnyThread::IsProcessingTasks ( int32  QueueIndex)
inlineoverridevirtual

Return true if this thread is processing tasks. This is only a "guess" if you ask for a thread other than yourself because that can change before the function returns.

Parameters
QueueIndex,Queueto request quit from

Implements FTaskThreadBase.

◆ ProcessTasksUntilIdle()

virtual uint64 FTaskThreadAnyThread::ProcessTasksUntilIdle ( int32  QueueIndex)
inlineoverridevirtual

Used for named threads to start processing tasks until the thread is idle and RequestQuit has been called.

Reimplemented from FTaskThreadBase.

◆ ProcessTasksUntilQuit()

virtual void FTaskThreadAnyThread::ProcessTasksUntilQuit ( int32  QueueIndex)
inlineoverridevirtual

Used for named threads to start processing tasks until the thread is idle and RequestQuit has been called.

Implements FTaskThreadBase.

◆ RequestQuit()

virtual void FTaskThreadAnyThread::RequestQuit ( int32  QueueIndex)
inlineoverridevirtual

Will cause the thread to return to the caller when it becomes idle. Used to return from ProcessTasksUntilQuit for named threads or to shut down unnamed threads. CAUTION: This will not work under arbitrary circumstances. For example you should not attempt to stop unnamed threads unless they are known to be idle. Return requests for named threads should be submitted from that named thread as FReturnGraphTask does.

Parameters
QueueIndex,Queueto request quit from

Implements FTaskThreadBase.

◆ StallForTuning()

void FTaskThreadAnyThread::StallForTuning ( bool  Stall)
inline

◆ WakeUp()

virtual void FTaskThreadAnyThread::WakeUp ( int32  QueueIndex = 0)
inlinefinaloverridevirtual

Implements FTaskThreadBase.

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