bn::dmg_music_volume_toggle_action class

Changes the volume of the active DMG music when the action is updated a given number of times.

Base classes

template<typename Property, class PropertyManager>
class toggle_template_action<fixed_point, dmg_music_volume_manager>
Changes the property when the action is updated a given number of times.

Constructors, destructors, conversion operators

dmg_music_volume_toggle_action(int duration_updates, fixed new_volume)
Constructor.
dmg_music_volume_toggle_action(int duration_updates, fixed new_left_volume, fixed new_right_volume)
Constructor.

Public functions

auto new_left_volume() const -> fixed
Returns the volume for the left speaker when the action is updated the given number of times.
auto new_right_volume() const -> fixed
Returns the volume for the right speaker when the action is updated the given number of times.

Function documentation

bn::dmg_music_volume_toggle_action::dmg_music_volume_toggle_action(int duration_updates, fixed new_volume)

Constructor.

Parameters
duration_updates How much times the action has to be updated to change the volume.
new_volume New volume for both speakers when the action is updated duration_updates times.

This volume must be in the range [0..1].

bn::dmg_music_volume_toggle_action::dmg_music_volume_toggle_action(int duration_updates, fixed new_left_volume, fixed new_right_volume)

Constructor.

Parameters
duration_updates How much times the action has to be updated to change the volume.
new_left_volume New volume for the left speaker when the action is updated duration_updates times.
new_right_volume New volume for the right speaker when the action is updated duration_updates times.

This volume must be in the range [0..1]. This volume must be in the range [0..1].