Mozzi  alpha 0.01.1t
sound synthesis library for Arduino
 All Classes Functions Typedefs
Public Member Functions
Portamento< CONTROL_UPDATE_RATE > Class Template Reference

A simple portamento (pitch slide from one note to the next) effect, useful for note-based applications. More...

List of all members.

Public Member Functions

 Portamento ()
 Constructor.
void setTime (unsigned int milliseconds)
 Set how long it will take to slide from note to note, in milliseconds.
void start (unsigned char note)
 Call this at note-on, it initialises the portamento.
void start (Q16n16 note)
 Call this at note-on, it initialises the portamento.
Q16n16 next ()
 Use this in updateControl() to provide a frequency to the oscillator it's controlling, for example: myOscil.setFreq_Q16n16(myPortamento.next());.

Detailed Description

template<unsigned int CONTROL_UPDATE_RATE>
class Portamento< CONTROL_UPDATE_RATE >

A simple portamento (pitch slide from one note to the next) effect, useful for note-based applications.

Definition at line 33 of file Portamento.h.


Member Function Documentation

template<unsigned int CONTROL_UPDATE_RATE>
Q16n16 Portamento< CONTROL_UPDATE_RATE >::next ( ) [inline]

Use this in updateControl() to provide a frequency to the oscillator it's controlling, for example: myOscil.setFreq_Q16n16(myPortamento.next());.

Returns:
a Q16n16 fractional frequency value, progressing smoothly between successive notes.

Definition at line 82 of file Portamento.h.

template<unsigned int CONTROL_UPDATE_RATE>
void Portamento< CONTROL_UPDATE_RATE >::setTime ( unsigned int  milliseconds) [inline]

Set how long it will take to slide from note to note, in milliseconds.

Parameters:
milliseconds

Definition at line 49 of file Portamento.h.

template<unsigned int CONTROL_UPDATE_RATE>
void Portamento< CONTROL_UPDATE_RATE >::start ( unsigned char  note) [inline]

Call this at note-on, it initialises the portamento.

Parameters:
notea midi note number, a whole number.

Definition at line 58 of file Portamento.h.

template<unsigned int CONTROL_UPDATE_RATE>
void Portamento< CONTROL_UPDATE_RATE >::start ( Q16n16  note) [inline]

Call this at note-on, it initialises the portamento.

Parameters:
notea midi note number in Q16n16 fractional format. This is useful for non-whole note or detuned values.

Definition at line 69 of file Portamento.h.


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