Struct rytm_rs::object::sound::page::Lfo

pub struct Lfo { /* private fields */ }

Represents parameters in the lfo page of a sound.

Implementations

impl Lfo

pub fn set_speed(&mut self, speed: isize) -> Result<(), RytmError>

Sets the speed of the LFO.

Range: -64..=63

pub fn set_multiplier(&mut self, multiplier: LfoMultiplier)

Sets the multiplier of the LFO.

pub fn set_fade(&mut self, fade: isize) -> Result<(), RytmError>

Sets the fade of the LFO.

Range: -64..=63

pub fn set_destination(&mut self, destination: LfoDestination)

Sets the destination of the LFO.

pub fn set_waveform(&mut self, waveform: LfoWaveform)

Sets the waveform of the LFO.

pub fn set_depth(&mut self, depth: f32) -> Result<(), RytmError>

Sets the depth of the LFO.

Range: -128.0..=127.99

pub fn set_start_phase( &mut self, start_phase_or_slew: usize ) -> Result<(), RytmError>

Sets the start phase of the LFO.

Range: 0..=127

pub fn set_mode(&mut self, mode: LfoMode)

Sets the mode of the LFO.

pub const fn speed(&self) -> isize

Returns the speed of the LFO.

Range: -64..=63

pub const fn multiplier(&self) -> LfoMultiplier

Returns the multiplier of the LFO.

pub const fn fade(&self) -> isize

Returns the fade of the LFO.

Range: -64..=63

pub const fn destination(&self) -> LfoDestination

Returns the destination of the LFO.

pub const fn waveform(&self) -> LfoWaveform

Returns the waveform of the LFO.

pub const fn start_phase_or_slew(&self) -> usize

Returns the start phase of the LFO.

Range: 0..=127

pub const fn mode(&self) -> LfoMode

Returns the mode of the LFO.

pub const fn depth(&self) -> f32

Returns the depth of the LFO.

Range: -128.0..=127.99

Trait Implementations

impl Clone for Lfo

fn clone(&self) -> Lfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Lfo

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

Formats the value using the given formatter.

impl Default for Lfo

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Lfo

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Lfo

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

fn partial_cmp(&self, other: &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 Serialize for Lfo

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&ar_sound_t> for Lfo

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(raw_sound: &ar_sound_t) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Lfo

impl StructuralPartialEq for Lfo