UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::Tasks::Private Namespace Reference

Classes

class  FTaskBase
 
class  FTaskEventBase
 
class  FTaskHandle
 
struct  FThreadLocalRetractionScope
 
class  TExecutableTask
 
class  TExecutableTaskBase
 
class  TExecutableTaskBase< TaskBodyType, typename TEnableIf< std::is_same_v< TInvokeResult_T< TaskBodyType >, void > >::Type >
 
class  TTaskWithResult
 

Typedefs

using FExecutableTaskAllocator = TLockFreeFixedSizeAllocator_TLSCache< SmallTaskSize, PLATFORM_CACHE_LINE_SIZE >
 
using FTaskEventBaseAllocator = TLockFreeFixedSizeAllocator_TLSCache< sizeof(FTaskEventBase), PLATFORM_CACHE_LINE_SIZE >
 

Functions

ENamedThreads::Type TranslatePriority (EExtendedTaskPriority Priority)
 
ENamedThreads::Type TranslatePriority (ETaskPriority Priority)
 
bool IsThreadRetractingTask ()
 
bool ShouldForceWaitWithNamedThreadsSupport (EExtendedTaskPriority Priority)
 
FTaskBaseGetCurrentTask ()
 
FTaskBaseExchangeCurrentTask (FTaskBase *Task)
 
bool TryWaitOnNamedThread (FTaskBase &Task)
 
void TranslatePriority (ENamedThreads::Type ThreadType, ETaskPriority &OutPriority, EExtendedTaskPriority &OutExtendedPriority)
 
ENamedThreads::Type TranslatePriority (ETaskPriority Priority, EExtendedTaskPriority ExtendedPriority)
 
template<typename TaskCollectionType >
TArray< TaskTrace::FIdGetTraceIds (const TaskCollectionType &Tasks)
 
template<int32 Index, typename ArrayType , typename FirstTaskType , typename... OtherTasksTypes>
void PrerequisitesUnpacker (ArrayType &Array, FirstTaskType &FirstTask, OtherTasksTypes &... OtherTasks)
 
template<int32 Index, typename ArrayType , typename TaskType >
void PrerequisitesUnpacker (ArrayType &Array, TaskType &Task)
 
template<typename HigherLevelTaskType , std::enable_if_t< std::is_same_v< HigherLevelTaskType, FTask > > * = nullptr>
bool IsCompleted (const HigherLevelTaskType &Prerequisite)
 
template<typename TaskCollectionType >
bool TryRetractAndExecute (const TaskCollectionType &Tasks, FTimeout Timeout)
 

Variables

FExecutableTaskAllocator SmallTaskAllocator
 
FTaskEventBaseAllocator TaskEventBaseAllocator
 
thread_local uint32 TaskRetractionRecursion = 0
 
constexpr int32 SmallTaskSize = 256
 

Typedef Documentation

◆ FExecutableTaskAllocator

◆ FTaskEventBaseAllocator

Function Documentation

◆ ExchangeCurrentTask()

CORE_API FTaskBase * UE::Tasks::Private::ExchangeCurrentTask ( FTaskBase Task)

◆ GetCurrentTask()

CORE_API FTaskBase * UE::Tasks::Private::GetCurrentTask ( )

◆ GetTraceIds()

TArray< TaskTrace::FId > UE::Tasks::Private::GetTraceIds ( const TaskCollectionType Tasks)

◆ IsCompleted()

template<typename HigherLevelTaskType , std::enable_if_t< std::is_same_v< HigherLevelTaskType, FTask > > * = nullptr>
bool UE::Tasks::Private::IsCompleted ( const HigherLevelTaskType Prerequisite)

◆ IsThreadRetractingTask()

CORE_API bool UE::Tasks::Private::IsThreadRetractingTask ( )

◆ PrerequisitesUnpacker() [1/2]

template<int32 Index, typename ArrayType , typename FirstTaskType , typename... OtherTasksTypes>
void UE::Tasks::Private::PrerequisitesUnpacker ( ArrayType &  Array,
FirstTaskType FirstTask,
OtherTasksTypes &...  OtherTasks 
)

◆ PrerequisitesUnpacker() [2/2]

template<int32 Index, typename ArrayType , typename TaskType >
void UE::Tasks::Private::PrerequisitesUnpacker ( ArrayType &  Array,
TaskType &  Task 
)

◆ ShouldForceWaitWithNamedThreadsSupport()

bool UE::Tasks::Private::ShouldForceWaitWithNamedThreadsSupport ( EExtendedTaskPriority  Priority)

◆ TranslatePriority() [1/4]

ENamedThreads::Type UE::Tasks::Private::TranslatePriority ( EExtendedTaskPriority  Priority)

◆ TranslatePriority() [2/4]

CORE_API void UE::Tasks::Private::TranslatePriority ( ENamedThreads::Type  ThreadType,
ETaskPriority &  OutPriority,
EExtendedTaskPriority OutExtendedPriority 
)

◆ TranslatePriority() [3/4]

ENamedThreads::Type UE::Tasks::Private::TranslatePriority ( ETaskPriority  Priority)

◆ TranslatePriority() [4/4]

CORE_API ENamedThreads::Type UE::Tasks::Private::TranslatePriority ( ETaskPriority  Priority,
EExtendedTaskPriority  ExtendedPriority 
)

◆ TryRetractAndExecute()

bool UE::Tasks::Private::TryRetractAndExecute ( const TaskCollectionType Tasks,
FTimeout  Timeout 
)

◆ TryWaitOnNamedThread()

CORE_API bool UE::Tasks::Private::TryWaitOnNamedThread ( FTaskBase Task)

Variable Documentation

◆ SmallTaskAllocator

CORE_API FExecutableTaskAllocator UE::Tasks::Private::SmallTaskAllocator

◆ SmallTaskSize

constexpr int32 UE::Tasks::Private::SmallTaskSize = 256
inlineconstexpr

◆ TaskEventBaseAllocator

CORE_API FTaskEventBaseAllocator UE::Tasks::Private::TaskEventBaseAllocator

◆ TaskRetractionRecursion

thread_local uint32 UE::Tasks::Private::TaskRetractionRecursion = 0