Struct playdate_sys::ffi::playdate_sound_effect

#[repr(C)]
pub struct playdate_sound_effect {

    pub newEffect: Option<unsafe extern "C" fn(proc_: effectProc, userdata: *mut c_void) -> *mut SoundEffect>,
    pub freeEffect: Option<unsafe extern "C" fn(effect: *mut SoundEffect)>,
    pub setMix: Option<unsafe extern "C" fn(effect: *mut SoundEffect, level: c_float)>,
    pub setMixModulator: Option<unsafe extern "C" fn(effect: *mut SoundEffect, signal: *mut PDSynthSignalValue)>,
    pub getMixModulator: Option<unsafe extern "C" fn(effect: *mut SoundEffect) -> *mut PDSynthSignalValue>,
    pub setUserdata: Option<unsafe extern "C" fn(effect: *mut SoundEffect, userdata: *mut c_void)>,
    pub getUserdata: Option<unsafe extern "C" fn(effect: *mut SoundEffect) -> *mut c_void>,
    pub twopolefilter: *const playdate_sound_effect_twopolefilter,
    pub onepolefilter: *const playdate_sound_effect_onepolefilter,
    pub bitcrusher: *const playdate_sound_effect_bitcrusher,
    pub ringmodulator: *const playdate_sound_effect_ringmodulator,
    pub delayline: *const playdate_sound_effect_delayline,
    pub overdrive: *const playdate_sound_effect_overdrive,
}

Fields

newEffect: Option<unsafe extern "C" fn(proc_: effectProc, userdata: *mut c_void) -> *mut SoundEffect>

SoundEffect* playdate->sound->effect->newEffect(effectProc* proc, void* userdata)

effectProc

typedef int effectProc(SoundEffect* e, int32_t* left, int32_t* right, int nsamples, int bufactive);

Creates a new effect using the given processing function. bufactive is 1 if samples have been set in the left or right buffers. The function should return 1 if it changed the buffer samples, otherwise 0. left and right (if the effect is on a stereo channel) are sample buffers in Q8.24 format.

freeEffect: Option<unsafe extern "C" fn(effect: *mut SoundEffect)>

void playdate->sound->effect->freeEffect(SoundEffect* effect)

Frees the given effect.

setMix: Option<unsafe extern "C" fn(effect: *mut SoundEffect, level: c_float)>

void playdate->sound->effect->setMix(SoundEffect* effect, float level)

Sets the wet/dry mix for the effect. A level of 1 (full wet) replaces the input with the effect output; 0 leaves the effect out of the mix (which is useful if you’re using a delay line with taps and don’t want to hear the delay line itself).

setMixModulator: Option<unsafe extern "C" fn(effect: *mut SoundEffect, signal: *mut PDSynthSignalValue)>

void playdate->sound->effect->setMixModulator(SoundEffect* effect, PDSynthSignalValue* signal)

getMixModulator: Option<unsafe extern "C" fn(effect: *mut SoundEffect) -> *mut PDSynthSignalValue>

PDSynthSignalValue* playdate->sound->effect->getMixModulator(SoundEffect* effect)

Sets or gets a signal to modulate the effect’s mix level.

setUserdata: Option<unsafe extern "C" fn(effect: *mut SoundEffect, userdata: *mut c_void)>

void playdate->sound->effect->setUserdata(SoundEffect* effect, void* userdata)

getUserdata: Option<unsafe extern "C" fn(effect: *mut SoundEffect) -> *mut c_void>

void* playdate->sound->effect->getUserdata(SoundEffect* effect)

Sets or gets a userdata value for the effect.

twopolefilter: *const playdate_sound_effect_twopolefilter

onepolefilter: *const playdate_sound_effect_onepolefilter

bitcrusher: *const playdate_sound_effect_bitcrusher

ringmodulator: *const playdate_sound_effect_ringmodulator

delayline: *const playdate_sound_effect_delayline

overdrive: *const playdate_sound_effect_overdrive

Trait Implementations

impl Clone for playdate_sound_effect

fn clone(&self) -> playdate_sound_effect

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for playdate_sound_effect

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

Formats the value using the given formatter.

impl Default for playdate_sound_effect

fn default() -> Self

Returns the “default value” for a type.

impl Hash for playdate_sound_effect

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_effect

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

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

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

impl Eq for playdate_sound_effect

impl StructuralEq for playdate_sound_effect

impl StructuralPartialEq for playdate_sound_effect

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