HarmonicSquareUnit< SampleType > Class Template Reference

Harmonic square wave oscillator. More...

List of all members.

Static Public Member Functions
static UnitType	ar (FrequencyUnitType const &frequency=FrequencyType(440), UnitType const &mul=SampleType(1), UnitType const &add=SampleType(0), const int numHarmonics=21, BlockSize const &preferredBlockSize=BlockSize::getDefault(), SampleRate const &preferredSampleRate=SampleRate::getDefault()) throw ()
	Create an audio rate harmonic square wave oscillator.
static UnitType	kr (FrequencyUnitType const &frequency, UnitType const &mul=SampleType(1), UnitType const &add=SampleType(0), const int numHarmonics=21) throw ()
	Create a control rate harmonic square wave oscillator.

---

Detailed Description

template<class SampleType>
class HarmonicSquareUnit< SampleType >

Harmonic square wave oscillator.

Factory functions:

• ar (frequency=440, mul=1, add=0, numHarmonics=21, preferredBlockSize=default, preferredSampleRate=default)
• kr (frequency=440, mul=1, add=0, numHarmonics=21)

Inputs:

• frequency: (unit, multi) the frequency of the oscillator in Hz
• mul: (unit, multi) the multiplier applied to the output
• add: (unit, multi) the offset aded to the output
• numHarmonics: (int) the number of harmonics to generate
• preferredBlockSize: the preferred output block size (for advanced usage, leave on default if unsure)
• preferredSampleRate: the preferred output sample rate (for advanced usage, leave on default if unsure)

See also:

TableUnit

---

Member Function Documentation

template<class SampleType >

static UnitType HarmonicSquareUnit< SampleType >::ar	(	FrequencyUnitType const &	frequency = FrequencyType (440),
		UnitType const &	mul = SampleType (1),
		UnitType const &	add = SampleType (0),
		const int	numHarmonics = 21,
		BlockSize const &	preferredBlockSize = BlockSize::getDefault(),
		SampleRate const &	preferredSampleRate = SampleRate::getDefault()
	)		throw () [inline, static]

Create an audio rate harmonic square wave oscillator.

template<class SampleType >

static UnitType HarmonicSquareUnit< SampleType >::kr	(	FrequencyUnitType const &	frequency,
		UnitType const &	mul = SampleType (1),
		UnitType const &	add = SampleType (0),
		const int	numHarmonics = 21
	)		throw () [inline, static]

Create a control rate harmonic square wave oscillator.

---

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

• plonk_Table.h