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

Modifies the intensity of the fade effect applied to a bg_palette_ptr until it has a given state.

Base classes

template<typename Value, typename Property, class PropertyManager>
class to_value_template_action<bg_palette_ptr, fixed, bg_palette_fade_manager>
Modifies the property of a value until it has a given state.

Constructors, destructors, conversion operators

bg_palette_fade_to_action(const bg_palette_ptr& palette, int duration_updates, fixed final_intensity)
Constructor.
bg_palette_fade_to_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
Returns the intensity when the action is updated the given number of times.

Function documentation

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

Constructor.

Parameters
palette bg_palette_ptr to copy.
duration_updates Number of times that the action must be updated until the intensity is equal to final_intensity.
final_intensity Intensity when the action is updated duration_updates times.

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

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

Constructor.

Parameters
palette bg_palette_ptr to move.
duration_updates Number of times that the action must be updated until the intensity is equal to final_intensity.
final_intensity Intensity when the action is updated duration_updates times.

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