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

#include <Pipe.h>

Public Member Functions

 UE_NONCOPYABLE (FPipe)
 
 FPipe (const TCHAR *InDebugName)
 
 ~FPipe ()
 
bool HasWork () const
 
CORE_API bool WaitUntilEmpty (FTimespan Timeout=FTimespan::MaxValue())
 
template<typename TaskBodyType >
TTask< TInvokeResult_T< TaskBodyType > > Launch (const TCHAR *InDebugName, TaskBodyType &&TaskBody, ETaskPriority Priority=ETaskPriority::Default, EExtendedTaskPriority ExtendedPriority=EExtendedTaskPriority::None, ETaskFlags Flags=ETaskFlags::None)
 
template<typename TaskBodyType , typename PrerequisitesCollectionType >
TTask< TInvokeResult_T< TaskBodyType > > Launch (const TCHAR *InDebugName, TaskBodyType &&TaskBody, PrerequisitesCollectionType &&Prerequisites, ETaskPriority Priority=ETaskPriority::Default, EExtendedTaskPriority ExtendedPriority=EExtendedTaskPriority::None, ETaskFlags Flags=ETaskFlags::None)
 
CORE_API bool IsInContext () const
 
FORCENOINLINE const TCHARGetDebugName () const
 

Friends

class Private::FTaskBase
 

Constructor & Destructor Documentation

◆ FPipe()

UE::Tasks::FPipe::FPipe ( const TCHAR InDebugName)
inlineexplicit

◆ ~FPipe()

UE::Tasks::FPipe::~FPipe ( )
inline

Member Function Documentation

◆ GetDebugName()

FORCENOINLINE const TCHAR * UE::Tasks::FPipe::GetDebugName ( ) const
inline

◆ HasWork()

bool UE::Tasks::FPipe::HasWork ( ) const
inline

◆ IsInContext()

bool UE::Tasks::FPipe::IsInContext ( ) const

◆ Launch() [1/2]

template<typename TaskBodyType >
TTask< TInvokeResult_T< TaskBodyType > > UE::Tasks::FPipe::Launch ( const TCHAR InDebugName,
TaskBodyType &&  TaskBody,
ETaskPriority  Priority = ETaskPriority::Default,
EExtendedTaskPriority  ExtendedPriority = EExtendedTaskPriority::None,
ETaskFlags  Flags = ETaskFlags::None 
)
inline

◆ Launch() [2/2]

TTask< TInvokeResult_T< TaskBodyType > > UE::Tasks::FPipe::Launch ( const TCHAR InDebugName,
TaskBodyType &&  TaskBody,
PrerequisitesCollectionType &&  Prerequisites,
ETaskPriority  Priority = ETaskPriority::Default,
EExtendedTaskPriority  ExtendedPriority = EExtendedTaskPriority::None,
ETaskFlags  Flags = ETaskFlags::None 
)
inline

◆ UE_NONCOPYABLE()

UE::Tasks::FPipe::UE_NONCOPYABLE ( FPipe  )

◆ WaitUntilEmpty()

bool UE::Tasks::FPipe::WaitUntilEmpty ( FTimespan  Timeout = FTimespan::MaxValue())

Friends And Related Symbol Documentation

◆ Private::FTaskBase

friend class Private::FTaskBase
friend

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