bn::sound_panning_loop_action class

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.

Base classes

template<typename Value, typename Property, class PropertyManager>
class loop_value_template_action<sound_handle, fixed, sound_panning_manager>
Modifies the property of a value by delta from a minimum to a maximum. When the property is equal to the given final state, it goes back to its initial state and vice versa.

Constructors, destructors, conversion operators

sound_panning_loop_action(sound_handle handle, int duration_updates, fixed final_panning)
Constructor.

Public functions

auto handle() const -> sound_handle
Returns the sound_handle to modify.
auto final_panning() const -> fixed
When the panning of the given sound_handle is equal to this returned parameter, it goes back to its initial state and vice versa.

Function documentation

bn::sound_panning_loop_action::sound_panning_loop_action(sound_handle handle, int duration_updates, fixed final_panning)

Constructor.

Parameters
handle sound_handle to modify.
duration_updates How many times the action has to be updated before changing the direction of the panning delta.
final_panning When the panning of the given sound_handle is equal to this parameter, it goes back to its initial state and vice versa.