Skip to main content

Smoother

Struct Smoother 

Source
pub struct Smoother { /* private fields */ }
Expand description

A parameter value smoother.

Can be used standalone for custom modulation, or integrated into FloatParameter via .with_smoother().

§Thread Safety

Smoother is Send but not Sync - it requires &mut self for advancing state. This is intentional for audio thread usage.

Implementations§

Source§

impl Smoother

Source

pub fn new(style: SmoothingStyle) -> Self

Create a new smoother with the given style.

Sample rate must be set before use via set_sample_rate().

Source

pub fn none() -> Self

Create a smoother with no smoothing (pass-through).

Source

pub fn style(&self) -> SmoothingStyle

Get the smoothing style.

Source

pub fn set_sample_rate(&mut self, sample_rate: f64)

Set the sample rate.

Call this from Processor::setup(). Recomputes coefficients based on time constants.

Source

pub fn set_target(&mut self, target: f64)

Set a new target value.

Call this when the parameter value changes (typically at start of process block).

Source

pub fn reset(&mut self, value: f64)

Reset immediately to a value (no smoothing).

Use when loading state or initializing to avoid ramps.

Source

pub fn tick(&mut self) -> f64

Advance by one sample and return the smoothed value.

Call this once per sample in the audio loop.

Source

pub fn current(&self) -> f64

Get current smoothed value without advancing.

Source

pub fn target(&self) -> f64

Get the target value.

Source

pub fn skip(&mut self, samples: usize)

Skip forward by n samples (for block processing).

This is equivalent to calling tick() n times but may be optimized for some smoothing styles.

Source

pub fn fill(&mut self, buffer: &mut [f64])

Fill a slice with smoothed values (f64).

Source

pub fn fill_f32(&mut self, buffer: &mut [f32])

Fill a slice with smoothed values (f32).

Source

pub fn is_smoothing(&self) -> bool

Returns true if still smoothing toward target.

Trait Implementations§

Source§

impl Clone for Smoother

Source§

fn clone(&self) -> Smoother

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Smoother

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Smoother

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.