#include <bn_regular_bg_animate_actions.h>
template<int MaxSize>
bn::regular_bg_cached_animate_action class

Changes the map of a regular_bg_ptr when the action is updated a given number of times.

Template parameters
MaxSize Maximum number of maps to store.

This action differs from regular_bg_animate_action in that all maps to use are cached, so it is faster but takes way more VRAM.

Base classes

class iregular_bg_cached_animate_action
Base class of bn::regular_bg_cached_animate_action.

Public static functions

static auto once(const regular_bg_ptr& regular_bg, int wait_updates, const regular_bg_map_item& map_item, const span<const uint16_t>& map_indexes) -> regular_bg_cached_animate_action
Generates a regular_bg_cached_animate_action which loops over the given regular_bg maps only once.
static auto once(regular_bg_ptr&& regular_bg, int wait_updates, const regular_bg_map_item& map_item, const span<const uint16_t>& map_indexes) -> regular_bg_cached_animate_action
Generates a regular_bg_cached_animate_action which loops over the given regular_bg maps only once.
static auto once(const regular_bg_ptr& regular_bg, int wait_updates, span<regular_bg_map_ptr> maps) -> regular_bg_cached_animate_action
Generates a regular_bg_cached_animate_action which loops over the given regular_bg maps only once.
static auto once(regular_bg_ptr&& regular_bg, int wait_updates, span<regular_bg_map_ptr> maps) -> regular_bg_cached_animate_action
Generates a regular_bg_cached_animate_action which loops over the given regular_bg maps only once.
static auto forever(const regular_bg_ptr& regular_bg, int wait_updates, const regular_bg_map_item& map_item, const span<const uint16_t>& map_indexes) -> regular_bg_cached_animate_action
Generates a regular_bg_cached_animate_action which loops over the given regular_bg maps forever.
static auto forever(regular_bg_ptr&& regular_bg, int wait_updates, const regular_bg_map_item& map_item, const span<const uint16_t>& map_indexes) -> regular_bg_cached_animate_action
Generates a regular_bg_cached_animate_action which loops over the given regular_bg maps forever.
static auto forever(const regular_bg_ptr& regular_bg, int wait_updates, span<regular_bg_map_ptr> maps) -> regular_bg_cached_animate_action
Generates a regular_bg_cached_animate_action which loops over the given regular_bg maps forever.
static auto forever(regular_bg_ptr&& regular_bg, int wait_updates, span<regular_bg_map_ptr> maps) -> regular_bg_cached_animate_action
Generates a regular_bg_cached_animate_action which loops over the given regular_bg maps forever.

Constructors, destructors, conversion operators

regular_bg_cached_animate_action(const regular_bg_cached_animate_action& other)
Copy constructor.
regular_bg_cached_animate_action(regular_bg_cached_animate_action&& other) noexcept
Move constructor.
regular_bg_cached_animate_action(const iregular_bg_cached_animate_action& other)
Copy constructor.

Public functions

auto operator=(const regular_bg_cached_animate_action& other) -> regular_bg_cached_animate_action&
Copy assignment operator.
auto operator=(regular_bg_cached_animate_action&& other) -> regular_bg_cached_animate_action& noexcept
Move assignment operator.
auto operator=(const iregular_bg_cached_animate_action& other) -> regular_bg_cached_animate_action&
Copy assignment operator.
auto operator=(iregular_bg_cached_animate_action&& other) -> regular_bg_cached_animate_action& noexcept
Move assignment operator.

Function documentation

template<int MaxSize>
static regular_bg_cached_animate_action bn::regular_bg_cached_animate_action<MaxSize>::once(const regular_bg_ptr& regular_bg, int wait_updates, const regular_bg_map_item& map_item, const span<const uint16_t>& map_indexes)

Generates a regular_bg_cached_animate_action which loops over the given regular_bg maps only once.

Parameters
regular_bg regular_bg_ptr to copy.
wait_updates Number of times the action must be updated before changing the map of the given regular_bg_ptr.
map_item It creates the new map to use by the given regular_bg_ptr.
map_indexes Indexes of the maps to reference in map_item.
Returns The requested regular_bg_cached_animate_action.

template<int MaxSize>
static regular_bg_cached_animate_action bn::regular_bg_cached_animate_action<MaxSize>::once(regular_bg_ptr&& regular_bg, int wait_updates, const regular_bg_map_item& map_item, const span<const uint16_t>& map_indexes)

Generates a regular_bg_cached_animate_action which loops over the given regular_bg maps only once.

Parameters
regular_bg regular_bg_ptr to move.
wait_updates Number of times the action must be updated before changing the map of the given regular_bg_ptr.
map_item It creates the new map to use by the given regular_bg_ptr.
map_indexes Indexes of the maps to reference in the given regular_bg_map_item.
Returns The requested regular_bg_cached_animate_action.

template<int MaxSize>
static regular_bg_cached_animate_action bn::regular_bg_cached_animate_action<MaxSize>::once(const regular_bg_ptr& regular_bg, int wait_updates, span<regular_bg_map_ptr> maps)

Generates a regular_bg_cached_animate_action which loops over the given regular_bg maps only once.

