Navigation
API > API/Runtime > API/Runtime/Engine
Handle pointing to a FActiveSyncPoint that can be used to reserve or request work to execute as part of that sync point. These handles cannot be copied, but can be safely moved between threads and will cancel all reservations and requests on destruction.
| Name | FActiveSyncWorkHandle |
| Type | struct |
| Header File | /Engine/Source/Runtime/Engine/Public/TaskSyncManager.h |
| Include Path | #include "TaskSyncManager.h" |
Syntax
struct FActiveSyncWorkHandle
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FActiveSyncWorkHandle
(
const FActiveSyncWorkHandle& |
These handles can be moved but not copied. | TaskSyncManager.h | |
| TaskSyncManager.h | |||
| TaskSyncManager.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FActiveSyncWorkHandle() |
TaskSyncManager.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| MaxWorkIndex | uint32 | Max amount of work per sync point | TaskSyncManager.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bHasWorkQueue | uint32 | True if this represents a function work queue | TaskSyncManager.h | |
| bWorkRequested | uint32 | True if this may represent active requested work | TaskSyncManager.h | |
| bWorkReserved | uint32 | True if this may represent active reserved work | TaskSyncManager.h | |
| SyncPoint | TSharedPtr< struct FActiveSyncPoint > | The sync point this handle is from | TaskSyncManager.h | |
| WorkIndex | uint32 | Index into the ActiveWork array | TaskSyncManager.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AbandonWork () |
Abandon any requested or reserved work and return to how it was at initial registration. | TaskSyncManager.h | |
| Returns a raw pointer to the tick function that implements this handle which can be passed into AddPrerequisite. | TaskSyncManager.h | ||
bool HasRequestedWork() |
True if this handle has been used to request work. This will still be true until work is abandoned | TaskSyncManager.h | |
bool HasReservedWork() |
True if this handle has been used to reserve work. This will still be true until work is abandoned | TaskSyncManager.h | |
bool HasWorkQueue() |
True if this handle is associated with a work queue that can be added to | TaskSyncManager.h | |
bool IsValid() |
True if this points to a real sync point | TaskSyncManager.h | |
bool QueueWorkFunction
(
FWorkFunction&& WorkFunction |
Adds an arbitrary work function to the queue of work to execute later, this will fail if work has already been requested or reserved | TaskSyncManager.h | |
bool RequestWork
(
FTickFunction* FunctionToExecute, |
Requests that a tick function be executed by the sync point, this fills any reservations and may trigger tasks. | TaskSyncManager.h | |
bool ReserveFutureWork
(
ESyncWorkRepetition Repeat |
Request to reserve work using this handle, which must be filled to complete the frame's tasks. | TaskSyncManager.h | |
bool Reset () |
Completely reset this handle, which will abandon work and prevent any future use. | TaskSyncManager.h | |
bool SendQueuedWork
(
FGraphEventRef* TaskToExtend |
Sends any previously queued work to be executed as part of the sync point. | TaskSyncManager.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FActiveSyncWorkHandle & operator=
(
const FActiveSyncWorkHandle& |
TaskSyncManager.h | ||
| TaskSyncManager.h |