FScheduler | Unreal Engine 5.4 Documentation

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Async > API/Runtime/Core/Async/Fundamental

Inheritance Hierarchy

FSchedulerTls
FScheduler

References


Module	Core
Header	/Engine/Source/Runtime/Core/Public/Async/Fundamental/Scheduler.h
Include	#include "Async/Fundamental/Scheduler.h"

Syntax

class FScheduler : public LowLevelTasks::FSchedulerTls

Constructors

	Type	Name	Description
		FScheduler ()

Destructors

	Type	Name	Description
		~FScheduler ()

Functions

Type	Name	Description
void	BusyWait ( const TaskType& Task, bool ForceAllowBackgroundWork )	Tries to do some work until the Task is completed
void	BusyWait ( const TArrayView< const TaskType >& Tasks, bool ForceAllowBackgroundWork )	Tries to do some work until all the Tasks are completed the template parameter can be any Type that has a const conversion operator to FTask
void	BusyWaitUntil ( Conditional&& Cond, bool ForceAllowBackgroundWork )	Tries to do some work until the Conditional return true
FScheduler &	Get ()
EThreadPriority	GetBackgroundPriority ()	Get the background priority set when workers were started
uint32	GetNumWorkers ()	Number of instantiated workers
EThreadPriority	GetWorkerPriority ()	Get the worker priority set when workers were started
void	RestartWorkers ( uint32 NumForegroundWorkers, uint32 NumBackgroundWorkers, FThread::EForkable IsForkable, EThreadPriority WorkerPriority, EThreadPriority BackgroundPriority, uint64 InWorkerAffinity, uint64 InBackgroundAffinity )
void	StartWorkers ( uint32 NumForegroundWorkers, uint32 NumBackgroundWorkers, FThread::EForkable IsForkable, EThreadPriority InWorkerPriority, EThreadPriority InBackgroundPriority, uint64 InWorkerAffinity, uint64 InBackgroundAffinity )	Start number of workers where 0 is the system default
void	StopWorkers ( bool DrainGlobalQueue )
bool	TryLaunch ( FTask& Task, EQueuePreference QueuePreference, bool bWakeUpWorker )	Try to launch the task, the return value will specify if the task was in the ready state and has been launched
bool	TryLaunchAffinity ( FTask& Task, uint32 AffinityIndex )