Struct Instrument 

pub struct Instrument {
    pub synthwave: Option<Synthwave>,
    pub chip: Option<ChipInstrument>,
    pub drum: Option<Drum>,
    pub waveform: Waveform,
    pub envelope: Envelope,
    pub volume: u8,
    pub slide: i32,
    pub vibrato: Option<Vibrato>,
    pub arpeggio: Option<Arpeggio>,
    pub duty_sweep: Option<DutySweep>,
}

The sound of a channel: a waveform, an envelope, a volume and pitch effects.

Fields

synthwave: Option<Synthwave>

Optional polyphonic unison/filter/LFO path. None retains legacy samples.

chip: Option<ChipInstrument>

Opt-in tracker sources, macros and quantization; None keeps legacy samples.

drum: Option<Drum>

A finite synthesized one-shot instead of a melodic oscillator/ADSR.

waveform: Waveform

envelope: Envelope

volume: u8

0 through 15. The default is 15.

slide: i32

Constant pitch slide from the start of each note, in cents per second.

vibrato: Option<Vibrato>

arpeggio: Option<Arpeggio>

duty_sweep: Option<DutySweep>

Only for Waveform::Pulse.

Implementations

impl Instrument

pub fn new(waveform: Waveform) -> Self

The waveform at full volume with the default envelope and no effects.

pub fn drum(settings: Drum) -> Self

A drum at full instrument volume. Configure its envelopes in super::Drum.

pub fn validate(&self) -> Result<()>

Trait Implementations

impl Clone for Instrument

fn clone(&self) -> Instrument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Instrument

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

Formats the value using the given formatter.

impl Default for Instrument

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Instrument

impl Hash for Instrument

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Instrument

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Instrument