Display » Backgrounds » Regular backgrounds module

Backgrounds which can't perform affine transformations.

Also known as text backgrounds.

Files

file bn_regular_bg_actions.h
file bn_regular_bg_animate_actions.h
file bn_regular_bg_animate_actions_fwd.h
file bn_regular_bg_attributes.h
file bn_regular_bg_attributes_hbe_ptr.h
file bn_regular_bg_builder.h
file bn_regular_bg_item.h
file bn_regular_bg_map_cell.h
file bn_regular_bg_map_cell_info.h
file bn_regular_bg_map_item.h
file bn_regular_bg_map_ptr.h
file bn_regular_bg_position_hbe_ptr.h
file bn_regular_bg_ptr.h
file bn_regular_bg_tiles_item.h
file bn_regular_bg_tiles_ptr.h

Classes

class bn::regular_bg_visible_manager
Manages if a regular_bg_ptr must be committed to the GBA or not.
class bn::regular_bg_visible_toggle_action
Toggles if a regular_bg_ptr must be committed to the GBA or not when the action is updated a given number of times.
class bn::regular_bg_position_manager
Manages the position of a regular_bg_ptr.
class bn::regular_bg_move_by_action
Modifies the position of a regular_bg_ptr by a given delta.
class bn::regular_bg_move_to_action
Modifies the position of a regular_bg_ptr until it has a given state.
class bn::regular_bg_move_loop_action
Modifies the position of a regular_bg_ptr from a minimum to a maximum. When the position is equal to the given final state, it goes back to its initial state and vice versa.
class bn::regular_bg_move_toggle_action
Changes the position of a regular_bg_ptr when the action is updated a given number of times.
class bn::regular_bg_mosaic_manager
Manages if the mosaic effect must be applied to a regular_bg_ptr or not.
class bn::regular_bg_mosaic_toggle_action
Toggles if the mosaic effect must be applied to a regular_bg_ptr or not when the action is updated a given number of times.
class bn::regular_bg_blending_manager
Manages if blending must be applied to a regular_bg_ptr or not.
class bn::regular_bg_blending_toggle_action
Toggles if blending must be applied to a regular_bg_ptr or not when the action is updated a given number of times.
class bn::regular_bg_blending_top_manager
Manages if a regular_bg_ptr must be part of the blending top layer or not.
class bn::regular_bg_blending_top_toggle_action
Toggles if a regular_bg_ptr is part of the blending top layer or not when the action is updated a given number of times.
class bn::regular_bg_blending_bottom_manager
Manages if a regular_bg_ptr must be part of the blending bottom layer or not.
class bn::regular_bg_blending_bottom_toggle_action
Toggles if a regular_bg_ptr is part of the blending bottom layer or not when the action is updated a given number of times.
class bn::iregular_bg_animate_action
Base class of bn::regular_bg_animate_action.
class bn::iregular_bg_cached_animate_action
Base class of bn::regular_bg_cached_animate_action.
template<int MaxSize>
class bn::regular_bg_animate_action
Changes the map of a regular_bg_ptr when the action is updated a given number of times.
template<int MaxSize>
class bn::regular_bg_cached_animate_action
Changes the map of a regular_bg_ptr when the action is updated a given number of times.
class bn::regular_bg_attributes
Manages the attributes to commit to the GBA register of a regular background.
class bn::regular_bg_attributes_hbe_ptr
std::shared_ptr like smart pointer that retains shared ownership of a H-Blank effect which changes the attributes to commit to the GBA register of a regular background in each screen horizontal line.
class bn::regular_bg_builder
Creates regular_bg_map_ptr objects with custom attributes.
class bn::regular_bg_item
Contains the required information to generate regular backgrounds and their maps.
class bn::regular_bg_map_item
Contains the required information to generate regular background maps.
class bn::regular_bg_map_ptr
std::shared_ptr like smart pointer that retains shared ownership of a regular background map.
template<>
struct bn::hash<regular_bg_map_ptr>
Hash support for regular_bg_map_ptr.
class bn::regular_bg_position_hbe_ptr
std::shared_ptr like smart pointer that retains shared ownership of a H-Blank effect which changes the position of a regular background in each screen horizontal line.
class bn::regular_bg_ptr
std::shared_ptr like smart pointer that retains shared ownership of a regular background.
template<>
struct bn::hash<regular_bg_ptr>
Hash support for regular_bg_ptr.
class bn::regular_bg_tiles_item
Contains the required information to generate regular background tiles.
class bn::regular_bg_tiles_ptr
std::shared_ptr like smart pointer that retains shared ownership of the tiles of a regular background.
template<>
struct bn::hash<regular_bg_tiles_ptr>
Hash support for regular_bg_tiles_ptr.

