Struct Reverb3D 

pub struct Reverb3D { /* private fields */ }

An interface that manages virtual 3D reverb spheres.

See the 3D Reverb Guide for more information.

Implementations

impl Reverb3D

pub unsafe fn from_ffi(value: *mut FMOD_REVERB3D) -> 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_REVERB3D

Converts self into its raw representation.

impl Reverb3D

pub fn set_3d_attributes( &self, position: Option<Vector>, min_distance: c_float, max_distance: c_float, ) -> Result<()>

Sets the 3D attributes of a reverb sphere.

See the 3D Reverb guide for more information.

When the position of the listener is less than max_distance away from the position of one or more reverb objects, the listener’s 3D reverb properties are a weighted combination of those reverb objects. Otherwise, the reverb dsp will use the global reverb settings.

pub fn get_3d_attributes(&self) -> Result<(Vector, c_float, c_float)>

Retrieves the 3D attributes of a reverb sphere.

See the 3D Reverb guide for more information.

pub fn set_properties(&self, properties: ReverbProperties) -> Result<()>

Sets the environmental properties of a reverb sphere.

Reverb presets are available, see the associated constants of ReverbProperties.

pub fn get_properties(&self) -> Result<ReverbProperties>

Retrieves the environmental properties of a reverb sphere.

See the 3D Reverb guide for more information.

pub fn set_active(&self, active: bool) -> Result<()>

Sets the active state.

See the 3D Reverb guide for more information.

pub fn get_active(&self) -> Result<bool>

Retrieves the active state.

See the 3D Reverb guide for more information.

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.

pub fn release(&self) -> Result<()>

Releases the memory for a reverb object and makes it inactive.

If you release all Reverb3D objects and have not added a new Reverb3D object, crate::System::set_reverb_properties should be called to reset the reverb properties.

Trait Implementations

impl Clone for Reverb3D

fn clone(&self) -> Reverb3D

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Reverb3D

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

Formats the value using the given formatter.

impl From<Reverb3D> for *mut FMOD_REVERB3D

fn from(value: Reverb3D) -> Self

Converts to this type from the input type.

impl Hash for Reverb3D

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 Reverb3D

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

impl Eq for Reverb3D

impl Send for Reverb3D

Available on non-crate feature thread-unsafe only.

impl StructuralPartialEq for Reverb3D

impl Sync for Reverb3D

Available on non-crate feature thread-unsafe only.