Struct SpatialSceneHandle 

pub struct SpatialSceneHandle { /* private fields */ }

Controls a spatial scene.

When a SpatialSceneHandle is dropped, the corresponding spatial scene will be removed.

Implementations

impl SpatialSceneHandle

pub fn id(&self) -> SpatialSceneId

Returns the unique identifier for the spatial scene.

pub fn add_emitter( &mut self, position: impl Into<Value<Vector3<f32>>>, settings: EmitterSettings, ) -> Result<EmitterHandle, AddEmitterError>

Adds an emitter to the scene.

pub fn add_listener( &mut self, position: impl Into<Value<Vector3<f32>>>, orientation: impl Into<Value<Quaternion<f32>>>, settings: ListenerSettings, ) -> Result<ListenerHandle, AddListenerError>

Adds a listener to the scene.

An unrotated listener should face in the negative Z direction with positive X to the right and positive Y up.

pub fn num_emitters(&self) -> usize

Returns the number of emitters in the scene.

pub fn num_listeners(&self) -> usize

Returns the number of listeners in the scene.

Trait Implementations

impl Drop for SpatialSceneHandle

fn drop(&mut self)

Executes the destructor for this type.

impl From<&SpatialSceneHandle> for SpatialSceneId

fn from(handle: &SpatialSceneHandle) -> SpatialSceneId

Converts to this type from the input type.