Struct OneShot 

pub struct OneShot { /* private fields */ }

A sample with the settings it should be played at.

Implementations

impl OneShot

pub const fn new(sample: Sample, volume: Volume) -> Self

A one-shot at its own recorded rate, under [Adsr::default_tone].

default_tone rather than percussive: percussive self-fades in about 150 ms, which is most of a quarter-second sound. The cutoff, not the envelope, is what stops this.

pub const fn with_volume(self, volume: Volume) -> Self

Play at a different level. For sounds whose loudness depends on what happened – how hard a hit landed, a volume setting – rather than on which sample it is.

pub const fn with_adsr(self, adsr: Adsr) -> Self

Override the envelope.

pub const fn with_pitch(self, pitch: Pitch) -> Self

Play at an explicit pitch instead of the sample’s own rate. 0x1000 is unity; lower stretches the sound and raises how long it lasts, which OneShot::ticks accounts for.

pub const fn sample(&self) -> Sample

The sample behind this one-shot.

pub const fn ticks(&self, ticks_hz: u32) -> Option<u32>

How long this will sound, in ticks of a ticks_hz clock, with any pitch override applied. None when the sample’s length is unknown.

pub fn configure(&self, voice: Voice)

Point voice at this one-shot without starting it.

Separate from OneShot::play because a program that keeps one voice per sound can set it up once at boot and then only key on. A program sharing voices has to do both together.

pub fn play(&self, voice: Voice)

Key this one-shot on voice.

Volume is set on every key-on rather than once at upload, because the cutoff silences a voice by writing volume 0 and start does not restore it. Omitting this is how the demo disc’s v0.11 pressing ended up with a browse blip that played exactly once and never again.

Trait Implementations

impl Clone for OneShot

fn clone(&self) -> OneShot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for OneShot