ame::SineOscillator< FloatType > Class Template Reference

Sine wave oscillator. More...

#include <ame_Oscillator.hpp>

Public Member Functions
	SineOscillator (FloatType sampleRate) noexcept
	Create sine wave oscillator instance. More...
void	setSampleRate (FloatType sampleRate)
	Set sampling rate. More...
void	setFrequency (FloatType freq) noexcept
	Set the sine wave frequency. More...
float	nextSample () noexcept
	Generate single sample. More...
void	resetPhase (FloatType newPhase=0.0f)
	Reset the phase to any value. More...

Detailed Description

template<std::floating_point FloatType>
class ame::SineOscillator< FloatType >

Sine wave oscillator.

Generates a sine between -1.0~1.0.

Constructor & Destructor Documentation

SineOscillator()

template<std::floating_point FloatType>

ame::SineOscillator< FloatType >::SineOscillator ( FloatType  sampleRate )

inlinenoexcept

Create sine wave oscillator instance.

Parameters

sampleRate	The sample rate that will be used for calculate the oscillator phase increment.
frequency	Initial frequency

Member Function Documentation

nextSample()

template<std::floating_point FloatType>

float ame::SineOscillator< FloatType >::nextSample ( )

inlinenoexcept

Generate single sample.

Returns

generated latest sample

resetPhase()

template<std::floating_point FloatType>

void ame::SineOscillator< FloatType >::resetPhase ( FloatType  newPhase = 0.0f )

inline

Reset the phase to any value.

Parameters

newPhase

[0, 2pi]

setFrequency()

template<std::floating_point FloatType>

void ame::SineOscillator< FloatType >::setFrequency ( FloatType  freq )

inlinenoexcept

Set the sine wave frequency.

Parameters

freq	frequency in Hz

setSampleRate()

template<std::floating_point FloatType>

void ame::SineOscillator< FloatType >::setSampleRate ( FloatType  sampleRate )

inline

Set sampling rate.

Parameters

sampleRate

new sampling rate in Hz

---

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

• include/ame_Oscillator.hpp