Public Member Functions | Public Attributes | List of all members
dsp::Phase< Type > Struct Template Reference

Represents an increasing phase value between 0 and 2*pi. More...

Public Member Functions

void reset () noexcept
 Resets the phase to 0. More...
 
Type advance (Type increment) noexcept
 Returns the current value, and increments the phase by the given increment. More...
 

Public Attributes

Type phase = 0
 

Detailed Description

template<typename Type>
struct dsp::Phase< Type >

Represents an increasing phase value between 0 and 2*pi.

This represents a value which can be incremented, and which wraps back to 0 when it goes past 2 * pi.

Member Function Documentation

◆ reset()

template<typename Type>
void dsp::Phase< Type >::reset ( )
noexcept

Resets the phase to 0.

Referenced by dsp::Oscillator< SampleType >::reset().

◆ advance()

template<typename Type>
Type dsp::Phase< Type >::advance ( Type  increment)
noexcept

Returns the current value, and increments the phase by the given increment.

The increment must be a positive value, it can't go backwards! The new value of the phase after calling this function will be (phase + increment) % (2 * pi).

Referenced by dsp::Oscillator< SampleType >::process(), and dsp::Oscillator< SampleType >::processSample().

Member Data Documentation

◆ phase

template<typename Type>
Type dsp::Phase< Type >::phase = 0

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