Navigation
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 | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | AddShutdownCallback
(
TFunction< void()>& Callback |
Delegates for shutdown | |
| void | AttachToThread
(
ENamedThreads::Type CurrentThread |
A one time call that "introduces" an external thread to the system. | |
| void | BroadcastSlow_OnlyUseForSpecialPurposes
(
bool bDoTaskThreads, |
A (slow) function to call a function on every known thread, both named and workers | |
| FBaseGraphTask * | FindWork
(
ENamedThreads::Type ThreadInNeed |
||
| FTaskGraphInterface & | Get () |
Singleton for the system | |
| ENamedThreads::Type | GetCurrentThreadIfKnown
(
bool bLocalQueue |
Return the current thread type, if known. | |
| int32 | Return the number of background worker threads. | ||
| int32 | Return the number of foreground worker threads. | ||
| int32 | Return the number of worker (non-named) threads PER PRIORITY SET. | ||
| bool | Return true if the current thread is known. | ||
| bool | The task graph is always multi-threaded for platforms that support it. | ||
| bool | IsRunning () |
Check to see if the system is running. | |
| bool | IsThreadProcessingTasks
(
ENamedThreads::Type ThreadToCheck |
Return true if the given named thread is processing tasks. | |
| uint64 | ProcessThreadUntilIdle
(
ENamedThreads::Type CurrentThread |
Requests that a named thread, which must be this thread, run until idle, then return. | |
| 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. | |
| void | RequestReturn
(
ENamedThreads::Type CurrentThread |
Request that the given thread stop when it is idle | |
| void | Shutdown () |
Explicit start call to shutdown the system. This is unlikely to work unless the system is idle. | |
| void | StallForTuning
(
int32 Index, |
||
| void | Startup
(
int32 NumThreads |
Explicit start call for the system. | |
| void | TriggerEventWhenTaskCompletes
(
FEvent* InEvent, |
When a task completes, fire a scoped event | |
| void | TriggerEventWhenTasksComplete
(
FEvent* InEvent, |
When a set of tasks complete, fire a scoped event | |
| void | WaitUntilTaskCompletes
(
const FGraphEventRef& Task, |
Requests that a named thread, which must be this thread, run until a task is complete | |
| void | WaitUntilTaskCompletes
(
FGraphEventRef&& Task, |
||
| void | WaitUntilTasksComplete
(
const FGraphEventArray& Tasks, |
Requests that a named thread, which must be this thread, run until a list of tasks is complete. | |
| void | WakeNamedThread
(
ENamedThreads::Type ThreadToWake |