Audio » Music module

Contents

Module files (files with *.mod, *.xm, *.s3m and *.it extensions) music.

Files

file bn_music.h
file bn_music_actions.h
file bn_music_item.h

Namespaces

namespace bn
Main Butano namespace.
namespace bn::music
Music related functions.

Classes

class bn::music_volume_manager
Manages the volume of the active music.
class bn::music_volume_to_action
Modifies the volume of the active music until it has a given state.
class bn::music_volume_loop_action
Modifies the volume of the active music 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::music_volume_toggle_action
Changes the volume of the active music when the action is updated a given number of times.
class bn::music_item
Contains the required information to play music.
template<>
struct bn::hash<music_item>
Hash support for music_item.

Defines

#define BN_CFG_AUDIO_MAX_MUSIC_CHANNELS

Define documentation

#define BN_CFG_AUDIO_MAX_MUSIC_CHANNELS
#include <bn_config_audio.h>

Specifies the maximum number of active music channels.