Struct AudioManager

pub struct AudioManager { /* private fields */ }

You will interact with the AudioManager for all audio needs in Rusty Engine. It is exposed through the Engine struct provided to your logic function each frame as the audio_manager field. It is also accessible through the Game struct in your main function.

Implementations

impl AudioManager

pub fn play_sfx<S: Into<String>>(&mut self, sfx: S, volume: f32)

Play a sound effect. volume ranges from 0.0 to 1.0. sfx can be an SfxPreset or a string containing the relative path/filename of a sound file within the assets/ directory. Sound effects are “fire and forget”. They will play to completion and then stop. Multiple sound effects will be mixed and play simultaneously.

pub fn play_music<S: Into<String>>(&mut self, music: S, volume: f32)

Play looping music. volume ranges from 0.0 to 1.0. Music will loop until stopped with stop_music. Playing music stops any previously playing music. music can be a MusicPreset or a string containing the relative path/filename of a sound file within the assets/ directory.

pub fn stop_music(&mut self)

Stop any music currently playing. Ignored if no music is currently playing.

pub fn music_playing(&self) -> bool

Whether music is currently playing.

Trait Implementations

impl Debug for AudioManager

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

Formats the value using the given formatter.

impl Default for AudioManager

fn default() -> AudioManager

Returns the “default value” for a type.