IPLPathEffectParams

Struct IPLPathEffectParams 

Source
#[repr(C)]
pub struct IPLPathEffectParams { pub eqCoeffs: [IPLfloat32; 3], pub shCoeffs: *mut IPLfloat32, pub order: IPLint32, pub binaural: IPLbool, pub hrtf: IPLHRTF, pub listener: IPLCoordinateSpace3, pub normalizeEQ: IPLbool, }
Expand description

Parameters for applying a path effect to an audio buffer.

Fields§

§eqCoeffs: [IPLfloat32; 3]

3-band EQ coefficients for modeling frequency-dependent attenuation caused by paths bending around obstacles.

§shCoeffs: *mut IPLfloat32

Ambisonic coefficients for modeling the directional distribution of sound reaching the listener. The coefficients are specified in world-space, and must be rotated to match the listener’s orientation separately.

§order: IPLint32

Ambisonic order of the output buffer. May be less than the maximum order specified when creating the effect, in which case higher-order \c shCoeffs will be ignored, and CPU usage will be reduced.

§binaural: IPLbool

If \c IPL_TRUE, spatialize using HRTF-based binaural rendering. Only used if \c spatialize was set to \c IPL_TRUE in \c IPLPathEffectSettings.

§hrtf: IPLHRTF

The HRTF to use when spatializing. Only used if \c spatialize was set to \c IPL_TRUE in \c IPLPathEffectSettings and \c binaural is set to \c IPL_TRUE.

§listener: IPLCoordinateSpace3

The position and orientation of the listener. Only used if \c spatialize was set to \c IPL_TRUE in \c IPLPathEffectSettings and \c binaural is set to \c IPL_TRUE.

§normalizeEQ: IPLbool

If \c IPL_TRUE, the values in \c eqCoeffs will be normalized before being used, i.e., each value in \c eqCoeffs will be divided by the largest value in \c eqCoeffs. This can help counteract overly-aggressive filtering due to a physics-based deviation model. If \c IPL_FALSE, the values in \c eqCoeffs will be used as-is.

Trait Implementations§

Source§

impl Clone for IPLPathEffectParams

Source§

fn clone(&self) -> IPLPathEffectParams

Returns a duplicate 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 IPLPathEffectParams

Source§

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

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

impl Copy for IPLPathEffectParams

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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,

Source§

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

Source§

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

Source§

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.