Audio » DMG music module

Module files (files with *.mod and *.s3m extensions) played with DMG channels thanks to GBT Player and VGM audio files (files with *.vgm extension) played with DMG channels thanks to VGM player.

Files

file bn_dmg_music.h
file bn_dmg_music_actions.h
file bn_dmg_music_item.h
file bn_dmg_music_master_volume.h
file bn_dmg_music_position.h
file bn_dmg_music_type.h

Namespaces

namespace bn: Main Butano namespace.
namespace bn::dmg_music: DMG music related functions.

Classes

class bn::dmg_music_volume_manager: Manages the volume of the active DMG music.
class bn::dmg_music_volume_to_action: Modifies the volume of the active DMG music until it has a given state.
class bn::dmg_music_volume_loop_action: Modifies the volume of the active DMG 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::dmg_music_volume_toggle_action: Changes the volume of the active DMG music when the action is updated a given number of times.
class bn::dmg_music_item: Contains the required information to play DMG music.
template<> struct bn::hash<dmg_music_item>: Hash support for dmg_music_item.
class bn::dmg_music_position: Contains the required information to specify the position of an active DMG music.
template<> struct bn::hash<dmg_music_position>: Hash support for dmg_music_position.

Enums

enum class dmg_music_master_volume: uint8_t { QUARTER, HALF, FULL }: Specifies the available DMG music master volume levels.
enum class dmg_music_type: uint8_t { GBT_PLAYER, VGM }: Specifies the available DMG music types.

Enum documentation

enum class dmg_music_master_volume: uint8_t
#include <bn_dmg_music_master_volume.h>

Specifies the available DMG music master volume levels.

Enumerators
QUARTER	25%
HALF	50%
FULL	100%

enum class dmg_music_type: uint8_t
#include <bn_dmg_music_type.h>

Specifies the available DMG music types.

Enumerators
GBT_PLAYER	GBT Player module files with `.mod` and `.s3m` extensions.
VGM	VGM audio files with `*.vgm` extension.