Enum gilrs::ff::DistanceModel

source ·
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

Linear distance model.

Fields

§ref_distance: f32
§rolloff_factor: f32
§max_distance: f32
§

LinearClamped

Linear distance clamped model.

Fields

§ref_distance: f32
§rolloff_factor: f32
§max_distance: f32
§

Inverse

Inverse distance model.

Fields

§ref_distance: f32
§rolloff_factor: f32
§

InverseClamped

Inverse distance clamped model.

Fields

§ref_distance: f32
§rolloff_factor: f32
§max_distance: f32
§

Exponential

Exponential distance model.

Fields

§ref_distance: f32
§rolloff_factor: f32
§

ExponentialClamped

Exponential distance clamped model.

Fields

§ref_distance: f32
§rolloff_factor: f32
§max_distance: f32

Implementations§

source§

impl DistanceModel

source

fn attenuation(self, distance: f32) -> f32

source

pub(crate) fn validate(self) -> Result<(), DistanceModelError>

Trait Implementations§

source§

impl Clone for DistanceModel

source§

fn clone(&self) -> DistanceModel

Returns a copy 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 DistanceModel

source§

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

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

impl Default for DistanceModel

source§

fn default() -> DistanceModel

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

impl PartialEq for DistanceModel

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Copy for DistanceModel

source§

impl StructuralPartialEq for DistanceModel

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> 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,

§

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>,

§

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>,

§

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.