FTaskGraphInterface

Interface tot he task graph system

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 FTaskGraphInterface

Remarks

Interface tot he task graph system

Destructors

Name Description

Public function Virtual

~FTaskGraphInterface()

Functions

Name Description

Public function

void

 

AddShutdownCallback

(
    TFunction< void()>& Callback
)

Delegates for shutdown

Public function

void

 

AttachToThread

(
    ENamedThreads::Type CurrentThread
)

A one time call that "introduces" an external thread to the system.

Public function Static

void

 

BroadcastSlow_OnlyUseForSpecialPurposes

(
    bool bDoTaskThreads,
    bool bDoBackgroundThreads,
    TFunction< void...
)

A (slow) function to call a function on every known thread, both named and workers

Public function

FBaseGraphTa...

 

FindWork

(
    ENamedThreads::Type ThreadInNeed
)

Public function Static

FTaskGraphIn...

 

Get()

Singleton for the system

Public function

ENamedThread...

 

GetCurrentThreadIfKnown

(
    bool bLocalQueue
)

Return the current thread type, if known.

Public function

int32

 

GetNumWorkerThreads()

Return the number of worker (non-named) threads PER PRIORITY SET.

Public function

bool

 

IsCurrentThreadKnown()

Return true if the current thread is known.

Public function Static

bool

 

IsMultithread()

The task graph is always multi-threaded for platforms that support it.

Public function Static

bool

 

IsRunning()

Check to see if the system is running.

Public function

bool

 

IsThreadProcessingTasks

(
    ENamedThreads::Type ThreadToCheck
)

Return true if the given named thread is processing tasks.

Public function

uint64

 

ProcessThreadUntilIdle

(
    ENamedThreads::Type CurrentThread
)

Requests that a named thread, which must be this thread, run until idle, then return.

Public function

void

 

ProcessThreadUntilRequestReturn

(
    ENamedThreads::Type CurrentThread
)

Requests that a named thread, which must be this thread, run until an explicit return request is received, then return.

Public function

void

 

RequestReturn

(
    ENamedThreads::Type CurrentThread
)

Request that the given thread stop when it is idle

Public function Static

void

 

Shutdown()

Explicit start call to shutdown the system. This is unlikely to work unless the system is idle.

Public function

void

 

StallForTuning

(
    int32 Index,
    bool Stall
)

Public function Static

void

 

Startup

(
    int32 NumThreads
)

Explicit start call for the system.

Public function

void

 

TriggerEventWhenTaskCompletes

(
    FEvent* InEvent,
    const FGraphEventRef& Task,
    ENamedThreads::Type CurrentThreadIf...,
    ENamedThreads::Type TriggerThread
)

When a task completes, fire a scoped event

Public function

void

 

TriggerEventWhenTasksComplete

(
    FEvent* InEvent,
    const FGraphEventArray& Tasks,
    ENamedThreads::Type CurrentThreadIf...,
    ENamedThreads::Type TriggerThread
)

When a set of tasks complete, fire a scoped event

Public function

void

 

WaitUntilTaskCompletes

(
    const FGraphEventRef& Task,
    ENamedThreads::Type CurrentThreadIf...
)

Requests that a named thread, which must be this thread, run until a task is complete

Public function

void

 

WaitUntilTaskCompletes

(
    FGraphEventRef&& Task,
    ENamedThreads::Type CurrentThreadIf...
)

Public function

void

 

WaitUntilTasksComplete

(
    const FGraphEventArray& Tasks,
    ENamedThreads::Type CurrentThreadIf...
)

Requests that a named thread, which must be this thread, run until a list of tasks is complete.

Public function

void

 

WakeNamedThread

(
    ENamedThreads::Type ThreadToWake
)