Struct rytm_rs::object::sound::page::Filter

pub struct Filter { /* private fields */ }

Represents parameters in the filter page of a sound.

Implementations

impl Filter

pub fn set_attack(&mut self, attack: usize) -> Result<(), RytmError>

Sets the attack of the filter envelope.

Range: 0..=127

pub fn set_sustain(&mut self, sustain: usize) -> Result<(), RytmError>

Sets the sustain of the filter envelope.

Range: 0..=127

pub fn set_decay(&mut self, decay: usize) -> Result<(), RytmError>

Sets the decay of the filter envelope.

Range: 0..=127

pub fn set_release(&mut self, release: usize) -> Result<(), RytmError>

Sets the release of the filter envelope.

Range: 0..=127

pub fn set_cutoff(&mut self, cutoff: usize) -> Result<(), RytmError>

Sets the cutoff of the filter.

Range: 0..=127

pub fn set_resonance(&mut self, resonance: usize) -> Result<(), RytmError>

Sets the resonance of the filter.

Range: 0..=127

pub fn set_filter_type(&mut self, filter_type: FilterType)

Sets the filter type.

pub fn set_envelope_amount( &mut self, envelope_amount: isize ) -> Result<(), RytmError>

Sets the envelope amount of the filter.

Range: -64..=63

pub const fn attack(&self) -> usize

Returns the attack of the filter envelope.

Range: 0..=127

pub const fn sustain(&self) -> usize

Returns the sustain of the filter envelope.

Range: 0..=127

pub const fn decay(&self) -> usize

Returns the decay of the filter envelope.

Range: 0..=127

pub const fn release(&self) -> usize

Returns the release of the filter envelope.

Range: 0..=127

pub const fn cutoff(&self) -> usize

Returns the cutoff of the filter.

Range: 0..=127

pub const fn resonance(&self) -> usize

Returns the resonance of the filter.

Range: 0..=127

pub const fn filter_type(&self) -> FilterType

Returns the filter type.

pub const fn envelope_amount(&self) -> isize

Returns the envelope amount of the filter.

Range: -64..=63

Trait Implementations

impl Clone for Filter

fn clone(&self) -> Filter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Filter

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

Formats the value using the given formatter.

impl Default for Filter

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Filter

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Filter

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 Filter

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

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

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

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 Filter

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 Filter

impl Eq for Filter

impl StructuralEq for Filter

impl StructuralPartialEq for Filter