FSineWaveTableOsc | Unreal Engine 5.2 Documentation

References


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

class FSineWaveTableOsc

A sinusoidal wave table oscillator class.

Type	Name	Description
float	FrequencyHz	The frequency of the output (given the sample rate)
float	InitialPhase	The initial/cached phase, will be clamped to range 0.0 - 1.0f.
float	InstantaneousPhase	The instantaneous phase, clamped to range 0.0 - 1.0f.
float	PhaseIncrement	The phase increment (based on frequency)
float	ReadIndex	Read index.
float	SampleRate	The sample rate of the oscillator.
const TArray< float > &	WaveTableBuffer	The wave table buffer.

	Type	Name	Description
		FSineWaveTableOsc ()	Constructor.

	Type	Name	Description
		~FSineWaveTableOsc ()	Virtual Destructor.

Type	Name	Description
void	Generate ( float* OutBuffer, const int32 NumSamples )	Processes the wave table and fills a buffer.
float	GetFrequencyHz ()	Returns the frequency of the wave table oscillator.
const TArray< float > &	GetWaveTable ()	The static sinusoidal wave table.
void	Init ( const float InSampleRate, const float InFrequencyHz, const float InPhase )	Initialize the wave table oscillator.
void	Reset ()	Resets the wave table read indices.
void	SetFrequencyHz ( const float InFrequencyHz )	Sets the frequency of the wave table oscillator.
void	SetPhase ( const float InPhase )	Sets the phase of the wave table oscillator.
void	SetSampleRate ( const float InSampleRate )	Sets the sample rate of the oscillator.
void	UpdatePhaseIncrement ()