FQueuedLowLevelThreadPool | Unreal Engine 5.7 Documentation

ThreadPool wrapper implementation allowing to schedule thread-pool tasks on the the low level backend which is also used by the taskgraph.


Name	FQueuedLowLevelThreadPool
Type	class
Header File	/Engine/Source/Runtime/Core/Public/Misc/QueuedThreadPoolWrapper.h
Include Path	#include "Misc/QueuedThreadPoolWrapper.h"

Syntax

class FQueuedLowLevelThreadPool : public FQueuedThreadPool

Name	Remarks	Include Path	Unreal Specifiers
FQueuedLowLevelThreadPool ( TFunction< EQueuedWorkPriority(EQueuedWorkPriority)> InPriorityMapper, LowLevelTasks::FScheduler* InScheduler )	InPriorityMapper Thread-safe function used to map any priority from this Queue to the priority that should be used when scheduling the task on the underlying thread pool.	Misc/QueuedThreadPoolWrapper.h

Name	Remarks	Include Path	Unreal Specifiers
~FQueuedLowLevelThreadPool()		Misc/QueuedThreadPoolWrapper.h

Name	Remarks
FQueuedWorkInternalData	Internal data of the scheduler used for cancellation

Name	Type	Include Path
bIsExiting	std::atomic_bool	Misc/QueuedThreadPoolWrapper.h
bIsPaused	std::atomic_bool	Misc/QueuedThreadPoolWrapper.h
Finished	UE::FManualResetEvent	Misc/QueuedThreadPoolWrapper.h
PendingWork	FAAArrayQueue< FQueuedWorkInternalData >	Misc/QueuedThreadPoolWrapper.h
PriorityMapper	TFunction< EQueuedWorkPriority(EQueuedWorkPriority)>	Misc/QueuedThreadPoolWrapper.h
Scheduler	LowLevelTasks::FScheduler *	Misc/QueuedThreadPoolWrapper.h
TaskCount	std::atomic_uint	Misc/QueuedThreadPoolWrapper.h

Name	Remarks	Include Path	Unreal Specifiers
void Pause()	Queued task are not scheduled against the wrapped thread-pool until resumed	Misc/QueuedThreadPoolWrapper.h
void Resume ( int32 InNumQueuedWork )	Resume a specified amount of queued work, or -1 to unpause.	Misc/QueuedThreadPoolWrapper.h

Name	Remarks	Include Path	Unreal Specifiers
virtual bool Create ( uint32 InNumQueuedThreads, uint32 StackSize, EThreadPriority ThreadPriority, const TCHAR* Name )	Creates the thread pool with the specified number of threads	Misc/QueuedThreadPoolWrapper.h
virtual void Destroy()	Tells the pool to clean up all background threads	Misc/QueuedThreadPoolWrapper.h

Name	Remarks	Include Path	Unreal Specifiers
void operator delete ( void* ptr )		Misc/QueuedThreadPoolWrapper.h
void * operator new ( size_t size )		Misc/QueuedThreadPoolWrapper.h