Struct Note 

pub struct Note {
    pub pitch: u8,
    pub wave: u8,
    pub volume: u8,
    pub effect: u8,
}

One step of an SFX: pitch (0..64, where 33 = A-4 = 440 Hz), waveform, volume (0..8, 0 = silent) and effect.

Fields

pitch: u8

wave: u8

Timbre, packed like PICO-8’s SFX waveform nibble: bits 0-2 are the index and bit 3 is the custom-instrument flag. With the flag clear, the index (0..8) picks a built-in Waveform; with it set, the index names another SFX slot (0..8) used as a custom instrument. Use Note::instrument / Note::wave_index rather than reading the raw bits.

volume: u8

effect: u8

Implementations

impl Note

pub fn wave_index(&self) -> u8

The waveform/instrument index (0..8), with the custom-instrument flag stripped off.

pub fn instrument(&self) -> Option<u8>

Some(slot) when this note plays SFX slot (0..8) as a custom instrument; None when it uses a built-in waveform.

Trait Implementations

impl Clone for Note

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Note

impl Debug for Note

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Note

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Note

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Note

impl From<Note> for [u8; 4]

fn from(n: Note) -> Self

Converts to this type from the input type.

impl From<[u8; 4]> for Note

fn from([pitch, wave, volume, effect]: [u8; 4]) -> Self

Converts to this type from the input type.

impl PartialEq for Note

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Note

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Note