TSampleRef | Unreal Engine 5.2 Documentation

API > API/Runtime > API/Runtime/SignalProcessing > API/Runtime/SignalProcessing/DSP

References


Module	SignalProcessing
Header	/Engine/Source/Runtime/SignalProcessing/Public/DSP/Dsp.h
Include	#include "DSP/Dsp.h"

Syntax

template<typename SampleType, uint32 Q>  
class TSampleRef

Remarks

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;

Constructors

	Type	Name	Description
		TSampleRef ( SampleType& InSample )

Functions

	Type	Name	Description
	ReturnType	AsFixedPrecisionInt ()
	ReturnType	AsFloat ()

Operators

	Type	Name	Description
	TSampleRef< SampleType, Q > &	operator= ( const OtherSampleType InSample )

Constants

Name	Description
MaxValue	For fixed precision types, the max and min values that we can represent are calculated here:
MinValue
QFactor	This is the number used to convert from float to our fixed precision value.

Navigation