TSampleRef | Unreal Engine 5.7 Documentation

API > API/Runtime > API/Runtime/SignalProcessing

TSampleRef Ref version of TSample. Useful for converting between fixed and float precisions. Example usage: int16 FixedPrecisionSample; TSampleRef SampleRef(FixedPrecisionSample);

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

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

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


Name	TSampleRef
Type	class
Header File	/Engine/Source/Runtime/SignalProcessing/Public/DSP/Dsp.h
Include Path	#include "DSP/Dsp.h"

Syntax

template<typename SampleType, uint32 Q>  
class TSampleRef

Constructors

Name	Remarks	Include Path	Unreal Specifiers
TSampleRef ( SampleType& InSample )		DSP/Dsp.h

Constants

Name	Type	Remarks	Include Path
MaxValue	float	For fixed precision types, the max and min values that we can represent are calculated here:	DSP/Dsp.h
MinValue	float		DSP/Dsp.h
QFactor	float	This is the number used to convert from float to our fixed precision value.	DSP/Dsp.h

Variables

Protected

Name	Type	Remarks	Include Path	Unreal Specifiers
Sample	SampleType &		DSP/Dsp.h

Functions

Public

Name	Remarks	Include Path	Unreal Specifiers
ReturnType AsFixedPrecisionInt()		DSP/Dsp.h
ReturnType AsFloat()		DSP/Dsp.h

Static

Name	Remarks	Include Path	Unreal Specifiers
static void CheckValidityOfQ()		DSP/Dsp.h
static void CheckValidityOfSampleType()		DSP/Dsp.h

Operators

Name	Remarks	Include Path	Unreal Specifiers
TSampleRef< SampleType, Q > & operator= ( const OtherSampleType InSample )		DSP/Dsp.h

Navigation