Struct playdate_sys::ffi::playdate_sound_lfo

#[repr(C)]
pub struct playdate_sound_lfo {

    pub newLFO: Option<unsafe extern "C" fn(type_: LFOType) -> *mut PDSynthLFO>,
    pub freeLFO: Option<unsafe extern "C" fn(lfo: *mut PDSynthLFO)>,
    pub setType: Option<unsafe extern "C" fn(lfo: *mut PDSynthLFO, type_: LFOType)>,
    pub setRate: Option<unsafe extern "C" fn(lfo: *mut PDSynthLFO, rate: c_float)>,
    pub setPhase: Option<unsafe extern "C" fn(lfo: *mut PDSynthLFO, phase: c_float)>,
    pub setCenter: Option<unsafe extern "C" fn(lfo: *mut PDSynthLFO, center: c_float)>,
    pub setDepth: Option<unsafe extern "C" fn(lfo: *mut PDSynthLFO, depth: c_float)>,
    pub setArpeggiation: Option<unsafe extern "C" fn(lfo: *mut PDSynthLFO, nSteps: c_int, steps: *mut c_float)>,
    pub setFunction: Option<unsafe extern "C" fn(lfo: *mut PDSynthLFO, lfoFunc: Option<unsafe extern "C" fn(lfo: *mut PDSynthLFO, userdata: *mut c_void) -> c_float>, userdata: *mut c_void, interpolate: c_int)>,
    pub setDelay: Option<unsafe extern "C" fn(lfo: *mut PDSynthLFO, holdoff: c_float, ramptime: c_float)>,
    pub setRetrigger: Option<unsafe extern "C" fn(lfo: *mut PDSynthLFO, flag: c_int)>,
    pub getValue: Option<unsafe extern "C" fn(lfo: *mut PDSynthLFO) -> c_float>,
    pub setGlobal: Option<unsafe extern "C" fn(lfo: *mut PDSynthLFO, global: c_int)>,
    pub setStartPhase: Option<unsafe extern "C" fn(lfo: *mut PDSynthLFO, phase: c_float)>,
}

Fields

newLFO: Option<unsafe extern "C" fn(type_: LFOType) -> *mut PDSynthLFO>

PDSynthLFO* playdate->sound->lfo->newLFO(LFOType type)

Returns a new LFO object, which can be used to modulate sounds. The type argument is one of the following values:

LFOType

typedef enum
{
	kLFOTypeSquare,
	kLFOTypeTriangle,
	kLFOTypeSine,
	kLFOTypeSampleAndHold,
	kLFOTypeSawtoothUp,
	kLFOTypeSawtoothDown,
	kLFOTypeArpeggiator,
	kLFOTypeFunction
} LFOType;

freeLFO: Option<unsafe extern "C" fn(lfo: *mut PDSynthLFO)>

void playdate->sound->lfo->freeLFO(PDSynthLFO* lfo)

Frees the LFO.

setType: Option<unsafe extern "C" fn(lfo: *mut PDSynthLFO, type_: LFOType)>

void playdate->sound->lfo->setType(PDSynthLFO* lfo, LFOType type)

Sets the LFO shape to one of the values given above.

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

void playdate->sound->lfo->setRate(PDSynthLFO* lfo, float rate)

Sets the LFO’s rate, in cycles per second.

setPhase: Option<unsafe extern "C" fn(lfo: *mut PDSynthLFO, phase: c_float)>

void playdate->sound->lfo->setPhase(PDSynthLFO* lfo, float phase)

Sets the LFO’s phase, from 0 to 1.

setCenter: Option<unsafe extern "C" fn(lfo: *mut PDSynthLFO, center: c_float)>

void playdate->sound->lfo->setCenter(PDSynthLFO* lfo, float center)

Sets the center value for the LFO.

setDepth: Option<unsafe extern "C" fn(lfo: *mut PDSynthLFO, depth: c_float)>

void playdate->sound->lfo->setDepth(PDSynthLFO* lfo, float depth)

Sets the depth of the LFO.

setArpeggiation: Option<unsafe extern "C" fn(lfo: *mut PDSynthLFO, nSteps: c_int, steps: *mut c_float)>

void playdate->sound->lfo->setArpeggiation(PDSynthLFO* lfo, int nSteps, float* steps)

Sets the LFO type to arpeggio, where the given values are in half-steps from the center note. For example, the sequence (0, 4, 7, 12) plays the notes of a major chord.

setFunction: Option<unsafe extern "C" fn(lfo: *mut PDSynthLFO, lfoFunc: Option<unsafe extern "C" fn(lfo: *mut PDSynthLFO, userdata: *mut c_void) -> c_float>, userdata: *mut c_void, interpolate: c_int)>

void playdate->sound->lfo->setFunction(PDSynthLFO* lfo, float (*lfoFunc)(PDSynthLFO* lfo, void* userdata), void* userdata, int interpolate)

Provides a custom function for LFO values.

setDelay: Option<unsafe extern "C" fn(lfo: *mut PDSynthLFO, holdoff: c_float, ramptime: c_float)>

void playdate->sound->lfo->setDelay(PDSynthLFO* lfo, float holdoff, float ramptime)

Sets an initial holdoff time for the LFO where the LFO remains at its center value, and a ramp time where the value increases linearly to its maximum depth. Values are in seconds.

setRetrigger: Option<unsafe extern "C" fn(lfo: *mut PDSynthLFO, flag: c_int)>

void playdate->sound->lfo->setRetrigger(PDSynthLFO* lfo, int flag)

If retrigger is on, the LFO’s phase is reset to its initial phase (default 0) when a synth using the LFO starts playing a note.

getValue: Option<unsafe extern "C" fn(lfo: *mut PDSynthLFO) -> c_float>

float playdate->sound->lfo->getValue(PDSynthLFO* lfo)

Return the current output value of the LFO.

setGlobal: Option<unsafe extern "C" fn(lfo: *mut PDSynthLFO, global: c_int)>

void playdate->sound->lfo->setGlobal(PDSynthLFO* lfo, int global)

If global is set, the LFO is continuously updated whether or not it’s currently in use.

setStartPhase: Option<unsafe extern "C" fn(lfo: *mut PDSynthLFO, phase: c_float)>

void playdate->sound->lfo->setStartPhase(PDSynthLFO* lfo, float phase)

Sets the LFO’s initial phase, from 0 to 1.

Trait Implementations

impl Clone for playdate_sound_lfo

fn clone(&self) -> playdate_sound_lfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for playdate_sound_lfo

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

Formats the value using the given formatter.

impl Default for playdate_sound_lfo

fn default() -> playdate_sound_lfo

Returns the “default value” for a type.

impl Hash for playdate_sound_lfo

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_lfo

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

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

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

impl Eq for playdate_sound_lfo

impl StructuralPartialEq for playdate_sound_lfo

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