Navigation
API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Async
References
| Module | Core |
| Header | /Engine/Source/Runtime/Core/Public/Async/TaskGraphInterfaces.h |
| Include | #include "Async/TaskGraphInterfaces.h" |
Syntax
class FGraphEvent
Remarks
A FGraphEvent is a list of tasks waiting for something. These tasks are call the subsequents. A graph event is a prerequisite for each of its subsequents. Graph events have a lifetime managed by reference counting.
Constructors
No constructors are accessible with public or protected access.
Destructors
No destructors are accessible with public or protected access.
Functions
| Type | Name | Description | |
|---|---|---|---|
| uint32 | AddRef () |
Increases the reference count | |
| bool | AddSubsequent
(
FBaseGraphTask* Subsequent |
Attempts to a new subsequent task. | |
| void | Verification function to ensure that nobody was tried to add WaitUntil's outside of the context of execution | ||
| FGraphEventRef | Does nothing and is needed only for compatibility with the new frontend | ||
| FGraphEventRef | A factory method to create a graph event. | ||
| void | DispatchSubsequents
(
ENamedThreads::Type CurrentThreadIfKnown |
"Complete" the event. | |
| void | DispatchSubsequents
(
TArray< FBaseGraphTask* >& NewTasks, |
"Complete" the event. | |
| void | DontCompleteUntil
(
FGraphEventRef EventToWaitFor |
Delay the firing of this event until the given event fires. | |
| uint32 | GetRefCount () |
||
| TaskTrace::FId | GetTraceId () |
||
| bool | IsComplete () |
Determine if the event has been completed. This can be used to poll for completion. | |
| uint32 | Release () |
Decreases the reference count and destroys the graph event if it is zero. | |
| void | SetDebugName
(
const TCHAR* Name |
Sets a name for the event for debugging purposes. | |
| void | SetGatherThreadForDontCompleteUntil
(
ENamedThreads::Type InThreadToDoGatherOn |
Sets the thread that you want to execute the null gather task on. | |
| void | Wait
(
ENamedThreads::Type CurrentThreadIfKnown |
A convenient short version of `FTaskGraphInterface::WaitUntilTaskCompletes_ |