Struct playdate_sys::ffi::playdate_sound_sampleplayer

#[repr(C)]
pub struct playdate_sound_sampleplayer {

    pub newPlayer: Option<unsafe extern "C" fn() -> *mut SamplePlayer>,
    pub freePlayer: Option<unsafe extern "C" fn(player: *mut SamplePlayer)>,
    pub setSample: Option<unsafe extern "C" fn(player: *mut SamplePlayer, sample: *mut AudioSample)>,
    pub play: Option<unsafe extern "C" fn(player: *mut SamplePlayer, repeat: c_int, rate: c_float) -> c_int>,
    pub isPlaying: Option<unsafe extern "C" fn(player: *mut SamplePlayer) -> c_int>,
    pub stop: Option<unsafe extern "C" fn(player: *mut SamplePlayer)>,
    pub setVolume: Option<unsafe extern "C" fn(player: *mut SamplePlayer, left: c_float, right: c_float)>,
    pub getVolume: Option<unsafe extern "C" fn(player: *mut SamplePlayer, left: *mut c_float, right: *mut c_float)>,
    pub getLength: Option<unsafe extern "C" fn(player: *mut SamplePlayer) -> c_float>,
    pub setOffset: Option<unsafe extern "C" fn(player: *mut SamplePlayer, offset: c_float)>,
    pub setRate: Option<unsafe extern "C" fn(player: *mut SamplePlayer, rate: c_float)>,
    pub setPlayRange: Option<unsafe extern "C" fn(player: *mut SamplePlayer, start: c_int, end: c_int)>,
    pub setFinishCallback: Option<unsafe extern "C" fn(player: *mut SamplePlayer, callback: sndCallbackProc, userdata: *mut c_void)>,
    pub setLoopCallback: Option<unsafe extern "C" fn(player: *mut SamplePlayer, callback: sndCallbackProc, userdata: *mut c_void)>,
    pub getOffset: Option<unsafe extern "C" fn(player: *mut SamplePlayer) -> c_float>,
    pub getRate: Option<unsafe extern "C" fn(player: *mut SamplePlayer) -> c_float>,
    pub setPaused: Option<unsafe extern "C" fn(player: *mut SamplePlayer, flag: c_int)>,
}

Fields

newPlayer: Option<unsafe extern "C" fn() -> *mut SamplePlayer>

SamplePlayer* playdate->sound->sampleplayer->newPlayer(void)

Allocates and returns a new SamplePlayer.

freePlayer: Option<unsafe extern "C" fn(player: *mut SamplePlayer)>

void playdate->sound->sampleplayer->freePlayer(SamplePlayer* player)

Frees the given player.

setSample: Option<unsafe extern "C" fn(player: *mut SamplePlayer, sample: *mut AudioSample)>

void playdate->sound->sampleplayer->setSample(SamplePlayer* player, AudioSample* sample)

Assigns sample to player.

play: Option<unsafe extern "C" fn(player: *mut SamplePlayer, repeat: c_int, rate: c_float) -> c_int>

int playdate->sound->sampleplayer->play(SamplePlayer* player, int repeat, float rate)

Starts playing the sample in player.

If repeat is greater than one, it loops the given number of times. If zero, it loops endlessly until it is stopped with playdate->sound->sampleplayer->stop(). If negative one, it does ping-pong looping.

rate is the playback rate for the sample; 1.0 is normal speed, 0.5 is down an octave, 2.0 is up an octave, etc.

Returns 1 on success (which is always, currently).

isPlaying: Option<unsafe extern "C" fn(player: *mut SamplePlayer) -> c_int>

int playdate->sound->sampleplayer->isPlaying(SamplePlayer* player)

Returns one if player is playing a sample, zero if not.

stop: Option<unsafe extern "C" fn(player: *mut SamplePlayer)>

void playdate->sound->sampleplayer->stop(SamplePlayer* player)

Stops playing the sample.

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

void playdate->sound->sampleplayer->setVolume(SamplePlayer* player, float left, float right)

Sets the playback volume for left and right channels.

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

void playdate->sound->sampleplayer->getVolume(SamplePlayer* player, float* outleft, float* outright)

Gets the current left and right channel volume of the sampleplayer.

getLength: Option<unsafe extern "C" fn(player: *mut SamplePlayer) -> c_float>

float playdate->sound->sampleplayer->getLength(SamplePlayer* player)

Returns the length, in seconds, of the sample assigned to player.

setOffset: Option<unsafe extern "C" fn(player: *mut SamplePlayer, offset: c_float)>

void playdate->sound->sampleplayer->setOffset(SamplePlayer* player, float offset)

Sets the current offset of the SamplePlayer, in seconds.

setRate: Option<unsafe extern "C" fn(player: *mut SamplePlayer, rate: c_float)>

void playdate->sound->sampleplayer->setRate(SamplePlayer* player, float rate)

Sets the playback rate for the player. 1.0 is normal speed, 0.5 is down an octave, 2.0 is up an octave, etc. A negative rate produces backwards playback for PCM files, but does not work for ADPCM-encoded files.

setPlayRange: Option<unsafe extern "C" fn(player: *mut SamplePlayer, start: c_int, end: c_int)>

void playdate->sound->sampleplayer->setPlayRange(SamplePlayer* player, int start, int end)

When used with a repeat of -1, does ping-pong looping, with a start and end position in frames.

setFinishCallback: Option<unsafe extern "C" fn(player: *mut SamplePlayer, callback: sndCallbackProc, userdata: *mut c_void)>

void playdate->sound->sampleplayer->setFinishCallback(SamplePlayer* player, sndCallbackProc callback, void* userdata)

Sets a function to be called when playback has completed. See sndCallbackProc.

setLoopCallback: Option<unsafe extern "C" fn(player: *mut SamplePlayer, callback: sndCallbackProc, userdata: *mut c_void)>

getOffset: Option<unsafe extern "C" fn(player: *mut SamplePlayer) -> c_float>

float playdate->sound->sampleplayer->getOffset(SamplePlayer* player);

Returns the current offset in seconds for player.

getRate: Option<unsafe extern "C" fn(player: *mut SamplePlayer) -> c_float>

float playdate->sound->sampleplayer->getRate(SamplePlayer* player)

Returns the playback rate for player.

setPaused: Option<unsafe extern "C" fn(player: *mut SamplePlayer, flag: c_int)>

void playdate->sound->sampleplayer->setPaused(SamplePlayer* player, int paused)

Pauses or resumes playback.

Trait Implementations

impl Clone for playdate_sound_sampleplayer

fn clone(&self) -> playdate_sound_sampleplayer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for playdate_sound_sampleplayer

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

Formats the value using the given formatter.

impl Default for playdate_sound_sampleplayer

fn default() -> playdate_sound_sampleplayer

Returns the “default value” for a type.

impl Hash for playdate_sound_sampleplayer

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_sampleplayer

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

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

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

impl Eq for playdate_sound_sampleplayer

impl StructuralPartialEq for playdate_sound_sampleplayer

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