UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | List of all members
FReturnGraphTask Class Reference

#include <TaskGraphInterfaces.h>

Public Member Functions

 FReturnGraphTask (ENamedThreads::Type InThreadToReturnFrom)
 
UE_FORCEINLINE_HINT TStatId GetStatId () const
 
ENamedThreads::Type GetDesiredThread ()
 
void DoTask (ENamedThreads::Type CurrentThread, const FGraphEventRef &MyCompletionGraphEvent)
 

Static Public Member Functions

static ESubsequentsMode::Type GetSubsequentsMode ()
 

Detailed Description

FReturnGraphTask is a task used to return flow control from a named thread back to the original caller of ProcessThreadUntilRequestReturn

Constructor & Destructor Documentation

◆ FReturnGraphTask()

FReturnGraphTask::FReturnGraphTask ( ENamedThreads::Type  InThreadToReturnFrom)
inline

Constructor

Parameters
InThreadToReturnFrom;named thread to cause to return

Member Function Documentation

◆ DoTask()

void FReturnGraphTask::DoTask ( ENamedThreads::Type  CurrentThread,
const FGraphEventRef &  MyCompletionGraphEvent 
)
inline

Actually execute the task.

Parameters
CurrentThread;the thread we are running on
MyCompletionGraphEvent;my completion event. Not always useful since at the end of DoWork, you can assume you are done and hence further tasks do not need you as a prerequisite. However, MyCompletionGraphEvent can be useful for passing to other routines or when it is handy to set up subsequents before you actually do work.

◆ GetDesiredThread()

ENamedThreads::Type FReturnGraphTask::GetDesiredThread ( )
inline

Retrieve the thread that this task wants to run on.

Returns
the thread that this task should run on.

◆ GetStatId()

UE_FORCEINLINE_HINT TStatId FReturnGraphTask::GetStatId ( ) const
inline

◆ GetSubsequentsMode()

static ESubsequentsMode::Type FReturnGraphTask::GetSubsequentsMode ( )
inlinestatic
The documentation for this class was generated from the following file: