Struct Scene 

pub struct Scene {
    pub volumes: Volumes,
    /* private fields */
}

The sound scene: up to 256 playing effects and 4,096 effects in the world, their emitters, and the volumes of the kinds of sound. Scene::update mixes them every frame.

Original: Audio::Scene.

Fields

volumes: Volumes

The volume of each kind of sound.

Implementations

impl Scene

pub fn play_effect(&mut self, effect: &Rc<Effect>, kind: u32, start: i64) -> u32

PlayEffect: the first free slot, starting start µs into the effect. Returns 0 when all 256 are busy.

Original: Runtime 0x1800e17b0.

pub fn play_effect_3d( &mut self, effect: &Rc<Effect>, kind: u32, start: i64, at: Vec3, ) -> u32

PlayEffect3D with FindFree3DEffect: refused when the same effect already plays within its radius and started less than the retrigger window ago.

Original: Runtime 0x1800e1700.

pub fn find_effect_3d(&self, effect: &Rc<Effect>) -> u32

FindEffect3D: the 3D effect playing this SoundEffect, or 0.

pub fn add_emitter(&mut self, handle: u32, at: Vec3, volume: f32)

AddEmitter.

pub fn remove_emitter(&mut self, handle: u32, at: Vec3)

RemoveEmitter: the first emitter at that position.

pub fn move_emitter(&mut self, handle: u32, from: Vec3, to: Vec3)

MoveEmitter.

pub fn set_emitter_volume(&mut self, handle: u32, at: Vec3, volume: f32)

SetEmitterVolume.

pub fn emitter_count(&self, handle: u32) -> usize

GetEmitterCount.

pub fn is_effect_playing(&self, handle: u32) -> bool

IsEffectPlaying.

pub fn stop_effect(&mut self, mixer: &mut dyn Mixer, handle: u32)

StopEffect: stop its channels and free it.

pub fn stop_effect_3d(&mut self, mixer: &mut dyn Mixer, handle: u32)

StopEffect3D.

pub fn stop_all(&mut self, mixer: &mut dyn Mixer)

StopAll: every 2D effect (3D effects stay and restart when audible).

pub fn pause(&mut self, mixer: &mut dyn Mixer, kind: u32, paused: bool)

Pause(type, paused).

pub fn is_paused(&self, kind: u32) -> bool

IsPaused(type).

pub fn on_ended(&mut self, channel: Channel)

The device’s end callback (OnSoundEnded): mark the sound ended.

pub fn update( &mut self, mixer: &mut dyn Mixer, dt: i64, step: i64, rand: &mut dyn FnMut() -> u32, listener: Vec3, reach: f32, )

Update(dt, step, random, listener, reach). dt advances the effects; step is the simulation step of the frame; reach extends every 3D effect’s radius (the camera’s distance from its pivot).

Original: Runtime 0x1800e1f10.

pub fn active(&self) -> (usize, usize)

Effects currently held (tests, debugging).

Trait Implementations

impl Default for Scene

fn default() -> Self

Returns the “default value” for a type.