Enum surge_modulation::imports::OscillatorParam

pub enum OscillatorParam {
    Type,
    Pitch,
    Octave,
    KeyTrack,
    Retrigger,
}

Variants

Type

Pitch

Octave

KeyTrack

Retrigger

Implementations

impl OscillatorParam

pub fn runtime_array() -> OscillatorParamArray<ParamRT<OscillatorParam>>

impl OscillatorParam

pub const fn count() -> usize

Number of variants in this enumeration.

pub const fn len() -> usize

Number of variants in this enumeration.

pub const fn is_empty() -> bool

pub fn iter() -> impl Iterator<Item = OscillatorParam>

Iterate over all variants in this enum, in sorted order.

pub fn to_str(&self) -> &'static str

Trait Implementations

impl Clone for OscillatorParam

pub fn clone(&self) -> OscillatorParam

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OscillatorParam

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

Formats the value using the given formatter.

impl Display for OscillatorParam

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

Formats the value using the given formatter.

impl Hash for OscillatorParam

pub fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<T> Index<OscillatorParam> for OscillatorParamArray<T>

type Output = T

The returned type after indexing.

pub fn index(
    &self,
    x: OscillatorParam
) -> &<OscillatorParamArray<T> as Index<OscillatorParam>>::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<OscillatorParam> for OscillatorParamArray<T>

pub fn index_mut(
    &mut self,
    x: OscillatorParam
) -> &mut <OscillatorParamArray<T> as Index<OscillatorParam>>::Output

Performs the mutable indexing (container[index]) operation.

impl Ord for OscillatorParam

pub fn cmp(&self, other: &OscillatorParam) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl Param for OscillatorParam

pub fn control_group(&self) -> ControlGroup

fn control_type(&self) -> ControlType

fn control_style(&self) -> ControlStyle

fn default_value(&self) -> PData

fn modulateable(&self) -> bool

fn min_value(&self) -> PData

fn max_value(&self) -> PData

fn value_type(&self) -> ValType

fn moverate(&self) -> f32

fn snap(&self) -> bool

fn extend_range(&self) -> bool

fn affect_other_parameters(&self) -> bool

fn can_temposync(&self) -> bool

fn can_extend_range(&self) -> bool

fn can_be_absolute(&self) -> bool

fn can_snap(&self) -> bool

fn get_modulation_f01(&self, modulation: f32) -> f32

used by the gui to get the position of the modulated handle

fn set_modulation_f01(&self, v: f32) -> f32

used by the gui to set the modulation to match the position of the modulated handle

fn get_extended(&self, f: f32) -> f32

fn get_default_value_f01(&self) -> f32

impl PartialEq<OscillatorParam> for OscillatorParam

pub fn eq(&self, other: &OscillatorParam) -> 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 !=.

impl PartialOrd<OscillatorParam> for OscillatorParam

pub fn partial_cmp(&self, other: &OscillatorParam) -> 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<'_> TryFrom<&'_ str> for OscillatorParam

type Error = &'static str

The type returned in the event of a conversion error.

pub fn try_from(
    value: &str
) -> Result<OscillatorParam, <OscillatorParam as TryFrom<&'_ str>>::Error>

Performs the conversion.

impl TryFrom<u32> for OscillatorParam

type Error = &'static str

The type returned in the event of a conversion error.

pub fn try_from(
    value: u32
) -> Result<OscillatorParam, <OscillatorParam as TryFrom<u32>>::Error>

Performs the conversion.

impl TryFrom<u64> for OscillatorParam

type Error = &'static str

The type returned in the event of a conversion error.

pub fn try_from(
    value: u64
) -> Result<OscillatorParam, <OscillatorParam as TryFrom<u64>>::Error>

Performs the conversion.

impl TryFrom<usize> for OscillatorParam

type Error = &'static str

The type returned in the event of a conversion error.

pub fn try_from(
    value: usize
) -> Result<OscillatorParam, <OscillatorParam as TryFrom<usize>>::Error>

Performs the conversion.

impl Copy for OscillatorParam

impl Eq for OscillatorParam

impl StructuralEq for OscillatorParam

impl StructuralPartialEq for OscillatorParam