bn::bg_palette_hue_shift_loop_action class
#include <bn_bg_palette_actions.h>

Modifies the intensity of the hue shift effect applied to a bg_palette_ptr from a minimum to a maximum. When the intensity 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<bg_palette_ptr, fixed, bg_palette_hue_shift_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

bg_palette_hue_shift_loop_action(const bg_palette_ptr& palette, int duration_updates, fixed final_intensity): Constructor.
bg_palette_hue_shift_loop_action(bg_palette_ptr&& palette, int duration_updates, fixed final_intensity): Constructor.

Public functions

auto palette() const -> const bg_palette_ptr&: Returns the bg_palette_ptr to modify.
auto final_intensity() const -> fixed: When the intensity is equal to the returned parameter, it goes back to its initial state and vice versa.

Function documentation

bn::bg_palette_hue_shift_loop_action::bg_palette_hue_shift_loop_action(const bg_palette_ptr& palette, int duration_updates, fixed final_intensity)

Constructor.

Parameters
palette	bg_palette_ptr to copy.
duration_updates	How many times the action has to be updated before changing the direction of the intensity delta.
final_intensity	When the intensity is equal to this parameter, it goes back to its initial state and vice versa.

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

bn::bg_palette_hue_shift_loop_action::bg_palette_hue_shift_loop_action(bg_palette_ptr&& palette, int duration_updates, fixed final_intensity)