FGraphEvent

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

Windows
MacOS
Linux

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 * Task
)

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 Static

FGraphEventR ...

 

CreateGraphEvent()

A factory method to create a graph event.

Public function Static

FGraphEvent ...

 

CreateGraphEventWithInlineStorage()

The returned event will have ref count zero; be sure to add one!

Public function

void

 

DispatchSubsequents

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

"Complete" the event.

Public function

void

 

DontCompleteUntil

(
    FGraphEventRef EventToWaitFor
)

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

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

 

SetGatherThreadForDontCompleteUntil

(
    ENamedThreads::Type InThreadToDoGat...
)

Sets the thread that you want to execute the null gather task on.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback