Struct comfy_wgpu::FilterBuilder

pub struct FilterBuilder {
    pub mode: FilterMode,
    pub cutoff: Value<f64>,
    pub resonance: Value<f64>,
    pub mix: Value<f64>,
}

Configures a filter 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.

mode: FilterMode

The frequencies that the filter will remove.

cutoff: Value<f64>

The cutoff frequency of the filter (in hertz).

resonance: Value<f64>

The resonance of the filter.

The resonance is a feedback effect that produces a distinctive “ringing” sound.

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 FilterBuilder

pub fn new() -> FilterBuilder

Creates a new FilterBuilder with the default settings.

pub fn mode(self, mode: FilterMode) -> FilterBuilder

Sets the frequencies that the filter will remove.

pub fn cutoff(self, cutoff: impl Into<Value<f64>>) -> FilterBuilder

Sets the cutoff frequency of the filter (in hertz).

pub fn resonance(self, resonance: impl Into<Value<f64>>) -> FilterBuilder

Sets the resonance of the filter.

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

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 FilterBuilder

fn clone(&self) -> FilterBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FilterBuilder

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

Formats the value using the given formatter.

impl Default for FilterBuilder

fn default() -> FilterBuilder

Returns the “default value” for a type.

impl EffectBuilder for FilterBuilder

type Handle = FilterHandle

Allows the user to control the effect from gameplay code.

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

Creates the effect and a handle to the effect.

impl PartialEq<FilterBuilder> for FilterBuilder

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for FilterBuilder

impl StructuralPartialEq for FilterBuilder