UE::Tick::FTaskSyncResult Struct Reference

#include <TaskSyncManager.h>

Public Member Functions
	FTaskSyncResult ()
	FTaskSyncResult (ESyncOperationResult Result, ESyncPointStatus Status=ESyncPointStatus::Unknown)
bool	IsValid () const
bool	WasSuccessful () const
	operator bool () const
bool	WasTaskCreatedForFrame () const
bool	WasActivatedForFrame () const

Public Attributes
ESyncOperationResult	OperationResult
ESyncPointStatus	SyncStatus

Detailed Description

Result structure returned from all task sync manager operations. This holds an error code as well as the status of the sync point at operation time, if known.

Constructor & Destructor Documentation

FTaskSyncResult() [1/2]

UE::Tick::FTaskSyncResult::FTaskSyncResult ( )

inline

Invalid result by default

FTaskSyncResult() [2/2]

UE::Tick::FTaskSyncResult::FTaskSyncResult ( ESyncOperationResult  Result, ESyncPointStatus  Status = ESyncPointStatus::Unknown  )

inline

Create from an operation result, defaulting to an unknown sync point status

Member Function Documentation

IsValid()

bool UE::Tick::FTaskSyncResult::IsValid ( ) const

inline

True if the result has been initialized by an operation

operator bool()

UE::Tick::FTaskSyncResult::operator bool ( ) const

inline

Treat successful as true for if statements

WasActivatedForFrame()

bool UE::Tick::FTaskSyncResult::WasActivatedForFrame ( ) const

inline

True if the sync point has already been dispatched for this frame

WasSuccessful()

bool UE::Tick::FTaskSyncResult::WasSuccessful ( ) const

inline

True if the operation was successful

WasTaskCreatedForFrame()

bool UE::Tick::FTaskSyncResult::WasTaskCreatedForFrame ( ) const

inline

True if a low level task was created this frame for this sync point. The task may have been destroyed if it has completed

Member Data Documentation

OperationResult

ESyncOperationResult UE::Tick::FTaskSyncResult::OperationResult

SyncStatus

ESyncPointStatus UE::Tick::FTaskSyncResult::SyncStatus

---

The documentation for this struct was generated from the following file:

• Engine/Source/Runtime/Engine/Public/TaskSyncManager.h