Audio::TSampleRef< SampleType, Q > Class Template Reference

#include <Dsp.h>

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

Friends
template<typename OtherSampleType >
SampleType	operator* (const TSampleRef< SampleType > &LHS, const OtherSampleType &RHS)

Detailed Description

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

TSampleRef<SampleType, Q> Ref version of TSample. Useful for converting between fixed and float precisions. Example usage: int16 FixedPrecisionSample; TSampleRef<int16, 15> SampleRef(FixedPrecisionSample);

// Set the sample value directly: SampleRef = 0.5f;

// Or multiply the the sample: SampleRef *= 0.5f;

bool bThisCodeWorks = FixedPrecisionSample == TNumericLimits<int16>::Max() / 4;

Constructor & Destructor Documentation

TSampleRef()

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

Audio::TSampleRef< SampleType, Q >::TSampleRef ( 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::TSampleRef< SampleType, Q >::AsFixedPrecisionInt ( )

inline

AsFloat()

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

template<typename ReturnType = float>

ReturnType Audio::TSampleRef< SampleType, Q >::AsFloat ( ) const

inline

operator=()

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

template<typename OtherSampleType >

TSampleRef< SampleType, Q > & Audio::TSampleRef< SampleType, Q >::operator= ( const OtherSampleType  InSample )

inline

Friends And Related Symbol Documentation

operator*

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

template<typename OtherSampleType >

SampleType operator* ( const TSampleRef< SampleType > &  LHS, const OtherSampleType &  RHS  )

friend

---

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

• Engine/Source/Runtime/SignalProcessing/Public/DSP/Dsp.h