Parameters
regular_bg regular_bg_ptr to copy.
wait_updates Number of times the action must be updated before changing the map of the given regular_bg_ptr.
maps List of maps to use by the given regular_bg_ptr.
Returns The requested regular_bg_cached_animate_action.

template<int MaxSize>
static regular_bg_cached_animate_action bn::regular_bg_cached_animate_action<MaxSize>::once(regular_bg_ptr&& regular_bg, int wait_updates, span<regular_bg_map_ptr> maps)

Generates a regular_bg_cached_animate_action which loops over the given regular_bg maps only once.

Parameters
regular_bg regular_bg_ptr to move.
wait_updates Number of times the action must be updated before changing the map of the given regular_bg_ptr.
maps List of maps to use by the given regular_bg_ptr.
Returns The requested regular_bg_cached_animate_action.

template<int MaxSize>
static regular_bg_cached_animate_action bn::regular_bg_cached_animate_action<MaxSize>::forever(const regular_bg_ptr& regular_bg, int wait_updates, const regular_bg_map_item& map_item, const span<const uint16_t>& map_indexes)

Generates a regular_bg_cached_animate_action which loops over the given regular_bg maps forever.

Parameters
regular_bg regular_bg_ptr to copy.
wait_updates Number of times the action must be updated before changing the map of the given regular_bg_ptr.
map_item It creates the new map to use by the given regular_bg_ptr.
map_indexes Indexes of the maps to reference in map_item.
Returns The requested regular_bg_cached_animate_action.

template<int MaxSize>
static regular_bg_cached_animate_action bn::regular_bg_cached_animate_action<MaxSize>::forever(regular_bg_ptr&& regular_bg, int wait_updates, const regular_bg_map_item& map_item, const span<const uint16_t>& map_indexes)

Generates a regular_bg_cached_animate_action which loops over the given regular_bg maps forever.

Parameters
regular_bg regular_bg_ptr to move.
wait_updates Number of times the action must be updated before changing the map of the given regular_bg_ptr.
map_item It creates the new map to use by the given regular_bg_ptr.
map_indexes Indexes of the maps to reference in the given regular_bg_map_item.
Returns The requested regular_bg_cached_animate_action.

template<int MaxSize>
static regular_bg_cached_animate_action bn::regular_bg_cached_animate_action<MaxSize>::forever(const regular_bg_ptr& regular_bg, int wait_updates, span<regular_bg_map_ptr> maps)

Generates a regular_bg_cached_animate_action which loops over the given regular_bg maps forever.

Parameters
regular_bg regular_bg_ptr to copy.
wait_updates Number of times the action must be updated before changing the map of the given regular_bg_ptr.
maps List of maps to use by the given regular_bg_ptr.
Returns The requested regular_bg_cached_animate_action.

template<int MaxSize>
static regular_bg_cached_animate_action bn::regular_bg_cached_animate_action<MaxSize>::forever(regular_bg_ptr&& regular_bg, int wait_updates, span<regular_bg_map_ptr> maps)

Generates a regular_bg_cached_animate_action which loops over the given regular_bg maps forever.

Parameters
regular_bg regular_bg_ptr to move.
wait_updates Number of times the action must be updated before changing the map of the given regular_bg_ptr.
maps List of maps to use by the given regular_bg_ptr.
Returns The requested regular_bg_cached_animate_action.

template<int MaxSize>
bn::regular_bg_cached_animate_action<MaxSize>::regular_bg_cached_animate_action(const regular_bg_cached_animate_action& other)

Copy constructor.

Parameters
other regular_bg_cached_animate_action to copy.

template<int MaxSize>
bn::regular_bg_cached_animate_action<MaxSize>::regular_bg_cached_animate_action(regular_bg_cached_animate_action&& other) noexcept

Move constructor.

Parameters
other regular_bg_cached_animate_action to move.

template<int MaxSize>
bn::regular_bg_cached_animate_action<MaxSize>::regular_bg_cached_animate_action(const iregular_bg_cached_animate_action& other)

Copy constructor.

Parameters
other iregular_bg_cached_animate_action to copy.

template<int MaxSize>
regular_bg_cached_animate_action& bn::regular_bg_cached_animate_action<MaxSize>::operator=(const regular_bg_cached_animate_action& other)

Copy assignment operator.

Parameters
other regular_bg_cached_animate_action to copy.
Returns Reference to this.

template<int MaxSize>
regular_bg_cached_animate_action& bn::regular_bg_cached_animate_action<MaxSize>::operator=(regular_bg_cached_animate_action&& other) noexcept

Move assignment operator.

Parameters
other regular_bg_cached_animate_action to move.
Returns Reference to this.

template<int MaxSize>
regular_bg_cached_animate_action& bn::regular_bg_cached_animate_action<MaxSize>::operator=(const iregular_bg_cached_animate_action& other)

Copy assignment operator.

Parameters
other iregular_bg_cached_animate_action to copy.
Returns Reference to this.

template<int MaxSize>
regular_bg_cached_animate_action& bn::regular_bg_cached_animate_action<MaxSize>::operator=(iregular_bg_cached_animate_action&& other) noexcept

Move assignment operator.

Parameters
other ivector to move.
Returns Reference to this.