Struct playdate_sys::ffi::playdate_sound_track

#[repr(C)]
pub struct playdate_sound_track {

    pub newTrack: Option<unsafe extern "C" fn() -> *mut SequenceTrack>,
    pub freeTrack: Option<unsafe extern "C" fn(track: *mut SequenceTrack)>,
    pub setInstrument: Option<unsafe extern "C" fn(track: *mut SequenceTrack, inst: *mut PDSynthInstrument)>,
    pub getInstrument: Option<unsafe extern "C" fn(track: *mut SequenceTrack) -> *mut PDSynthInstrument>,
    pub addNoteEvent: Option<unsafe extern "C" fn(track: *mut SequenceTrack, step: u32, len: u32, note: MIDINote, velocity: c_float)>,
    pub removeNoteEvent: Option<unsafe extern "C" fn(track: *mut SequenceTrack, step: u32, note: MIDINote)>,
    pub clearNotes: Option<unsafe extern "C" fn(track: *mut SequenceTrack)>,
    pub getControlSignalCount: Option<unsafe extern "C" fn(track: *mut SequenceTrack) -> c_int>,
    pub getControlSignal: Option<unsafe extern "C" fn(track: *mut SequenceTrack, idx: c_int) -> *mut ControlSignal>,
    pub clearControlEvents: Option<unsafe extern "C" fn(track: *mut SequenceTrack)>,
    pub getPolyphony: Option<unsafe extern "C" fn(track: *mut SequenceTrack) -> c_int>,
    pub activeVoiceCount: Option<unsafe extern "C" fn(track: *mut SequenceTrack) -> c_int>,
    pub setMuted: Option<unsafe extern "C" fn(track: *mut SequenceTrack, mute: c_int)>,
    pub getLength: Option<unsafe extern "C" fn(track: *mut SequenceTrack) -> u32>,
    pub getIndexForStep: Option<unsafe extern "C" fn(track: *mut SequenceTrack, step: u32) -> c_int>,
    pub getNoteAtIndex: Option<unsafe extern "C" fn(track: *mut SequenceTrack, index: c_int, outStep: *mut u32, outLen: *mut u32, outNote: *mut MIDINote, outVelocity: *mut c_float) -> c_int>,
    pub getSignalForController: Option<unsafe extern "C" fn(track: *mut SequenceTrack, controller: c_int, create: c_int) -> *mut ControlSignal>,
}

Fields

newTrack: Option<unsafe extern "C" fn() -> *mut SequenceTrack>

SequenceTrack* playdate->sound->track->newTrack(void)

Returns a new SequenceTrack.

freeTrack: Option<unsafe extern "C" fn(track: *mut SequenceTrack)>

void playdate->sound->track->freeTrack(SequenceTrack* track)

Frees the SequenceTrack.

setInstrument: Option<unsafe extern "C" fn(track: *mut SequenceTrack, inst: *mut PDSynthInstrument)>

void playdate->sound->track->setInstrument(SequenceTrack* track, PDSynthInstrument* instrument)

getInstrument: Option<unsafe extern "C" fn(track: *mut SequenceTrack) -> *mut PDSynthInstrument>

PDSynthInstrument* playdate->sound->track->getInstrument(SequenceTrack* track)

Sets or gets the PDSynthInstrument assigned to the track.

addNoteEvent: Option<unsafe extern "C" fn(track: *mut SequenceTrack, step: u32, len: u32, note: MIDINote, velocity: c_float)>

void playdate->sound->track->addNoteEvent(SequenceTrack* track, uint32_t step, uint32_t length, MIDINote note, float vel)

Adds a single note event to the track.

removeNoteEvent: Option<unsafe extern "C" fn(track: *mut SequenceTrack, step: u32, note: MIDINote)>

void playdate->sound->track->removeNoteEvent(SequenceTrack* track, uint32_t step, MIDINote note)

Removes the event at step playing note.

clearNotes: Option<unsafe extern "C" fn(track: *mut SequenceTrack)>

void playdate->sound->track->clearNotes(SequenceTrack* track)

Clears all notes from the track.

getControlSignalCount: Option<unsafe extern "C" fn(track: *mut SequenceTrack) -> c_int>

void playdate->sound->track->getControlSignalCount(SequenceTrack* track)

Returns the number of ControlSignal objects in the track.

getControlSignal: Option<unsafe extern "C" fn(track: *mut SequenceTrack, idx: c_int) -> *mut ControlSignal>

void playdate->sound->track->getControlSignal(SequenceTrack* track, int idx)

Returns the ControlSignal at index idx.

clearControlEvents: Option<unsafe extern "C" fn(track: *mut SequenceTrack)>

void playdate->sound->track->clearControlEvents(SequenceTrack* track)

Clears all ControlSignals from the track.

getPolyphony: Option<unsafe extern "C" fn(track: *mut SequenceTrack) -> c_int>

int playdate->sound->track->getPolyphony(SequenceTrack* track)

Returns the maximum number of simultaneously playing notes in the track. (Currently, this value is only set when the track was loaded from a MIDI file. We don’t yet track polyphony for user-created events.)

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

int playdate->sound->track->activeVoiceCount(SequenceTrack* track)

Returns the number of voices currently playing in the track’s instrument.

setMuted: Option<unsafe extern "C" fn(track: *mut SequenceTrack, mute: c_int)>

void playdate->sound->track->setMuted(SequenceTrack* track, int mute)

Mutes or unmutes the track.

getLength: Option<unsafe extern "C" fn(track: *mut SequenceTrack) -> u32>

int playdate->sound->track->getLength(SequenceTrack* track)

Returns the length, in steps, of the track—​that is, the step where the last note in the track ends.

getIndexForStep: Option<unsafe extern "C" fn(track: *mut SequenceTrack, step: u32) -> c_int>

int playdate->sound->track->getIndexForStep(SequenceTrack* track, uint32_t step)

Returns the internal array index for the first note at the given step.

getNoteAtIndex: Option<unsafe extern "C" fn(track: *mut SequenceTrack, index: c_int, outStep: *mut u32, outLen: *mut u32, outNote: *mut MIDINote, outVelocity: *mut c_float) -> c_int>

int playdate->sound->track->getNoteAtIndex(SequenceTrack* track, int index, uint32_t* outStep, uint32_t* outLen, MIDINote* outNote, float* outVelocity)

If the given index is in range, sets the data in the out pointers and returns 1; otherwise, returns 0.

getSignalForController: Option<unsafe extern "C" fn(track: *mut SequenceTrack, controller: c_int, create: c_int) -> *mut ControlSignal>

void playdate->sound->track->getSignalForController(SequenceTrack* track, int controller, int create)

Returns the ControlSignal for MIDI controller number controller, creating it if the create flag is set and it doesn’t yet exist.

Trait Implementations

impl Clone for playdate_sound_track

fn clone(&self) -> playdate_sound_track

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for playdate_sound_track

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

Formats the value using the given formatter.

impl Default for playdate_sound_track

fn default() -> playdate_sound_track

Returns the “default value” for a type.

impl Hash for playdate_sound_track

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_track

fn cmp(&self, other: &playdate_sound_track) -> 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_track

fn eq(&self, other: &playdate_sound_track) -> 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_track

fn partial_cmp(&self, other: &playdate_sound_track) -> 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_track

impl Eq for playdate_sound_track

impl StructuralPartialEq for playdate_sound_track

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: 68 bytes