UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Audio::TSample< SampleType, Q > Class Template Reference

#include <Dsp.h>

Public Member Functions

 TSample (SampleType &InSample)
 
template<typename ReturnType = float>
ReturnType AsFloat () const
 
template<typename ReturnType , uint32 ReturnQ = (sizeof(SampleType) * 8 - 1)>
ReturnType AsFixedPrecisionInt ()
 
template<typename OtherSampleType >
TSample< SampleType, Q > & operator= (const OtherSampleType InSample)
 

Friends

template<typename OtherSampleType >
TSample< SampleType, Q > operator* (const TSample< SampleType, Q > &LHS, const OtherSampleType &RHS)
 

Detailed Description

template<typename SampleType, uint32 Q = (sizeof(SampleType) * 8 - 1)>
class Audio::TSample< SampleType, Q >

TSample<SampleType, Q> Variant type to simplify converting and performing operations on fixed precision and floating point samples.

Constructor & Destructor Documentation

◆ TSample()

template<typename SampleType , uint32 Q = (sizeof(SampleType) * 8 - 1)>
Audio::TSample< SampleType, Q >::TSample ( SampleType &  InSample)
inline

Member Function Documentation

◆ AsFixedPrecisionInt()

template<typename SampleType , uint32 Q = (sizeof(SampleType) * 8 - 1)>
template<typename ReturnType , uint32 ReturnQ = (sizeof(SampleType) * 8 - 1)>
ReturnType Audio::TSample< SampleType, Q >::AsFixedPrecisionInt ( )
inline

◆ AsFloat()

template<typename SampleType , uint32 Q = (sizeof(SampleType) * 8 - 1)>
template<typename ReturnType = float>
ReturnType Audio::TSample< SampleType, Q >::AsFloat ( ) const
inline

◆ operator=()

template<typename SampleType , uint32 Q = (sizeof(SampleType) * 8 - 1)>
TSample< SampleType, Q > & Audio::TSample< SampleType, Q >::operator= ( const OtherSampleType  InSample)
inline

Friends And Related Symbol Documentation

◆ operator*

template<typename SampleType , uint32 Q = (sizeof(SampleType) * 8 - 1)>
TSample< SampleType, Q > operator* ( const TSample< SampleType, Q > &  LHS,
const OtherSampleType RHS 
)
friend

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