Struct Waveshaper 

pub struct Waveshaper { /* private fields */ }

A Processor applying a nonlinear waveshaping curve with drive and output gain.

Implementations

impl Waveshaper

pub fn new(shape: Waveshape, drive: f32) -> Self

Creates a waveshaper with the given curve and drive (clamped to >= 0).

pub fn with_output_gain(self, output_gain: f32) -> Self

Returns the waveshaper with its post-curve output gain set.

pub fn process_sample(&self, input: f32) -> f32

Applies the drive, curve, and output gain to one sample.

Trait Implementations

impl Clone for Waveshaper

fn clone(&self) -> Waveshaper

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Waveshaper

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

Formats the value using the given formatter.

impl PartialEq for Waveshaper

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

Equality operator ==.

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

Inequality operator !=.

impl Processor for Waveshaper

fn prepare(&mut self, _cfg: PrepareConfig)

Prepares the processor for a sample rate, block size, and channel layout.

fn reset(&mut self)

Clears any internal state to a fresh start.

fn process(&mut self, block: &mut ProcessBlock<'_>)

Processes one block of audio and events in place.

fn clock_domain(&self) -> ClockDomain

Returns the processor’s clock domain (defaults to sample rate).

fn latency_class(&self) -> LatencyClass

Returns the processor’s latency class (defaults to block-local).

fn realtime_pin(&self) -> bool

Returns whether the processor must run in the realtime thread (defaults to true).

fn ports(&self, in_channels: u16, out_channels: u16) -> Vec<PortDecl>

Returns the processor’s port declarations for the given channel counts (defaults to a single audio in/out pair).

fn descriptor(&self, in_channels: u16, out_channels: u16) -> ProcessorDescriptor

Returns the full ProcessorDescriptor assembled from this processor’s clock, latency, pinning, and ports.

fn tail_frames(&self) -> u64

Returns the processor’s release tail length in frames (defaults to 0).

impl StructuralPartialEq for Waveshaper