Functions

template<typename ... Args>
auto create_regular_bg_animate_action_once(const regular_bg_ptr& regular_bg, int wait_updates, const regular_bg_map_item& map_item, Args ... map_indexes) -> auto
Generates a regular_bg_animate_action which loops over the given regular_bg maps only once.
template<typename ... Args>
auto create_regular_bg_animate_action_once(regular_bg_ptr&& regular_bg, int wait_updates, const regular_bg_map_item& map_item, Args ... map_indexes) -> auto
Generates a regular_bg_animate_action which loops over the given regular_bg maps only once.
template<typename ... Args>
auto create_regular_bg_animate_action_forever(const regular_bg_ptr& regular_bg, int wait_updates, const regular_bg_map_item& map_item, Args ... map_indexes) -> auto
Generates a regular_bg_animate_action which loops over the given regular_bg maps forever.
template<typename ... Args>
auto create_regular_bg_animate_action_forever(regular_bg_ptr&& regular_bg, int wait_updates, const regular_bg_map_item& map_item, Args ... map_indexes) -> auto
Generates a regular_bg_animate_action which loops over the given regular_bg maps forever.
template<typename ... Args>
auto create_regular_bg_cached_animate_action_once(const regular_bg_ptr& regular_bg, int wait_updates, const regular_bg_map_item& map_item, Args ... map_indexes) -> auto
Generates a regular_bg_cached_animate_action which loops over the given regular_bg maps only once.
template<typename ... Args>
auto create_regular_bg_cached_animate_action_once(regular_bg_ptr&& regular_bg, int wait_updates, const regular_bg_map_item& map_item, Args ... map_indexes) -> auto
Generates a regular_bg_cached_animate_action which loops over the given regular_bg maps only once.
template<typename ... Args>
auto create_regular_bg_cached_animate_action_forever(const regular_bg_ptr& regular_bg, int wait_updates, const regular_bg_map_item& map_item, Args ... map_indexes) -> auto
Generates a regular_bg_cached_animate_action which loops over the given regular_bg maps forever.
template<typename ... Args>
auto create_regular_bg_cached_animate_action_forever(regular_bg_ptr&& regular_bg, int wait_updates, const regular_bg_map_item& map_item, Args ... map_indexes) -> auto
Generates a regular_bg_cached_animate_action which loops over the given regular_bg maps forever.

Function documentation

#include <bn_regular_bg_animate_actions.h>
template<typename ... Args>
auto create_regular_bg_animate_action_once(const regular_bg_ptr& regular_bg, int wait_updates, const regular_bg_map_item& map_item, Args ... map_indexes)

Generates a regular_bg_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_animate_action.

#include <bn_regular_bg_animate_actions.h>
template<typename ... Args>
auto create_regular_bg_animate_action_once(regular_bg_ptr&& regular_bg, int wait_updates, const regular_bg_map_item& map_item, Args ... map_indexes)

Generates a regular_bg_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 map_item.
Returns The requested regular_bg_animate_action.

#include <bn_regular_bg_animate_actions.h>
template<typename ... Args>
auto create_regular_bg_animate_action_forever(const regular_bg_ptr& regular_bg, int wait_updates, const regular_bg_map_item& map_item, Args ... map_indexes)

Generates a regular_bg_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_animate_action.

#include <bn_regular_bg_animate_actions.h>
template<typename ... Args>
auto create_regular_bg_animate_action_forever(regular_bg_ptr&& regular_bg, int wait_updates, const regular_bg_map_item& map_item, Args ... map_indexes)

Generates a regular_bg_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 map_item.
Returns The requested regular_bg_animate_action.

#include <bn_regular_bg_animate_actions.h>
template<typename ... Args>
auto create_regular_bg_cached_animate_action_once(const regular_bg_ptr& regular_bg, int wait_updates, const regular_bg_map_item& map_item, Args ... 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.

#include <bn_regular_bg_animate_actions.h>
template<typename ... Args>
auto create_regular_bg_cached_animate_action_once(regular_bg_ptr&& regular_bg, int wait_updates, const regular_bg_map_item& map_item, Args ... 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 map_item.
Returns The requested regular_bg_cached_animate_action.

#include <bn_regular_bg_animate_actions.h>
template<typename ... Args>
auto create_regular_bg_cached_animate_action_forever(const regular_bg_ptr& regular_bg, int wait_updates, const regular_bg_map_item& map_item, Args ... 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.

#include <bn_regular_bg_animate_actions.h>
template<typename ... Args>
auto create_regular_bg_cached_animate_action_forever(regular_bg_ptr&& regular_bg, int wait_updates, const regular_bg_map_item& map_item, Args ... 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 map_item.
Returns The requested regular_bg_cached_animate_action.