class
#include <bn_bg_palette_actions.h>
bg_palette_grayscale_loop_action Modifies the intensity of the grayscale effect applied to a bg_
Base classes
-
template<typename Value, typename Property, class PropertyManager>class loop_value_template_action<bg_palette_ptr, fixed, bg_palette_grayscale_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_grayscale_loop_action(const bg_
palette_ ptr& palette, int duration_updates, fixed final_intensity) - Constructor.
-
bg_palette_grayscale_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_grayscale_loop_action:: bg_palette_grayscale_loop_action(const bg_ palette_ ptr& palette,
int duration_updates,
fixed final_intensity)
Constructor.
Parameters | |
---|---|
palette | bg_ |
duration_updates | How much 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_grayscale_loop_action:: bg_palette_grayscale_loop_action(bg_ palette_ ptr&& palette,
int duration_updates,
fixed final_intensity)
Constructor.
Parameters | |
---|---|
palette | bg_ |
duration_updates | How much 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].