Struct Gain 

pub struct Gain { /* private fields */ }

A Processor that scales every channel by a fixed linear gain.

Examples

use sim_lib_audio_dsp::Gain;

let gain = Gain::new(0.5);
assert_eq!(gain.gain(), 0.5);

Implementations

impl Gain

pub fn new(gain: f32) -> Self

Creates a gain processor with the given linear gain.

pub fn gain(&self) -> f32

Returns the linear gain.

Trait Implementations

impl Clone for Gain

fn clone(&self) -> Gain

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Gain

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

Formats the value using the given formatter.

impl PartialEq for Gain

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

Equality operator ==.

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

Inequality operator !=.

impl Processor for Gain

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 Gain