FCompletionList

List of tasks that can be "joined" into one task which can be waited on or used as a prerequisite.

Windows
MacOS
Linux

References

Module

Core

Header

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

Include

#include "Async/TaskGraphInterfaces.h"

Syntax

class FCompletionList

Remarks

List of tasks that can be "joined" into one task which can be waited on or used as a prerequisite. Note, these are FGraphEventRef's, but we manually manage the reference count instead of using a smart pointer

Functions

Name Description

Public function

void

 

Add

(
    const FGraphEventRef& TaskToAdd
)

Adds a task to the completion list, can be called from any thread

Public function

void

 

ChainWaitForPrerequisites

(
    ENamedThreads::Type CurrentThread,
    const FGraphEventRef& MyCompletion...
)

Task function that waits until any newly added pending commands complete before it completes, forming a chain

Public function

FGraphEventR...

 

CreatePrerequisiteCompletionHandle

(
    ENamedThreads::Type CurrentThread
)

Create a completion handle that represents the completion of all pending tasks This is complicated by the fact that some of the tasks we are waiting for might also add tasks So it is recursive and the task we call here uses DontCompleteUntil to build the chain this should always be called from the same thread.

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