Enum gilrs::ff::DistanceModel

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

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 of Linear

ref_distance: f32rolloff_factor: f32max_distance: f32

LinearClamped

Linear distance clamped model.

Fields of LinearClamped

ref_distance: f32rolloff_factor: f32max_distance: f32

Inverse

Inverse distance model.

Fields of Inverse

ref_distance: f32rolloff_factor: f32

InverseClamped

Inverse distance clamped model.

Fields of InverseClamped

ref_distance: f32rolloff_factor: f32max_distance: f32

Exponential

Exponential distance model.

Fields of Exponential

ref_distance: f32rolloff_factor: f32

ExponentialClamped

Exponential distance clamped model.

Fields of ExponentialClamped

ref_distance: f32rolloff_factor: f32max_distance: f32

Trait Implementations

impl Default for DistanceModel

fn default() -> Self

Returns the "default value" for a type.

impl Clone for DistanceModel

fn clone(&self) -> DistanceModel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for DistanceModel

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 ==.

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

This method tests for !=.

impl Debug for DistanceModel

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

Formats the value using the given formatter.