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

#include <CheckedAudioBuffer.h>

Public Types

using ECheckBehavior = Audio::EBufferCheckBehavior
 

Public Member Functions

void SetName (const FString &InName)
 
void SetCheckBehavior (const ECheckBehavior InBehavior)
 
void SetCheckFlags (const ECheckBufferFlags InCheckFlags)
 
 operator FAlignedFloatBuffer & ()
 
 operator TArrayView< float > ()
 
 operator TArrayView< const float > () const
 
 operator const FAlignedFloatBuffer & () const
 
UE_API void operator= (const FAlignedFloatBuffer &InOther)
 
const FAlignedFloatBufferoperator& () const
 
FAlignedFloatBufferoperator& ()
 
UE_API int32 Num () const
 
UE_API void Reserve (const int32 InSize)
 
UE_API void Reset (const int32 InSize=0)
 
UE_API void AddZeroed (const int32 InSize)
 
UE_API void SetNumZeroed (const int32 InSize)
 
UE_API void SetNumUninitialized (const int32 InNum)
 
UE_API const FAlignedFloatBufferGetBuffer () const
 
UE_API FAlignedFloatBufferGetBuffer ()
 
UE_API floatGetData ()
 
UE_API void Append (const FAlignedFloatBuffer &InBuffer)
 
UE_API void Append (TArrayView< const float > InView)
 
UE_API void Append (const FCheckedAudioBuffer &InBuffer)
 

Detailed Description

Opaque wrapper around FAlignedFloatBuffer. Will perform different checks on accessing the buffer, which can be enabled by flags. Error states are sticky.

Member Typedef Documentation

◆ ECheckBehavior

Member Function Documentation

◆ AddZeroed()

void Audio::FCheckedAudioBuffer::AddZeroed ( const int32  InSize)

◆ Append() [1/3]

void Audio::FCheckedAudioBuffer::Append ( const FAlignedFloatBuffer InBuffer)

◆ Append() [2/3]

void Audio::FCheckedAudioBuffer::Append ( const FCheckedAudioBuffer InBuffer)

◆ Append() [3/3]

void Audio::FCheckedAudioBuffer::Append ( TArrayView< const float InView)

◆ GetBuffer() [1/2]

Audio::FAlignedFloatBuffer & Audio::FCheckedAudioBuffer::GetBuffer ( )

◆ GetBuffer() [2/2]

const Audio::FAlignedFloatBuffer & Audio::FCheckedAudioBuffer::GetBuffer ( ) const

◆ GetData()

float * Audio::FCheckedAudioBuffer::GetData ( )

◆ Num()

int32 Audio::FCheckedAudioBuffer::Num ( ) const

◆ operator const FAlignedFloatBuffer &()

Audio::FCheckedAudioBuffer::operator const FAlignedFloatBuffer & ( ) const
inline

◆ operator FAlignedFloatBuffer &()

Audio::FCheckedAudioBuffer::operator FAlignedFloatBuffer & ( )
inline

◆ operator TArrayView< const float >()

Audio::FCheckedAudioBuffer::operator TArrayView< const float > ( ) const
inline

◆ operator TArrayView< float >()

Audio::FCheckedAudioBuffer::operator TArrayView< float > ( )
inline

◆ operator&() [1/2]

FAlignedFloatBuffer * Audio::FCheckedAudioBuffer::operator& ( )
inline

◆ operator&() [2/2]

const FAlignedFloatBuffer * Audio::FCheckedAudioBuffer::operator& ( ) const
inline

◆ operator=()

void Audio::FCheckedAudioBuffer::operator= ( const FAlignedFloatBuffer InOther)

◆ Reserve()

void Audio::FCheckedAudioBuffer::Reserve ( const int32  InSize)

◆ Reset()

void Audio::FCheckedAudioBuffer::Reset ( const int32  InSize = 0)

◆ SetCheckBehavior()

void Audio::FCheckedAudioBuffer::SetCheckBehavior ( const ECheckBehavior  InBehavior)
inline

◆ SetCheckFlags()

void Audio::FCheckedAudioBuffer::SetCheckFlags ( const ECheckBufferFlags  InCheckFlags)
inline

◆ SetName()

void Audio::FCheckedAudioBuffer::SetName ( const FString &  InName)
inline

◆ SetNumUninitialized()

void Audio::FCheckedAudioBuffer::SetNumUninitialized ( const int32  InNum)

◆ SetNumZeroed()

void Audio::FCheckedAudioBuffer::SetNumZeroed ( const int32  InSize)

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