Skip to main content

Waveform

Enum Waveform 

Source
pub enum Waveform {
    Sine {
        frequency: f32,
        amplitude: f32,
        phase: f32,
    },
    Sawtooth {
        frequency: f32,
        amplitude: f32,
    },
    Square {
        frequency: f32,
        amplitude: f32,
        duty_cycle: f32,
    },
    Triangle {
        frequency: f32,
        amplitude: f32,
    },
    Noise {
        seed: u32,
        smoothness: f32,
    },
}
Expand description

A procedural scalar waveform.

Variants§

§

Sine

Continuous sine wave.

Fields

§frequency: f32

Cycles per second.

§amplitude: f32

Peak absolute value.

§phase: f32

Phase offset in radians.

§

Sawtooth

Linear ramp from -amplitude to amplitude, then wraps.

Fields

§frequency: f32

Cycles per second.

§amplitude: f32

Peak absolute value.

§

Square

Two-state square wave.

Fields

§frequency: f32

Cycles per second.

§amplitude: f32

Peak absolute value.

§duty_cycle: f32

Fraction of the cycle spent at positive amplitude.

§

Triangle

Triangle wave with linear rise and fall.

Fields

§frequency: f32

Cycles per second.

§amplitude: f32

Peak absolute value.

§

Noise

Deterministic smoothed noise in [-1, 1].

Fields

§seed: u32

Deterministic seed.

§smoothness: f32

Seconds between random control points.

Implementations§

Source§

impl Waveform

Source

pub fn sample(&self, time: f32) -> f32

Evaluate the waveform at an absolute time in seconds.

Trait Implementations§

Source§

impl Clone for Waveform

Source§

fn clone(&self) -> Waveform

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 Copy for Waveform

Source§

impl Debug for Waveform

Source§

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

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

impl PartialEq for Waveform

Source§

fn eq(&self, other: &Waveform) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Waveform

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, 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.