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> Debug for ConvolutionNode<CHANNELS>

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

impl<'de, const CHANNELS: usize> Deserialize<'de> for ConvolutionNode<CHANNELS>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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> FromReflect for ConvolutionNode<CHANNELS>

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

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

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

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> PartialReflect for ConvolutionNode<CHANNELS>

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn try_apply(&mut self, value: &dyn PartialReflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<Self>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&dyn Reflect>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut dyn Reflect>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Self>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

fn reflect_partial_eq(&self, value: &dyn PartialReflect) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

fn reflect_clone_and_take<T>(&self) -> Result<T, ReflectCloneError>

where T: 'static, Self: Sized + TypePath,

For a type implementing PartialReflect, combines reflect_clone and take in a useful fashion, automatically constructing an appropriate ReflectCloneError if the downcast fails.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

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> Reflect for ConvolutionNode<CHANNELS>

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable, fully-reflected value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

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

fn field(&self, name: &str) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field named name as a &dyn PartialReflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field named name as a &mut dyn PartialReflect.

fn field_at(&self, index: usize) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field with index index as a &dyn PartialReflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn PartialReflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn to_dynamic_struct(&self) -> DynamicStruct

Creates a new DynamicStruct from this struct.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

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

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

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

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

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

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