Enum gilrs::ff::DistanceModel[−][src]

pub enum DistanceModel {
    None,
    Linear {
        ref_distance: f32,
        rolloff_factor: f32,
        max_distance: f32,
    },
    LinearClamped {
        ref_distance: f32,
        rolloff_factor: f32,
        max_distance: f32,
    },
    Inverse {
        ref_distance: f32,
        rolloff_factor: f32,
    },
    InverseClamped {
        ref_distance: f32,
        rolloff_factor: f32,
        max_distance: f32,
    },
    Exponential {
        ref_distance: f32,
        rolloff_factor: f32,
    },
    ExponentialClamped {
        ref_distance: f32,
        rolloff_factor: f32,
        max_distance: f32,
    },
}

Expand description

Specifies how distance between effect source and listener attenuates effect.

They are based on OpenAL Specification (chapter 3.4), but the best way to see how they differ is to run ff_pos example.

Make sure that all parameters are ≥ 0. Additionally Linear and LinearClamped models don’t like if ref_distance == max_distance while others would prefer ref_distance > 0.

Variants

`None`

Effect is not attenuated by distance.

`Linear`

Fields

ref_distance: f32

rolloff_factor: f32

max_distance: f32

Linear distance model.

`LinearClamped`

Fields

ref_distance: f32

rolloff_factor: f32

max_distance: f32

Linear distance clamped model.

`Inverse`

Fields

ref_distance: f32

rolloff_factor: f32

Inverse distance model.

`InverseClamped`

Fields

ref_distance: f32

rolloff_factor: f32

max_distance: f32

Inverse distance clamped model.

`Exponential`

Fields

ref_distance: f32

rolloff_factor: f32

Exponential distance model.

`ExponentialClamped`

Fields

ref_distance: f32

rolloff_factor: f32

max_distance: f32

Exponential distance clamped model.

Trait Implementations

impl Clone for DistanceModel

fn clone(&self) -> DistanceModel

Returns a copy of the value. Read more

1.0.0[src]

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

Performs copy-assignment from source. Read more

impl Debug for DistanceModel

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

Formats the value using the given formatter. Read more

impl Default for DistanceModel

fn default() -> Self

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

impl PartialEq<DistanceModel> for DistanceModel

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

This method tests for self and other values to be equal, and is used by ==. Read more

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

This method tests for !=.

impl Copy for DistanceModel

impl StructuralPartialEq for DistanceModel

Auto Trait Implementations

impl RefUnwindSafe for DistanceModel

impl Send for DistanceModel

impl Sync for DistanceModel

impl Unpin for DistanceModel

impl UnwindSafe for DistanceModel

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

pub fn from(t: T) -> T

Performs the conversion.

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

pub fn into(self) -> U

Performs the conversion.

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

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

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

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.