FGraphEvent

A [FGraphEvent](API\Runtime\Core\Async\FGraphEvent) is a list of tasks waiting for something.

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

Name Description

Public function

uint32

 

AddRef()

Increases the reference count

Public function

bool

 

AddSubsequent

(
    FBaseGraphTask* Subsequent
)

Attempts to a new subsequent task.

Public function

void

 

CheckDontCompleteUntilIsEmpty()

Verification function to ensure that nobody was tried to add WaitUntil's outside of the context of execution

Public function

FGraphEventR...

 

CreateCompletionHandle()

Does nothing and is needed only for compatibility with the new frontend

Public function Static

FGraphEventR...

 

CreateGraphEvent()

A factory method to create a graph event.

Public function

void

 

DispatchSubsequents

(
    ENamedThreads::Type CurrentThreadIf...
)

"Complete" the event.

Public function

void

 

DispatchSubsequents

(
    TArray< FBaseGraphTask* >& Ne...,
    ENamedThreads::Type CurrentThreadIf...,
    bool bInternal
)

"Complete" the event.

Public function

void

 

DontCompleteUntil

(
    FGraphEventRef EventToWaitFor
)

Delay the firing of this event until the given event fires.

Public function Const

uint32

 

GetRefCount()

Public function Const

TaskTrace::F...

 

GetTraceId()

Public function Const

bool

 

IsComplete()

Determine if the event has been completed. This can be used to poll for completion.

Public function

uint32

 

Release()

Decreases the reference count and destroys the graph event if it is zero.

Public function

void

 

SetDebugName

(
    const TCHAR* Name
)

Sets a name for the event for debugging purposes.

Public function

void

 

Wait

(
    ENamedThreads::Type CurrentThreadIf...
)

A convenient short version of `FTaskGraphInterface::WaitUntilTaskCompletes_

Deprecated Functions

Name Description

Public function

void

 

SetGatherThreadForDontCompleteUntil

(
    ENamedThreads::Type InThreadToDoGat...
)

The feature is not supported anymore. Please remove the call, there's no replacement.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Cancel