Struct SmoothedValue

Source
pub struct SmoothedValue<S: Sample, T: SmoothingStrategy> { /* private fields */ }
Expand description

A value that smoothly transitions to a target over time.

Uses the specified SmoothingStrategy to interpolate between values, avoiding clicks and pops when parameters change.

Generic over S: Sample for the value type and T: SmoothingStrategy for the interpolation method.

Implementations§

Source§

impl<S: Sample, T: SmoothingStrategy> SmoothedValue<S, T>

Source

pub fn new(initial_value: S) -> Self

Create a new SmoothedValue with the given initial value.

Uses default sample rate (44100.0) and ramp length (50ms).

Source

pub fn reset(&mut self, sample_rate: f64, ramp_length_millis: f64)

Reset the sample rate and ramp length.

This recalculates the increment based on the new timing parameters. A minimum ramp length of 0.01ms is enforced to prevent clicks.

Source

pub fn set_target_value(&mut self, value: S)

Set a new target value to smooth towards.

Source

pub fn get_next_value(&mut self) -> S

Get the next smoothed value (call once per sample).

Source

pub fn skip(&mut self, num_samples: i32)

Skip ahead by the specified number of samples.

Source

pub fn current(&self) -> S

Get the current value without advancing.

Source

pub fn target(&self) -> S

Get the target value.

Source

pub fn is_smoothing(&self) -> bool

Check if the value is still smoothing towards the target.

Source

pub fn set_immediate(&mut self, value: S)

Immediately set both current and target to a value (no smoothing).

Trait Implementations§

Source§

impl<S: Clone + Sample, T: Clone + SmoothingStrategy> Clone for SmoothedValue<S, T>

Source§

fn clone(&self) -> SmoothedValue<S, T>

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<S: Debug + Sample, T: Debug + SmoothingStrategy> Debug for SmoothedValue<S, T>

Source§

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

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

impl<S: Sample, T: SmoothingStrategy> Default for SmoothedValue<S, T>

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<S, T> Freeze for SmoothedValue<S, T>
where S: Freeze,

§

impl<S, T> RefUnwindSafe for SmoothedValue<S, T>

§

impl<S, T> Send for SmoothedValue<S, T>
where T: Send,

§

impl<S, T> Sync for SmoothedValue<S, T>
where T: Sync,

§

impl<S, T> Unpin for SmoothedValue<S, T>
where S: Unpin, T: Unpin,

§

impl<S, T> UnwindSafe for SmoothedValue<S, T>
where S: UnwindSafe, T: UnwindSafe,

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.