1. Epic GamesDeveloper
  3. FTaskGraphInterface

FTaskGraphInterface

Interface to the task graph system

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Async

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/Async/TaskGraphInterfaces.h
Include #include "Async/TaskGraphInterfaces.h"

Syntax

class FTaskGraphInterface

Remarks

Interface to the task graph system

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

AddShutdownCallback ( TFunction< void()>& Callback
)

 Delegates for shutdown
Public function void A one time call that "introduces" an external thread to the system.
Public function Static void

BroadcastSlow_OnlyUseForSpecialPurposes ( bool bDoTaskThreads,
bool bDoBackgroundThreads,
TFunction< void(ENamedThreads::Type CurrentThread)>& Callback
)

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

FindWork ( ENamedThreads::Type ThreadInNeed
)

  
Public function Static FTaskGraphInterface &

Get ()

 Singleton for the system
Public function ENamedThreads::Type

GetCurrentThreadIfKnown ( bool bLocalQueue
)

 Return the current thread type, if known.
Public function int32 Return the number of background worker threads.
Public function int32 Return the number of foreground worker threads.
Public function int32 Return the number of worker (non-named) threads PER PRIORITY SET.
Public function bool Return true if the current thread is known.
Public function Static bool The task graph is always multi-threaded for platforms that support it.
Public function Static bool Check to see if the system is running.
Public function bool Return true if the given named thread is processing tasks.
Public function uint64 Requests that a named thread, which must be this thread, run until idle, then return.
Public function void Requests that a named thread, which must be this thread, run until an explicit return request is received, then return.
Public function void Request that the given thread stop when it is idle
Public function Static void 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 CurrentThreadIfKnown,
ENamedThreads::Type TriggerThread
)

 When a task completes, fire a scoped event
Public function void

TriggerEventWhenTasksComplete ( FEvent* InEvent,
const FGraphEventArray& Tasks,
ENamedThreads::Type CurrentThreadIfKnown,
ENamedThreads::Type TriggerThread
)

 When a set of tasks complete, fire a scoped event
Public function void

WaitUntilTaskCompletes ( const FGraphEventRef& Task,
ENamedThreads::Type CurrentThreadIfKnown
)

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

WaitUntilTaskCompletes ( FGraphEventRef&& Task,
ENamedThreads::Type CurrentThreadIfKnown
)

  
Public function void

WaitUntilTasksComplete ( const FGraphEventArray& Tasks,
ENamedThreads::Type CurrentThreadIfKnown
)

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page