UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FAudioCommandFence Class Reference

#include <AudioThread.h>

Public Member Functions

ENGINE_API ~FAudioCommandFence ()
 
ENGINE_API void BeginFence ()
 
ENGINE_API void Wait (bool bProcessGameThreadTasks=false) const
 
ENGINE_API bool IsFenceComplete () const
 

Detailed Description

Used to track pending audio commands from the game thread.

Constructor & Destructor Documentation

◆ ~FAudioCommandFence()

FAudioCommandFence::~FAudioCommandFence ( )

Member Function Documentation

◆ BeginFence()

void FAudioCommandFence::BeginFence ( )

Adds a fence command to the audio command queue. Conceptually, the pending fence count is incremented to reflect the pending fence command. Once the rendering thread has executed the fence command, it decrements the pending fence count.

◆ IsFenceComplete()

bool FAudioCommandFence::IsFenceComplete ( ) const

◆ Wait()

void FAudioCommandFence::Wait ( bool  bProcessGameThreadTasks = false) const

Waits for pending fence commands to retire.

Parameters
bProcessGameThreadTasks,iftrue we are on a short callstack where it is safe to process arbitrary game thread tasks while we wait

Waits for pending fence commands to retire.


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