Struct steam_audio_sys::ffi::IPLDistanceAttenuationModel

#[repr(C)]
pub struct IPLDistanceAttenuationModel {
    pub type_: IPLDistanceAttenuationModelType,
    pub minDistance: IPLfloat32,
    pub callback: IPLDistanceAttenuationCallback,
    pub userData: *mut c_void,
    pub dirty: IPLbool,
}

A distance attenuation model that can be used for modeling attenuation of sound over distance. Can be used with both direct and indirect sound propagation.

Fields

type_: IPLDistanceAttenuationModelType

The type of distance attenuation model to use.

minDistance: IPLfloat32

When \c type is \c IPL_DISTANCEATTENUATIONTYPE_INVERSEDISTANCE, no distance attenuation is applied to any sound whose distance from the listener is less than this value.

callback: IPLDistanceAttenuationCallback

When \c type is \c IPL_DISTANCEATTENUATIONTYPE_CALLBACK, this function will be called whenever Steam Audio needs to evaluate distance attenuation.

userData: *mut c_void

Pointer to arbitrary data that will be provided to the \c callback function whenever it is called. May be \c NULL.

dirty: IPLbool

Set to \c IPL_TRUE to indicate that the distance attenuation model defined by the \c callback function has changed since the last time simulation was run. For example, the callback may be evaluating a curve defined in a GUI. If the user is editing the curve in real-time, set this to \c IPL_TRUE whenever the curve changes, so Steam Audio can update simulation results to match.

Trait Implementations

impl Clone for IPLDistanceAttenuationModel

fn clone(&self) -> IPLDistanceAttenuationModel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IPLDistanceAttenuationModel

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

Formats the value using the given formatter.

impl Copy for IPLDistanceAttenuationModel