UE::Tick::FSyncPointDescription Struct Reference

#include <TaskSyncManager.h>

Public Member Functions
bool	IsValid () const
bool	WasLoadedFromSettings () const

Public Attributes
FName	RegisteredName
FName	SourceName
ESyncPointEventType	EventType = ESyncPointEventType::Invalid
ESyncPointActivationRules	ActivationRules = ESyncPointActivationRules::Invalid
TEnumAsByte< enum ETickingGroup >	FirstPossibleTickGroup = TG_PrePhysics
TEnumAsByte< enum ETickingGroup >	LastPossibleTickGroup = TG_LastDemotable
TArray< FName >	PrerequisiteSyncGroups

Detailed Description

Description of a registered sync event that will happen once per frame according to specific rules

Member Function Documentation

IsValid()

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

inline

True if this valid and has a name

WasLoadedFromSettings()

bool UE::Tick::FSyncPointDescription::WasLoadedFromSettings ( ) const

inline

True if this was loaded from settings and has a default source

Member Data Documentation

ActivationRules

ESyncPointActivationRules UE::Tick::FSyncPointDescription::ActivationRules = ESyncPointActivationRules::Invalid

Rules for when and how a sync point can be activated

EventType

ESyncPointEventType UE::Tick::FSyncPointDescription::EventType = ESyncPointEventType::Invalid

The kind of task async task that is used to implement this sync point

FirstPossibleTickGroup

TEnumAsByte<enum ETickingGroup> UE::Tick::FSyncPointDescription::FirstPossibleTickGroup = TG_PrePhysics

The first tick group this could be triggered during

LastPossibleTickGroup

TEnumAsByte<enum ETickingGroup> UE::Tick::FSyncPointDescription::LastPossibleTickGroup = TG_LastDemotable

The last possible tick group this will be triggered during, and when it will be forcibly triggered as a backup

PrerequisiteSyncGroups

TArray<FName> UE::Tick::FSyncPointDescription::PrerequisiteSyncGroups

Array of other sync groups that this will tick after. To match the normal tick behavior these will be ignored if thee sync point is not active

RegisteredName

FName UE::Tick::FSyncPointDescription::RegisteredName

Name of the sync point that will be used for lookup

SourceName

FName UE::Tick::FSyncPointDescription::SourceName

Name of what added this description, default means it was loaded from settings

---

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

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