UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
AudioCommandPrivate::FGameThreadAudioCommandQueue Class Reference
+ Inheritance diagram for AudioCommandPrivate::FGameThreadAudioCommandQueue:

Public Member Functions

 FGameThreadAudioCommandQueue ()
 
virtual ~FGameThreadAudioCommandQueue () override=default
 
void StartTick ()
 
void EndTick ()
 
bool CanTick () const
 
void RunCommandOnGameThread (TUniqueFunction< void()> InFunction, const TStatId InStatId)
 
void FlushCommands ()
 
- Public Member Functions inherited from FTickFunction
 UPROPERTY (EditDefaultsOnly, Category="Tick", meta=(DisplayName="Tick Interval (secs)")) float TickInterval
 
ENGINE_API FTickFunction ()
 
virtual ENGINE_API ~FTickFunction ()
 
ENGINE_API void RegisterTickFunction (class ULevel *Level)
 
ENGINE_API void UnRegisterTickFunction ()
 
bool IsTickFunctionRegistered () const
 
ENGINE_API void SetTickFunctionEnable (bool bInEnabled)
 
bool IsTickFunctionEnabled () const
 
ENGINE_API void UpdateTickIntervalAndCoolDown (float NewTickInterval)
 
ENGINE_API bool IsCompletionHandleValid () const
 
ENGINE_API FGraphEventRef GetCompletionHandle () const
 
virtual ENGINE_API bool CanDispatchManually () const
 
virtual ENGINE_API bool DispatchManually ()
 
TEnumAsByte< enum ETickingGroupGetActualTickGroup () const
 
TEnumAsByte< enum ETickingGroupGetActualEndTickGroup () const
 
ENGINE_API void AddPrerequisite (UObject *TargetObject, struct FTickFunction &TargetTickFunction)
 
ENGINE_API void RemovePrerequisite (UObject *TargetObject, struct FTickFunction &TargetTickFunction)
 
ENGINE_API void SetPriorityIncludingPrerequisites (bool bInHighPriority)
 
TArray< struct FTickPrerequisite > & GetPrerequisites ()
 
const TArray< struct FTickPrerequisite > & GetPrerequisites () const
 
float GetLastTickGameTime () const
 
ENGINE_API void ExecuteNestedTick (float DeltaTime, ELevelTick TickType, ENamedThreads::Type CurrentThread, const FGraphEventRef &MyCompletionGraphEvent)
 
ENGINE_API float CalculateDeltaTime (float DeltaTime, const class UWorld *TickingWorld)
 
ENGINE_API void LogTickFunction (ENamedThreads::Type CurrentThread, bool bLogPrerequisites, int32 Indent=0)
 
ENGINE_API void ShowPrerequistes (int32 Indent=1)
 
ENGINE_API void ClearTaskInformation ()
 
virtual void virtual FString return TEXT ("DiagnosticMessage() not implemented")
 
virtual void ForEachNestedTick (TFunctionRef< void(FTickFunction &)> InFunc) const
 
FTickFunctionoperator= (const FTickFunction &)=delete
 

Additional Inherited Members

- Public Attributes inherited from FTickFunction
TEnumAsByte< enum ETickingGroupTickGroup
 
TEnumAsByte< enum ETickingGroupEndTickGroup
 
uint8 bTickEvenWhenPaused:1
 
uint8 bCanEverTick:1
 
uint8 bStartWithTickEnabled:1
 
uint8 bAllowTickOnDedicatedServer:1
 
uint8 bAllowTickBatching:1
 
uint8 bHighPriority:1
 
uint8 bRunOnAnyThread:1
 
uint8 bRunTransactionally:1
 
uint8 bDispatchManually: 1
 

Constructor & Destructor Documentation

◆ FGameThreadAudioCommandQueue()

AudioCommandPrivate::FGameThreadAudioCommandQueue::FGameThreadAudioCommandQueue ( )
inline

◆ ~FGameThreadAudioCommandQueue()

virtual AudioCommandPrivate::FGameThreadAudioCommandQueue::~FGameThreadAudioCommandQueue ( )
overridevirtualdefault

Member Function Documentation

◆ CanTick()

bool AudioCommandPrivate::FGameThreadAudioCommandQueue::CanTick ( ) const
inline

◆ EndTick()

void AudioCommandPrivate::FGameThreadAudioCommandQueue::EndTick ( )
inline

◆ FlushCommands()

void AudioCommandPrivate::FGameThreadAudioCommandQueue::FlushCommands ( )
inline

◆ RunCommandOnGameThread()

void AudioCommandPrivate::FGameThreadAudioCommandQueue::RunCommandOnGameThread ( TUniqueFunction< void()>  InFunction,
const TStatId  InStatId 
)
inline

◆ StartTick()

void AudioCommandPrivate::FGameThreadAudioCommandQueue::StartTick ( )
inline

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