Struct ConvolutionNode 

pub struct ConvolutionNode<const CHANNELS: usize> {
    pub pause: bool,
    pub mix: Mix,
    pub fade_curve: FadeCurve,
    pub wet_gain: Volume,
    pub smooth_seconds: f32,
}

Imparts characteristics of an ImpulseResponse to the input signal.

Convolution is often used to achieve reverb effects, but is more computationally expensive than algorithmic reverb.

Fields

pause: bool

Pause the convolution processing.

This prevents a tail from ringing out when you want all sound to momentarily pause.

mix: Mix

The value representing the mix between the two audio signals

This is a normalized value in the range [0.0, 1.0], where 0.0 is fully the first signal, 1.0 is fully the second signal, and 0.5 is an equal mix of both.

By default this is set to Mix::CENTER.

fade_curve: FadeCurve

The algorithm used to map the normalized mix value in the range [0.0, 1.0] to the corresponding gain values for the two signals.

By default this is set to FadeCurve::EqualPower3dB.

wet_gain: Volume

The gain applied to the resulting convolved signal.

Defaults to -20dB to balance the volume increase likely to occur when convolving audio. Values closer to 1.0 may be very loud.

smooth_seconds: f32

Adjusts the time in seconds over which parameters are smoothed for mix and wet_gain.

Defaults to 0.015 (15ms).

Trait Implementations

impl<const CHANNELS: usize> AudioNode for ConvolutionNode<CHANNELS>

type Configuration = ConvolutionNodeConfig<CHANNELS>

A type representing this constructor’s configuration.

fn info(&self, _configuration: &Self::Configuration) -> AudioNodeInfo

Get information about this node.

fn construct_processor( &self, _configuration: &Self::Configuration, cx: ConstructProcessorContext<'_>, ) -> impl AudioNodeProcessor

Construct a realtime processor for this node.

fn update(&mut self, configuration: &Self::Configuration, cx: UpdateContext<'_>)

If AudioNodeInfo::call_update_method was set to true, then the Firewheel context will call this method on every update cycle.

impl<const CHANNELS: usize> Clone for ConvolutionNode<CHANNELS>

fn clone(&self) -> ConvolutionNode<CHANNELS>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const CHANNELS: usize> Component for ConvolutionNode<CHANNELS>

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl<const CHANNELS: usize> Default for ConvolutionNode<CHANNELS>

fn default() -> Self

Returns the “default value” for a type.

impl<const CHANNELS: usize> Diff for ConvolutionNode<CHANNELS>

where bool: Diff, Mix: Diff, FadeCurve: Diff, Volume: Diff, f32: Diff,

fn diff<__E: EventQueue>( &self, baseline: &Self, path: PathBuilder, event_queue: &mut __E, )

Compare self to baseline and generate events to resolve any differences.

impl<const CHANNELS: usize> PartialEq for ConvolutionNode<CHANNELS>

fn eq(&self, other: &ConvolutionNode<CHANNELS>) -> 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<const CHANNELS: usize> Patch for ConvolutionNode<CHANNELS>

where bool: Patch, Mix: Patch, FadeCurve: Patch, Volume: Patch, f32: Patch,

type Patch = ConvolutionNodePatch<CHANNELS>

A type’s patch.

fn patch(data: &ParamData, path: &[u32]) -> Result<Self::Patch, PatchError>

Construct a patch from a parameter event.

fn apply(&mut self, patch: Self::Patch)

Apply a patch.

fn patch_event(event: &NodeEventType) -> Option<Self::Patch>

Construct a patch from a node event.

impl<const CHANNELS: usize> Copy for ConvolutionNode<CHANNELS>

impl<const CHANNELS: usize> StructuralPartialEq for ConvolutionNode<CHANNELS>