juce::dsp::Phase< Type > Struct Template Reference

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

#include "juce_Phase.h"

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

Public Attributes
Type	phase

Detailed Description

template<typename Type>
struct juce::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.

@tags{DSP}

Definition at line 38 of file juce_Phase.h.

Member Function Documentation

advance()

template<typename Type >

Type juce::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).

Definition at line 47 of file juce_Phase.h.

reset()

template<typename Type >

void juce::dsp::Phase< Type >::reset ( )

noexcept

Resets the phase to 0.

Definition at line 41 of file juce_Phase.h.

Member Data Documentation

phase

template<typename Type >

Type juce::dsp::Phase< Type >::phase

Definition at line 61 of file juce_Phase.h.

---

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

• juce_dsp/maths/juce_Phase.h