Skip to main content

Space2d

Struct Space2d 

Source
pub struct Space2d {
    pub width: f32,
    pub min_distance: f32,
    pub max_distance: f32,
    pub model: Distance,
}
Expand description

How a 2D position relative to the listener becomes a pan and a gain.

The horizontal offset x pans the sound with the mixer’s constant-power law: pan = x / width, limited to -1..=1, so a sound width units to the right is fully right. The distance d = √(x² + y²) sets a gain of 1 up to min_distance and 0 from max_distance; in between, Distance::Linear falls in a straight line and Distance::Inverse follows min/d, shifted and scaled so it reaches 0 at the maximum instead of jumping there.

Fields§

§width: f32

Horizontal offset at which a sound is fully to one side. Default 1.

§min_distance: f32

Distance up to which a sound plays at full gain. Default 1.

§max_distance: f32

Distance from which a sound is silent. Default 10.

§model: Distance

Implementations§

Source§

impl Space2d

Source

pub fn place(&self, [x, y]: [f32; 2]) -> (f32, f32)

The pan and the distance gain of a sound at [x, y] from the listener.

Trait Implementations§

Source§

impl Clone for Space2d

Source§

fn clone(&self) -> Space2d

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Space2d

Source§

impl Debug for Space2d

Source§

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

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

impl Default for Space2d

Source§

fn default() -> Self

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

impl PartialEq for Space2d

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Space2d

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.