Skip to main content

VolumePanChain

Struct VolumePanChain 

Source
pub struct VolumePanChain {
    pub volume_pan: VolumePanNode,
    pub config: VolumeNodeConfig,
}
Expand description

A default FxChain for 2D game audio.

This chain contains a single VolumePan node.

Fields§

§volume_pan: VolumePanNode§config: VolumeNodeConfig

Implementations§

Source§

impl VolumePanChain

Source

pub fn set_params<B: AudioBackend>( &mut self, params: VolumePanNode, time: Option<EventInstant>, node_ids: &[NodeID], cx: &mut FirewheelCtx<B>, )

Set the parameters of the volume pan node.

  • params - The new parameters.
  • time - The instant these new parameters should take effect. If this is None, then the parameters will take effect as soon as the node receives the event.

Trait Implementations§

Source§

impl Clone for VolumePanChain

Source§

fn clone(&self) -> VolumePanChain

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for VolumePanChain

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for VolumePanChain

Source§

fn default() -> VolumePanChain

Returns the “default value” for a type. Read more
Source§

impl FxChain for VolumePanChain

Source§

fn construct_and_connect<B: AudioBackend>( &mut self, first_node_id: NodeID, first_node_num_out_channels: NonZeroChannelCount, dst_node_id: NodeID, dst_num_channels: NonZeroChannelCount, cx: &mut FirewheelCtx<B>, ) -> Vec<NodeID>

Construct the nodes in the FX chain and connect them, returning a list of the new node ids. Read more
Source§

impl PartialEq for VolumePanChain

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Copy for VolumePanChain

Source§

impl StructuralPartialEq for VolumePanChain

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.