UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::Tasks::Private::TExecutableTask< TaskBodyType > Class Template Referencefinal

#include <TaskPrivate.h>

+ Inheritance diagram for UE::Tasks::Private::TExecutableTask< TaskBodyType >:

Public Member Functions

 TExecutableTask (const TCHAR *InDebugName, TaskBodyType &&TaskBody, ETaskPriority InPriority, EExtendedTaskPriority InExtendedPriority, ETaskFlags Flags)
 
- Public Member Functions inherited from UE::Tasks::Private::TExecutableTaskBase< TaskBodyType, ResultType, Enable >
virtual void ExecuteTask () override final
 
- Public Member Functions inherited from UE::Tasks::Private::TTaskWithResult< ResultType >
ResultType & GetResult ()
 
- Public Member Functions inherited from UE::Tasks::Private::FTaskBase
void AddRef ()
 
void Release ()
 
uint32 GetRefCount (std::memory_order MemoryOrder=std::memory_order_relaxed) const
 
bool IsAwaitable () const
 
bool IsNamedThreadTask () const
 
ETaskPriority GetPriority () const
 
EExtendedTaskPriority GetExtendedPriority () const
 
bool AddPrerequisites (FTaskBase &Prerequisite)
 
template<typename HigherLevelTaskType , decltype(std::declval< HigherLevelTaskType >().Pimpl) * = nullptr>
bool AddPrerequisites (const HigherLevelTaskType &Prerequisite)
 
template<typename HigherLevelTaskType , std::enable_if_t< std::is_same_v< HigherLevelTaskType, FGraphEventRef > > * = nullptr>
bool AddPrerequisites (const HigherLevelTaskType &Prerequisite)
 
template<typename PrerequisiteCollectionType , decltype(std::declval< PrerequisiteCollectionType >().begin()) * = nullptr>
void AddPrerequisites (const PrerequisiteCollectionType &InPrerequisites)
 
bool AddSubsequent (FTaskBase &Subsequent)
 
void SetPipe (FPipe &InPipe)
 
FPipeGetPipe () const
 
bool Trigger (uint64 TaskSize)
 
bool TryLaunch (uint64 TaskSize)
 
bool IsCompleted () const
 
CORE_API bool TryRetractAndExecute (FTimeout Timeout, uint32 RecursionDepth=0)
 
void ReleaseInternalReference ()
 
void AddNested (FTaskBase &Nested)
 
CORE_API bool Wait (FTimeout Timeout)
 
CORE_API void Wait ()
 
CORE_API void WaitWithNamedThreadsSupport ()
 
TaskTrace::FId GetTraceId () const
 

Static Public Member Functions

static TExecutableTaskCreate (const TCHAR *InDebugName, TaskBodyType &&TaskBody, ETaskPriority InPriority, EExtendedTaskPriority InExtendedPriority, ETaskFlags Flags)
 
static voidoperator new (size_t Size)
 
static void operator delete (void *Ptr, size_t Size)
 

Additional Inherited Members

- Protected Member Functions inherited from UE::Tasks::Private::TExecutableTaskBase< TaskBodyType, ResultType, Enable >
 TExecutableTaskBase (const TCHAR *InDebugName, TaskBodyType &&TaskBody, ETaskPriority InPriority, EExtendedTaskPriority InExtendedPriority, ETaskFlags Flags)
 
- Protected Member Functions inherited from UE::Tasks::Private::TTaskWithResult< ResultType >
 TTaskWithResult (const TCHAR *InDebugName, ETaskPriority InPriority, EExtendedTaskPriority InExtendedPriority, uint32 InitRefCount, ETaskFlags Flags)
 
virtual ~TTaskWithResult () override
 
- Protected Member Functions inherited from UE::Tasks::Private::FTaskBase
 FTaskBase (uint32 InitRefCount, bool bUnlockPrerequisites=true)
 
void Init (const TCHAR *InDebugName, ETaskPriority InPriority, EExtendedTaskPriority InExtendedPriority, ETaskFlags Flags)
 
virtual ~FTaskBase ()
 
template<typename PrerequisiteCollectionType , decltype(std::declval< PrerequisiteCollectionType >().begin()) * = nullptr>
void AddPrerequisites (const PrerequisiteCollectionType &InPrerequisites, bool bLockPrerequisite)
 
bool TryExecuteTask ()
 
void Close ()
 
CORE_API void ClearPipe ()
 
void UnlockPrerequisites ()
 
- Protected Attributes inherited from UE::Tasks::Private::TTaskWithResult< ResultType >
TTypeCompatibleBytes< ResultType > ResultStorage
 

Constructor & Destructor Documentation

◆ TExecutableTask()

template<typename TaskBodyType >
UE::Tasks::Private::TExecutableTask< TaskBodyType >::TExecutableTask ( const TCHAR InDebugName,
TaskBodyType &&  TaskBody,
ETaskPriority  InPriority,
EExtendedTaskPriority  InExtendedPriority,
ETaskFlags  Flags 
)
inline

Member Function Documentation

◆ Create()

template<typename TaskBodyType >
static TExecutableTask * UE::Tasks::Private::TExecutableTask< TaskBodyType >::Create ( const TCHAR InDebugName,
TaskBodyType &&  TaskBody,
ETaskPriority  InPriority,
EExtendedTaskPriority  InExtendedPriority,
ETaskFlags  Flags 
)
inlinestatic

◆ operator delete()

template<typename TaskBodyType >
static void UE::Tasks::Private::TExecutableTask< TaskBodyType >::operator delete ( void Ptr,
size_t  Size 
)
inlinestatic

◆ operator new()

template<typename TaskBodyType >
static void * UE::Tasks::Private::TExecutableTask< TaskBodyType >::operator new ( size_t  Size)
inlinestatic

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