FNullGraphTask Class Reference

#include <TaskGraphInterfaces.h>

Inheritance diagram for FNullGraphTask:

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

Static Public Member Functions
static ESubsequentsMode::Type	GetSubsequentsMode ()

Detailed Description

FNullGraphTask is a task that does nothing. It can be used to "gather" tasks into one prerequisite.

Constructor & Destructor Documentation

FNullGraphTask()

FNullGraphTask::FNullGraphTask ( const TStatId &  StatId, ENamedThreads::Type  InDesiredThread  )

inline

Constructor

Parameters

StatId	The stat id for this task.
InDesiredThread;	Thread to run on, can be ENamedThreads::AnyThread

Member Function Documentation

DoTask()

void FNullGraphTask::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 FNullGraphTask::GetDesiredThread ( )

inline

Retrieve the thread that this task wants to run on.

Returns

the thread that this task should run on.

GetSubsequentsMode()

static ESubsequentsMode::Type FNullGraphTask::GetSubsequentsMode ( )

inlinestatic

---

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

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