FSimpleDelegateGraphTask Class Reference

#include <TaskGraphInterfaces.h>

Inheritance diagram for FSimpleDelegateGraphTask:

Public Member Functions
	DECLARE_DELEGATE (FDelegate)
ENamedThreads::Type	GetDesiredThread ()
void	DoTask (ENamedThreads::Type CurrentThread, const FGraphEventRef &MyCompletionGraphEvent)
	FSimpleDelegateGraphTask (const FDelegate &InTaskDeletegate, const TStatId StatId, ENamedThreads::Type InDesiredThread)
Public Member Functions inherited from FCustomStatIDGraphTaskBase
	FCustomStatIDGraphTaskBase (const TStatId &StatId)
TStatId	GetStatId () const

Static Public Member Functions
static ESubsequentsMode::Type	GetSubsequentsMode ()
static FGraphEventRef	CreateAndDispatchWhenReady (const FDelegate &InTaskDeletegate, const TStatId InStatId, const FGraphEventArray *InPrerequisites=NULL, ENamedThreads::Type InDesiredThread=ENamedThreads::AnyThread)
static FGraphEventRef	CreateAndDispatchWhenReady (const FDelegate &InTaskDeletegate, const TStatId &&InStatId, const FGraphEventRef &InPrerequisite, ENamedThreads::Type InDesiredThread=ENamedThreads::AnyThread)

Public Attributes
FDelegate	TaskDelegate
const ENamedThreads::Type	DesiredThread

Detailed Description

Task class for simple delegate based tasks. This is less efficient than a custom task, doesn't provide the task arguments, doesn't allow specification of the current thread, etc.

Constructor & Destructor Documentation

FSimpleDelegateGraphTask()

FSimpleDelegateGraphTask::FSimpleDelegateGraphTask ( const FDelegate &  InTaskDeletegate, const TStatId  StatId, ENamedThreads::Type  InDesiredThread  )

inline

Task constructor

Parameters

InTaskDelegate	- delegate to execute when the prerequisites are complete
StatId	The stat id for this task.
InDesiredThread	- Thread to run on

Member Function Documentation

CreateAndDispatchWhenReady() [1/2]

static FGraphEventRef FSimpleDelegateGraphTask::CreateAndDispatchWhenReady ( const FDelegate &  InTaskDeletegate, const TStatId &&  InStatId, const FGraphEventRef &  InPrerequisite, ENamedThreads::Type  InDesiredThread = ENamedThreads::AnyThread  )

inlinestatic

Create a task and dispatch it when the prerequisites are complete

Parameters

InTaskDelegate	- delegate to execute when the prerequisites are complete
InStatId	- StatId of task for debugging or analysis tools
InPrerequisite	- Handle for a single prerequisite for this task
InDesiredThread	- Thread to run on

Returns

completion handle for the new task

CreateAndDispatchWhenReady() [2/2]

static FGraphEventRef FSimpleDelegateGraphTask::CreateAndDispatchWhenReady ( const FDelegate &  InTaskDeletegate, const TStatId  InStatId, const FGraphEventArray *  InPrerequisites = NULL, ENamedThreads::Type  InDesiredThread = ENamedThreads::AnyThread  )

inlinestatic

Create a task and dispatch it when the prerequisites are complete

Parameters

InTaskDelegate	- delegate to execute when the prerequisites are complete
InStatId	- StatId of task for debugging or analysis tools
InPrerequisites	- Handles for prerequisites for this task, can be NULL if there are no prerequisites
InDesiredThread	- Thread to run on

Returns

completion handle for the new task

DECLARE_DELEGATE()

FSimpleDelegateGraphTask::DECLARE_DELEGATE

(

FDelegate

)

DoTask()

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

inline

GetDesiredThread()

ENamedThreads::Type FSimpleDelegateGraphTask::GetDesiredThread ( )

inline

GetSubsequentsMode()

static ESubsequentsMode::Type FSimpleDelegateGraphTask::GetSubsequentsMode ( )

inlinestatic

Member Data Documentation

DesiredThread

const ENamedThreads::Type FSimpleDelegateGraphTask::DesiredThread

Thread to run delegate on

TaskDelegate

FDelegate FSimpleDelegateGraphTask::TaskDelegate

Delegate to fire when task runs

---

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

• Engine/Source/Runtime/Core/Public/Async/TaskGraphInterfaces.h