Struct ReverbBuilder

#[non_exhaustive]
pub struct ReverbBuilder {
    pub feedback: Value<f64>,
    pub damping: Value<f64>,
    pub stereo_width: Value<f64>,
    pub mix: Value<f64>,
}

Configures a reverb effect.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

feedback: Value<f64>

How much the room reverberates. A higher value will result in a bigger sounding room. 1.0 gives an infinitely reverberating room.

damping: Value<f64>

How quickly high frequencies disappear from the reverberation.

stereo_width: Value<f64>

The stereo width of the reverb effect (0.0 being fully mono, 1.0 being fully stereo).

mix: Value<f64>

How much dry (unprocessed) signal should be blended with the wet (processed) signal. 0.0 means only the dry signal will be heard. 1.0 means only the wet signal will be heard.

Implementations

impl ReverbBuilder

pub fn new() -> ReverbBuilder

Creates a new ReverbBuilder with the default settings.

pub fn feedback(self, feedback: impl Into<Value<f64>>) -> ReverbBuilder

Sets how much the room reverberates. A higher value will result in a bigger sounding room. 1.0 gives an infinitely reverberating room.

pub fn damping(self, damping: impl Into<Value<f64>>) -> ReverbBuilder

Sets how quickly high frequencies disappear from the reverberation.

pub fn stereo_width(self, stereo_width: impl Into<Value<f64>>) -> ReverbBuilder

Sets the stereo width of the reverb effect (0.0 being fully mono, 1.0 being fully stereo).

pub fn mix(self, mix: impl Into<Value<f64>>) -> ReverbBuilder

Sets how much dry (unprocessed) signal should be blended with the wet (processed) signal. 0.0 means only the dry signal will be heard. 1.0 means only the wet signal will be heard.

Trait Implementations

impl Clone for ReverbBuilder

fn clone(&self) -> ReverbBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReverbBuilder

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

Formats the value using the given formatter.

impl Default for ReverbBuilder

fn default() -> ReverbBuilder

Returns the “default value” for a type.

impl EffectBuilder for ReverbBuilder

type Handle = ReverbHandle

Allows the user to control the effect from gameplay code.

fn build(self) -> (Box<dyn Effect>, <ReverbBuilder as EffectBuilder>::Handle)

Creates the effect and a handle to the effect.

impl PartialEq for ReverbBuilder

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for ReverbBuilder

impl StructuralPartialEq for ReverbBuilder