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

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

Effect is not attenuated by distance.

Linear distance model.

Fields of Linear

Linear distance clamped model.

Fields of LinearClamped

Inverse distance model.

Fields of Inverse

Inverse distance clamped model.

Fields of InverseClamped

Exponential distance model.

Fields of Exponential

Exponential distance clamped model.

Fields of ExponentialClamped

Trait Implementations

impl Copy for DistanceModel
[src]

impl Clone for DistanceModel
[src]

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

impl PartialEq for DistanceModel
[src]

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

This method tests for !=.

impl Debug for DistanceModel
[src]

Formats the value using the given formatter. Read more

impl Default for DistanceModel
[src]

Returns the "default value" for a type. Read more

Auto Trait Implementations