Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > Async > FGraphEvent

Light Theme

Dark Theme

FGraphEvent

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

Choose your operating system:

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
uint32	AddRef()	Increases the reference count
bool	AddSubsequent ( FBaseGraphTask* Subsequent )	Attempts to a new subsequent task.
void	CheckDontCompleteUntilIsEmpty()	Verification function to ensure that nobody was tried to add WaitUntil's outside of the context of execution
FGraphEventR...	CreateGraphEvent()	A factory method to create a graph event.
void	DispatchSubsequents ( ENamedThreads::Type CurrentThreadIf... )	"Complete" the event.
void	DispatchSubsequents ( TArray< FBaseGraphTask* >& Ne..., ENamedThreads::Type CurrentThreadIf... )	"Complete" the event.
void	DontCompleteUntil ( FGraphEventRef EventToWaitFor )	Delay the firing of this event until the given event fires.
uint32	GetRefCount()
TaskTrace::F...	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	Wait ( ENamedThreads::Type CurrentThreadIf... )	A convenient short version of `FTaskGraphInterface::WaitUntilTaskCompletes_

Deprecated Functions

		Name	Description
	void	SetGatherThreadForDontCompleteUntil ( ENamedThreads::Type InThreadToDoGat... )	The feature is not supported anymore. Please remove the call, there's no replacement.