Struct playdate_sys::ffi::playdate_sound_instrument

#[repr(C)]
pub struct playdate_sound_instrument {

    pub newInstrument: Option<unsafe extern "C" fn() -> *mut PDSynthInstrument>,
    pub freeInstrument: Option<unsafe extern "C" fn(inst: *mut PDSynthInstrument)>,
    pub addVoice: Option<unsafe extern "C" fn(inst: *mut PDSynthInstrument, synth: *mut PDSynth, rangeStart: MIDINote, rangeEnd: MIDINote, transpose: c_float) -> c_int>,
    pub playNote: Option<unsafe extern "C" fn(inst: *mut PDSynthInstrument, frequency: c_float, vel: c_float, len: c_float, when: u32) -> *mut PDSynth>,
    pub playMIDINote: Option<unsafe extern "C" fn(inst: *mut PDSynthInstrument, note: MIDINote, vel: c_float, len: c_float, when: u32) -> *mut PDSynth>,
    pub setPitchBend: Option<unsafe extern "C" fn(inst: *mut PDSynthInstrument, bend: c_float)>,
    pub setPitchBendRange: Option<unsafe extern "C" fn(inst: *mut PDSynthInstrument, halfSteps: c_float)>,
    pub setTranspose: Option<unsafe extern "C" fn(inst: *mut PDSynthInstrument, halfSteps: c_float)>,
    pub noteOff: Option<unsafe extern "C" fn(inst: *mut PDSynthInstrument, note: MIDINote, when: u32)>,
    pub allNotesOff: Option<unsafe extern "C" fn(inst: *mut PDSynthInstrument, when: u32)>,
    pub setVolume: Option<unsafe extern "C" fn(inst: *mut PDSynthInstrument, left: c_float, right: c_float)>,
    pub getVolume: Option<unsafe extern "C" fn(inst: *mut PDSynthInstrument, left: *mut c_float, right: *mut c_float)>,
    pub activeVoiceCount: Option<unsafe extern "C" fn(inst: *mut PDSynthInstrument) -> c_int>,
}

Fields

newInstrument: Option<unsafe extern "C" fn() -> *mut PDSynthInstrument>

PDSynthInstrument* playdate->sound->instrument->newInstrument(void)

Creates a new PDSynthInstrument object.

freeInstrument: Option<unsafe extern "C" fn(inst: *mut PDSynthInstrument)>

void playdate->sound->instrument->freeInstrument(PDSynthInstrument* instrument)

Frees the given instrument, first removing it from the sound engine if needed.

addVoice: Option<unsafe extern "C" fn(inst: *mut PDSynthInstrument, synth: *mut PDSynth, rangeStart: MIDINote, rangeEnd: MIDINote, transpose: c_float) -> c_int>

int playdate->sound->instrument->addVoice(PDSynthInstrument* instrument, PDSynth* synth, MIDINote rangeStart, MIDINote rangeEnd, float transpose)

Adds the given PDSynth to the instrument. The synth will respond to playNote events between rangeState and rangeEnd, inclusive. The transpose argument is in half-step units, and is added to the instrument’s transpose parameter. The function returns 1 if successful, or 0 if the synth is already in another instrument or channel.

playNote: Option<unsafe extern "C" fn(inst: *mut PDSynthInstrument, frequency: c_float, vel: c_float, len: c_float, when: u32) -> *mut PDSynth>

PDSynth* playdate->sound->instrument->playNote(PDSynthInstrument* instrument, float frequency, float vel, float len, uint32_t when)

playMIDINote: Option<unsafe extern "C" fn(inst: *mut PDSynthInstrument, note: MIDINote, vel: c_float, len: c_float, when: u32) -> *mut PDSynth>

PDSynth* playdate->sound->instrument->playMIDINote(PDSynthInstrument* instrument, MIDINote note, float vel, float len, uint32_t when)

The instrument passes the playNote/playMIDINote() event to the synth in its collection that has been off for the longest, or has been playing longest if all synths are currently playing. See also playdate→sound→synth→playNote(). The PDSynth that received the playNote event is returned.

setPitchBend: Option<unsafe extern "C" fn(inst: *mut PDSynthInstrument, bend: c_float)>

void playdate->sound->instrument->setPitchBend(PDSynthInstrument* instrument, float bend)

setPitchBendRange: Option<unsafe extern "C" fn(inst: *mut PDSynthInstrument, halfSteps: c_float)>

void playdate->sound->instrument->setPitchBendRange(PDSynthInstrument* instrument, float halfSteps)

Sets the pitch bend and pitch bend range to be applied to the voices in the instrument.

setTranspose: Option<unsafe extern "C" fn(inst: *mut PDSynthInstrument, halfSteps: c_float)>

void playdate->sound->instrument->setTranspose(PDSynthInstrument* instrument, float halfSteps)

Sets the transpose parameter for all voices in the instrument.

noteOff: Option<unsafe extern "C" fn(inst: *mut PDSynthInstrument, note: MIDINote, when: u32)>

void playdate->sound->instrument->noteOff(PDSynthInstrument* instrument, MIDINote note, uint32_t when)

Forwards the noteOff() event to the synth currently playing the given note. See also playdate→sound→synth→noteOff().

allNotesOff: Option<unsafe extern "C" fn(inst: *mut PDSynthInstrument, when: u32)>

void playdate->sound->instrument->allNotesOff(PDSynthInstrument* instrument, uint32_t when)

Sends a noteOff event to all voices in the instrument.

setVolume: Option<unsafe extern "C" fn(inst: *mut PDSynthInstrument, left: c_float, right: c_float)>

void playdate->sound->instrument->setVolume(PDSynthInstrument* instrument, float lvol, float rvol)

getVolume: Option<unsafe extern "C" fn(inst: *mut PDSynthInstrument, left: *mut c_float, right: *mut c_float)>

void playdate->sound->instrument->getVolume(PDSynthInstrument* instrument, float* outlvol, float* outrvol)

Sets and gets the playback volume (0.0 - 1.0) for left and right channels of the synth. This is equivalent to

playdate->sound->source->setVolume((SoundSource*)instrument, lvol, rvol);
playdate->sound->source->getVolume((SoundSource*)instrument, &lvol, &rvol);

activeVoiceCount: Option<unsafe extern "C" fn(inst: *mut PDSynthInstrument) -> c_int>

int playdate->sound->instrument->activeVoiceCount(PDSynthInstrument* instrument)

Returns the number of voices in the instrument currently playing.

Trait Implementations

impl Clone for playdate_sound_instrument

fn clone(&self) -> playdate_sound_instrument

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for playdate_sound_instrument

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

Formats the value using the given formatter.

impl Default for playdate_sound_instrument

fn default() -> playdate_sound_instrument

Returns the “default value” for a type.

impl Hash for playdate_sound_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 Ord for playdate_sound_instrument

fn cmp(&self, other: &playdate_sound_instrument) -> Ordering

This method returns an [Ordering] between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for playdate_sound_instrument

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for playdate_sound_instrument

fn partial_cmp(&self, other: &playdate_sound_instrument) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for playdate_sound_instrument

impl Eq for playdate_sound_instrument

impl StructuralPartialEq for playdate_sound_instrument

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 52 bytes