Skip to main content

Ramp

Struct Ramp 

Source
pub struct Ramp<C = MonotonicCurveLut256> {
    pub duration_ms: u32,
    pub from: u16,
    pub to: u16,
    pub curve: C,
    pub step: u16,
    pub rounding: Rounding,
    pub min_dt_ms: u32,
    pub lra_frequency_hz: Option<u16>,
    pub lra_frequency_hz_to: Option<u16>,
}
Expand description

A curve-shaped transition from from to to.

Fields§

§duration_ms: u32

Segment duration in milliseconds.

§from: u16

Starting normalized level (0..=u16::MAX).

§to: u16

Ending normalized level (0..=u16::MAX).

§curve: C

Monotonic curve used to shape progress over time.

§step: u16

Output quantization step (minimum 1).

§rounding: Rounding

Quantization rounding mode.

§min_dt_ms: u32

Minimum milliseconds between output changes.

§lra_frequency_hz: Option<u16>

Optional per-segment LRA frequency override.

§lra_frequency_hz_to: Option<u16>

Optional ending LRA frequency for frequency sweeps.

This is used only when Self::lra_frequency_hz also contains the starting frequency; otherwise it is ignored.

Implementations§

Source§

impl<C> Ramp<C>

Source

pub const fn new(duration_ms: u32, from: u16, to: u16, curve: C) -> Self

Build a new ramp segment.

A zero duration_ms is normalized to one millisecond. Direct struct construction does not perform this normalization.

Source

pub const fn with_quantization(self, step: u16, rounding: Rounding) -> Self

Override quantization settings.

A zero step is normalized to 1.

Source

pub const fn with_min_dt(self, min_dt_ms: u32) -> Self

Set a minimum time between consecutive output changes.

Source

pub const fn with_lra_frequency(self, frequency_hz: u16) -> Self

Override LRA frequency for this segment.

Trait Implementations§

Source§

impl<C: Clone> Clone for Ramp<C>

Source§

fn clone(&self) -> Ramp<C>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<C: Copy> Copy for Ramp<C>

Source§

impl<C: Debug> Debug for Ramp<C>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<C> Freeze for Ramp<C>
where C: Freeze,

§

impl<C> RefUnwindSafe for Ramp<C>
where C: RefUnwindSafe,

§

impl<C> Send for Ramp<C>
where C: Send,

§

impl<C> Sync for Ramp<C>
where C: Sync,

§

impl<C> Unpin for Ramp<C>
where C: Unpin,

§

impl<C> UnsafeUnpin for Ramp<C>
where C: UnsafeUnpin,

§

impl<C> UnwindSafe for Ramp<C>
where C: 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> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
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<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
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<Src, Dst> LosslessTryInto<Dst> for Src
where Dst: LosslessTryFrom<Src>,

Source§

fn lossless_try_into(self) -> Option<Dst>

Performs the conversion.
Source§

impl<Src, Dst> LossyInto<Dst> for Src
where Dst: LossyFrom<Src>,

Source§

fn lossy_into(self) -> Dst

Performs the conversion.
Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> StrictAs for T

Source§

fn strict_as<Dst>(self) -> Dst
where T: StrictCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> StrictCastFrom<Src> for Dst
where Src: StrictCast<Dst>,

Source§

fn strict_cast_from(src: Src) -> Dst

Casts the value.
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.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.