Audio » Sound effects module

Waveform audio files (files with *.wav extension) sound effects played with Direct Sound channels thanks to Maxmod.

Files

file bn_sound.h
file bn_sound_actions.h
file bn_sound_handle.h
file bn_sound_item.h

Namespaces

namespace bn
Main Butano namespace.
namespace bn::sound
Sound effects related functions.

Classes

class bn::sound_speed_manager
Manages the speed of a sound effect.
class bn::sound_speed_to_action
Modifies the speed of a sound effect until it has a given state.
class bn::sound_speed_loop_action
Modifies the speed of a sound effect from a minimum to a maximum. When the speed is equal to the given final state, it goes back to its initial state and vice versa.
class bn::sound_speed_toggle_action
Changes the speed of a sound effect when the action is updated a given number of times.
class bn::sound_panning_manager
Manages the panning of a sound effect.
class bn::sound_panning_to_action
Modifies the panning of a sound effect until it has a given state.
class bn::sound_panning_loop_action
Modifies the panning of a sound effect from a minimum to a maximum. When the panning is equal to the given final state, it goes back to its initial state and vice versa.
class bn::sound_panning_toggle_action
Changes the panning of a sound effect when the action is updated a given number of times.
class bn::sound_master_volume_manager
Manages the master volume of all sound effects.
class bn::sound_master_volume_to_action
Modifies the master volume of all sound effects until it has a given state.
class bn::sound_master_volume_loop_action
Modifies the master volume of all sound effects from a minimum to a maximum. When the volume is equal to the given final state, it goes back to its initial state and vice versa.
class bn::sound_master_volume_toggle_action
Changes the master volume of all sound effects when the action is updated a given number of times.
class bn::sound_handle
Sound effect handle.
template<>
struct bn::hash<sound_handle>
Hash support for sound_handle.
class bn::sound_item
Contains the required information to play sound effects.
template<>
struct bn::hash<sound_item>
Hash support for sound_item.

Defines

#define BN_CFG_AUDIO_MAX_SOUND_CHANNELS

Define documentation

#define BN_CFG_AUDIO_MAX_SOUND_CHANNELS

Specifies the maximum number of active sound effects.