Struct Attributes3DMulti 

#[repr(C)]
pub struct Attributes3DMulti {
    pub absolute: Attributes3D,
    /* private fields */
}

3D attributes data structure for multiple listeners.

The studio::System sets this parameter automatically when an studio::EventInstance position changes. However, if you are using the core API’s System and not the studio::System, you must set this DSP parameter explicitly.

Attributes must use a coordinate system with the positive Y axis being up and the positive X axis being right. The FMOD Engine converts passed in coordinates to left-handed for the plug-in if the System was initialized with the FMOD_INIT_3D_RIGHTHANDED flag.

When using a listener attenuation position, the direction of the relative attributes will be relative to the listener position and the length will be the distance to the attenuation position.

Fields

absolute: Attributes3D

Position of the sound in world coordinates.

Implementations

impl Attributes3DMulti

pub fn new(data: &[(Attributes3D, c_float)], absolute: Attributes3D) -> Self

Create a new Attributes3DMulti.

Only values from data[..FMOD_MAX_LISTENERS] will be read

pub fn relative(&self) -> &[Attributes3D]

Position of the sound relative to the listeners.

pub fn relative_mut(&mut self) -> &mut [Attributes3D]

Position of the sound relative to the listeners.

pub fn weight(&self) -> &[c_float]

Weighting of the listeners where 0 means listener has no contribution and 1 means full contribution.

pub fn weight_mut(&mut self) -> &mut [c_float]

Weighting of the listeners where 0 means listener has no contribution and 1 means full contribution.

pub fn listener_count(&self) -> usize

Number of listeners.

Trait Implementations

impl Clone for Attributes3DMulti

fn clone(&self) -> Attributes3DMulti

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Attributes3DMulti

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

Formats the value using the given formatter.

impl PartialEq for Attributes3DMulti

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ReadableParameter for Attributes3DMulti

fn get_parameter(dsp: Dsp, index: c_int) -> Result<Self>

Get the parameter at index.

fn get_parameter_string(dsp: Dsp, index: c_int) -> Result<Utf8CString>

Get the parameter string at index.

impl ReadableParameterIndex<Attributes3DMulti> for Position

const TYPE: DspType = DspType::ObjectPan

What type of DSP this index is for.

fn into_index(self) -> c_int

Convert self into a DSP index.

impl ReadableParameterIndex<Attributes3DMulti> for Position

const TYPE: DspType = DspType::Pan

What type of DSP this index is for.

fn into_index(self) -> c_int

Convert self into a DSP index.

impl WritableParameter for Attributes3DMulti

fn set_parameter(self, dsp: Dsp, index: c_int) -> Result<()>

Set the parameter at index.

impl WritableParameterIndex<Attributes3DMulti> for Position

const TYPE: DspType = DspType::ObjectPan

What type of DSP this index is for.

fn into_index(self) -> c_int

Convert self into a DSP index.

impl WritableParameterIndex<Attributes3DMulti> for Position

const TYPE: DspType = DspType::Pan

What type of DSP this index is for.

fn into_index(self) -> c_int

Convert self into a DSP index.

impl Copy for Attributes3DMulti

impl StructuralPartialEq for Attributes3DMulti