UE::Tick::FActiveSyncPoint Struct Reference

#include <TaskSyncManager.h>

Inheritance diagram for UE::Tick::FActiveSyncPoint:

Public Member Functions
ENGINE_API	FActiveSyncPoint ()
const FSyncPointDescription &	GetDescription () const
const FSyncPointId &	GetSyncPointId () const
const FWorldContextId &	GetWorldContextId () const
ESyncPointStatus	GetFrameStatus () const
bool	IsTickGroupWork () const
ENGINE_API FActiveSyncWorkHandle	RegisterWorkHandle ()
ENGINE_API bool	ReserveFutureWork (FActiveSyncWorkHandle &Handle, ESyncWorkRepetition Repeat)
ENGINE_API bool	RequestWork (FActiveSyncWorkHandle &Handle, FTickFunction *WorkFunction, ESyncWorkRepetition Repeat)
ENGINE_API bool	QueueWorkFunction (FActiveSyncWorkHandle &Handle, FWorkFunction &&WorkFunction)
ENGINE_API bool	SendQueuedWork (FActiveSyncWorkHandle &Handle, FGraphEventRef *TaskToExtend=nullptr)
ENGINE_API bool	AbandonWork (FActiveSyncWorkHandle &Handle)
ENGINE_API bool	ResetWorkHandle (FActiveSyncWorkHandle &Handle)
Public Member Functions inherited from TSharedFromThis< FActiveSyncPoint, ESPMode::ThreadSafe >
TSharedRef< FActiveSyncPoint, Mode >	AsShared ()
TSharedRef< FActiveSyncPoint const, Mode >	AsShared () const
TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const
TWeakPtr< FActiveSyncPoint, Mode >	AsWeak ()
TWeakPtr< FActiveSyncPoint const, Mode >	AsWeak () const
TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const
void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Friends
class	FTaskSyncManager
struct	FActiveSyncWorkHandle

Additional Inherited Members
Protected Member Functions inherited from TSharedFromThis< FActiveSyncPoint, ESPMode::ThreadSafe >
	TSharedFromThis ()
	TSharedFromThis (TSharedFromThis const &)
UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)
	~TSharedFromThis ()
Static Protected Member Functions inherited from TSharedFromThis< FActiveSyncPoint, ESPMode::ThreadSafe >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Detailed Description

Struct defining an active sync point inside a specific world context, implemented as a tick function that may not be registered

Constructor & Destructor Documentation

FActiveSyncPoint()

FActiveSyncPoint::FActiveSyncPoint

(

)

Member Function Documentation

AbandonWork()

bool FActiveSyncPoint::AbandonWork

(

FActiveSyncWorkHandle &

Handle

)

Abandons requested or reserved work, which could trigger other work to start

GetDescription()

const FSyncPointDescription & UE::Tick::FActiveSyncPoint::GetDescription ( ) const

inline

Returns the registered data

GetFrameStatus()

ESyncPointStatus UE::Tick::FActiveSyncPoint::GetFrameStatus ( ) const

inline

Returns current status

GetSyncPointId()

const FSyncPointId & UE::Tick::FActiveSyncPoint::GetSyncPointId ( ) const

inline

Returns the sync point id that created this, including the current batch context

GetWorldContextId()

const FWorldContextId & UE::Tick::FActiveSyncPoint::GetWorldContextId ( ) const

inline

Returns the world context

IsTickGroupWork()

bool UE::Tick::FActiveSyncPoint::IsTickGroupWork ( ) const

inline

True if this is a special work function that is never registered

QueueWorkFunction()

bool FActiveSyncPoint::QueueWorkFunction	(	FActiveSyncWorkHandle &	Handle,
		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

RegisterWorkHandle()

FActiveSyncWorkHandle FActiveSyncPoint::RegisterWorkHandle

(

)

Registers a new work handle that can be used to reserve and request work

RequestWork()

bool FActiveSyncPoint::RequestWork	(	FActiveSyncWorkHandle &	Handle,
		FTickFunction *	WorkFunction,
		ESyncWorkRepetition	Repeat
	)

Creates a new item of work bound to a specific function

ReserveFutureWork()

bool FActiveSyncPoint::ReserveFutureWork	(	FActiveSyncWorkHandle &	Handle,
		ESyncWorkRepetition	Repeat
	)

Uses handle to reserve work for later, that can be requested when ready

ResetWorkHandle()

bool FActiveSyncPoint::ResetWorkHandle

(

FActiveSyncWorkHandle &

Handle

)

Resets a handle

SendQueuedWork()

bool FActiveSyncPoint::SendQueuedWork	(	FActiveSyncWorkHandle &	Handle,
		FGraphEventRef *	TaskToExtend = nullptr
	)

Sends any previously queued work to be executed as part of the sync point. Will call DontCompleteUntil on passed in TaskToExtend if valid

Friends And Related Symbol Documentation

FActiveSyncWorkHandle

friend struct FActiveSyncWorkHandle

friend

FTaskSyncManager

friend class FTaskSyncManager

friend

---

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

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