dmg_music_volume_to_action class
#include <bn_dmg_music_actions.h>
Modifies the volume of the active DMG music until it has a given state.
Volume change is not supported by the VGM player.
Base classes
-
template<typename Property, class PropertyManager>class to_template_action<fixed_point, dmg_music_volume_manager>
- Modifies the property until it has a given state.
Constructors, destructors, conversion operators
- dmg_music_volume_to_action(int duration_updates, fixed final_volume)
- Constructor.
- dmg_music_volume_to_action(int duration_updates, fixed final_left_volume, fixed final_right_volume)
- Constructor.
Public functions
- auto final_left_volume() const -> fixed
- Returns the volume for the left speaker when the action is updated the given number of times.
- auto final_right_volume() const -> fixed
- Returns the volume for the right speaker when the action is updated the given number of times.
Function documentation
bn::
Constructor.
| Parameters | |
|---|---|
| duration_updates | Number of times that the action must be updated until the volume is equal to final_volume. |
| final_volume | Volume for both speakers when the action is updated duration_updates times. |
This volume must be in the range [0..1].
bn::
Constructor.
| Parameters | |
|---|---|
| duration_updates | Number of times that the action must be updated until the volume is equal to final_left_volume and final_right_volume. |
| final_left_volume | Volume for the left speaker when the action is updated duration_updates times. |
| final_right_volume | 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].