Struct Sfx 

pub struct Sfx {
    pub notes: [Note; 32],
    pub speed: u8,
    pub loop_start: u8,
    pub loop_end: u8,
    pub noiz: bool,
    pub buzz: bool,
    pub detune: u8,
    pub reverb: u8,
    pub dampen: u8,
    pub custom_wave: Option<CustomWave>,
}

One sound effect: 32 steps played at a configurable speed.

Fields

notes: [Note; 32]

speed: u8

Duration of one step in 1/128ths of a second (1..=255).

loop_start: u8

Loop start step. Looping is active when loop_end > loop_start.

loop_end: u8

Loop end step (exclusive).

noiz: bool

Per-SFX filter switches, matching PICO-8’s: replace the noise voice with pure white noise.

buzz: bool

Buzzier, harmonically richer timbre.

detune: u8

Detune a second voice against the first. 0 off; 1 a slight, flange-like detune; 2 an octave-ish second voice.

reverb: u8

Echo with a short delay. 0 off; 1/2 are the two delay lengths.

dampen: u8

Low-pass softening. 0 off; 1/2 are the two strengths.

custom_wave: Option<CustomWave>

Some only for slots 0..8 that are drawn-waveform instruments.

Implementations

impl Sfx

pub fn is_empty(&self) -> bool

True when no step is audible — used to skip empty slots.

pub fn set_filters(&mut self, byte: u8)

Set the filter switches from PICO-8’s packed filter byte (the 65th byte of an on-cart SFX): bit 1 noiz, bit 2 buzz, then base-3 digits for detune (÷8), reverb (÷24) and dampen (÷72). Bit 0 is PICO-8’s editor mode and carries no sound, so it is ignored.

pub fn filters_byte(&self) -> u8

PICO-8’s packed filter byte — the inverse of Sfx::set_filters: bit 1 noiz, bit 2 buzz, then base-3 digits for detune (x8), reverb (x24) and dampen (x72). Bit 0 (PICO-8’s editor mode) is always left clear.

Trait Implementations

impl Clone for Sfx

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sfx

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

Formats the value using the given formatter.

impl Default for Sfx

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Sfx

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Sfx

impl PartialEq for Sfx

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Sfx

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 Sfx