Struct BaseEffect 

pub struct BaseEffect { /* private fields */ }

Base effect for all other kinds of effects. It contains set of inputs (direct or filtered), provides some basic methods to control them.

Implementations

impl BaseEffect

pub fn gain(&self) -> f32

Returns current gain of effect.

pub fn set_gain(&mut self, gain: f32)

Sets effect gain. It should be in (0;1) range, but larger values still fine - they can be used to achieve “overdrive” effect if needed. Basically this value defines how “loud” effect will be.

pub fn add_filter(&mut self, filter: InputFilter) -> Handle<InputFilter>

Adds new filter to effect and returns its handle. Filter handle then can be used to add input to effect (if it is filtered input).

pub fn add_input(&mut self, input: EffectInput)

Adds new input to effect.

pub fn filter(&self, handle: Handle<InputFilter>) -> &InputFilter

Returns shared reference to filter.

pub fn filter_mut(&mut self, handle: Handle<InputFilter>) -> &mut InputFilter

Returns mutable reference to filter.

Trait Implementations

impl Clone for BaseEffect

fn clone(&self) -> BaseEffect

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BaseEffect

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

Formats the value using the given formatter.

impl Default for BaseEffect

fn default() -> BaseEffect

Returns the “default value” for a type.

impl Visit for BaseEffect

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>