Burger::Sequencer::Command_t Struct Reference

A buffer describing a single note. More...

Public Types
enum	eEffect {   EFFECT_ARPEGGIO = 0 , EFFECT_DOWNSLIDE = 1 , EFFECT_UPSLIDE = 2 , EFFECT_PORTAMENTO = 3 ,   EFFECT_VIBRATO = 4 , EFFECT_PORTASLIDE = 5 , EFFECT_VIBRATOSLIDE = 6 , EFFECT_NONE = 7 ,   EFFECT_PANNING = 8 , EFFECT_OFFSET = 9 , EFFECT_SLIDEVOLUME = 10 , EFFECT_FASTSKIP = 11 ,   EFFECT_VOLUME = 12 , EFFECT_SKIP = 13 , EFFECT_EXTENDED = 14 , EFFECT_SPEED = 15 }
enum	eVolumeCommand { VOLUME_MIN = 0 , VOLUME_MAX = 254 , VOLUME_UNUSED = 255 }

Public Member Functions
void	Clear (void)
	Initialize the structure.
eNote	GetNote (void) const
	Get the note.
eVolumeCommand	GetVolume (void) const
	Get the volume.
eEffect	GetEffect (void) const
	Get the effect command.
void	SetEffect (eEffect uEffectCommand)

Public Attributes
uint8_t	m_uNote
	eNote value
uint8_t	m_uInstrument
	Instrument attached to the command (0 is no instrument)
uint8_t	m_uVolume
	Volume command (255 = no command)
uint8_t	m_uEffectCommand
	eEffect Command enumeration
uint8_t	m_uEffectArgument
	Argument for the above effect command.

Detailed Description

A buffer describing a single note.

---

For every note played, one of these structures exist to describe it

See also

PatternData_t

Member Enumeration Documentation

eEffect

enum Burger::Sequencer::Command_t::eEffect

Enumerator
EFFECT_ARPEGGIO
EFFECT_DOWNSLIDE
EFFECT_UPSLIDE
EFFECT_PORTAMENTO
EFFECT_VIBRATO
EFFECT_PORTASLIDE
EFFECT_VIBRATOSLIDE
EFFECT_NONE
EFFECT_PANNING
EFFECT_OFFSET
EFFECT_SLIDEVOLUME
EFFECT_FASTSKIP
EFFECT_VOLUME
EFFECT_SKIP
EFFECT_EXTENDED
EFFECT_SPEED

eVolumeCommand

enum Burger::Sequencer::Command_t::eVolumeCommand

Enumerator
VOLUME_MIN
VOLUME_MAX
VOLUME_UNUSED

Member Function Documentation

Clear()

void BURGER_API Burger::Sequencer::Command_t::Clear

(

void

)

Initialize the structure.

---

Initialize all entries for an unused command

GetEffect()

eEffect Burger::Sequencer::Command_t::GetEffect ( void ) const

inline

Get the effect command.

---

Returns

Returns the eEffect constant

GetNote()

eNote Burger::Sequencer::Command_t::GetNote ( void ) const

inline

Get the note.

---

Returns

Returns the eNote constant

GetVolume()

eVolume Burger::Sequencer::Command_t::GetVolume ( void ) const

inline

Get the volume.

---

Returns

Returns the eVolume constant

SetEffect()

void Burger::Sequencer::Command_t::SetEffect ( eEffect uEffectCommand )

inline

Member Data Documentation

m_uEffectArgument

uint8_t Burger::Sequencer::Command_t::m_uEffectArgument

Argument for the above effect command.

m_uEffectCommand

uint8_t Burger::Sequencer::Command_t::m_uEffectCommand

eEffect Command enumeration

m_uInstrument

uint8_t Burger::Sequencer::Command_t::m_uInstrument

Instrument attached to the command (0 is no instrument)

m_uNote

uint8_t Burger::Sequencer::Command_t::m_uNote

eNote value

m_uVolume

uint8_t Burger::Sequencer::Command_t::m_uVolume

Volume command (255 = no command)