Struct DspConnection 

pub struct DspConnection { /* private fields */ }

An interface that manages Digital Signal Processor (DSP) connections

Implementations

impl DspConnection

pub fn get_input(&self) -> Result<Dsp>

Retrieves the connection’s input Dsp unit.

If Dsp::add_input was just called, the connection might not be ready because the Dsp system is still queued to be connected, and may need to wait several milliseconds for the next mix to occur. If so the function will return FMOD_RESULT::FMOD_ERR_NOTREADY.

pub fn get_output(&self) -> Result<Dsp>

Retrieves the connection’s output DSP unit.

If Dsp::add_input was just called, the connection might not be ready because the Dsp system is still queued to be connected, and may need to wait several milliseconds for the next mix to occur. If so the function will return FMOD_RESULT::FMOD_ERR_NOTREADY.

pub fn get_type(&self) -> Result<DspConnectionType>

Retrieves the type of the connection between 2 DSP units.

pub fn set_userdata(&self, userdata: *mut c_void) -> Result<()>

Sets the user data.

pub fn get_userdata(&self) -> Result<*mut c_void>

Retrieves user data.

impl DspConnection

pub fn set_mix(&self, volume: c_float) -> Result<()>

Sets the connection’s volume scale.

pub fn get_mix(&self) -> Result<c_float>

Retrieves the connection’s volume scale.

pub fn set_mix_matrix<const IN: usize, const OUT: usize>( &self, matrix: [[f32; IN]; OUT], ) -> Result<()>

Sets a 2 dimensional pan matrix that maps the signal from input channels (columns) to output speakers (rows).

Matrix element values can be below 0 to invert a signal and above 1 to amplify the signal. Note that increasing the signal level too far may cause audible distortion.

pub fn get_mix_matrix<const IN: usize, const OUT: usize>( &self, ) -> Result<([[f32; IN]; OUT], c_int, c_int)>

Retrieves a 2 dimensional pan matrix that maps the signal from input channels (columns) to output speakers (rows).

Matrix element values can be below 0 to invert a signal and above 1 to amplify the signal. Note that increasing the signal level too far may cause audible distortion.

impl DspConnection

pub unsafe fn from_ffi(value: *mut FMOD_DSPCONNECTION) -> Self

Safety

value must be a valid pointer either aquired from Self::as_ptr or FMOD.

Panics

Panics if value is null.

pub fn as_ptr(self) -> *mut FMOD_DSPCONNECTION

Converts self into its raw representation.

Trait Implementations

impl Clone for DspConnection

fn clone(&self) -> DspConnection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DspConnection

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

Formats the value using the given formatter.

impl From<DspConnection> for *mut FMOD_DSPCONNECTION

fn from(value: DspConnection) -> Self

Converts to this type from the input type.

impl Hash for DspConnection

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for DspConnection

fn eq(&self, other: &DspConnection) -> 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 Copy for DspConnection

impl Eq for DspConnection

impl Send for DspConnection

Available on non-crate feature thread-unsafe only.

impl StructuralPartialEq for DspConnection

impl Sync for DspConnection

Available on non-crate feature thread-unsafe only.