Display » Backgrounds » Background maps module

Also called tile-maps, backgrounds use them to refer to the tile to render in each 8x8 pixel block.

Files

file bn_affine_bg_animate_actions.h
file bn_affine_bg_animate_actions_fwd.h
file bn_affine_bg_big_map_canvas_size.h
file bn_affine_bg_map_cell.h
file bn_affine_bg_map_cell_info.h
file bn_affine_bg_map_item.h
file bn_affine_bg_map_ptr.h
file bn_bg_maps.h
file bn_bg_palette_actions.h
file bn_regular_bg_animate_actions.h
file bn_regular_bg_animate_actions_fwd.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

Namespaces

namespace bn
Main Butano namespace.
namespace bn::bg_maps
Background maps related functions.

Classes

class bn::iaffine_bg_animate_action
Base class of bn::affine_bg_animate_action.
class bn::iaffine_bg_cached_animate_action
Base class of bn::affine_bg_cached_animate_action.
template<int MaxSize>
class bn::affine_bg_animate_action
Changes the map of an affine_bg_ptr when the action is updated a given number of times.
template<int MaxSize>
class bn::affine_bg_cached_animate_action
Changes the map of an affine_bg_ptr when the action is updated a given number of times.
class bn::affine_bg_map_item
Contains the required information to generate affine background maps.
class bn::affine_bg_map_ptr
std::shared_ptr like smart pointer that retains shared ownership of an affine background map.
template<>
struct bn::hash<affine_bg_map_ptr>
Hash support for affine_bg_map_ptr.
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_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.

Enums

enum class affine_bg_big_map_canvas_size: uint8_t { NORMAL, BIG, HUGE }
Available affine background map canvas sizes enum.

Enum documentation

enum class affine_bg_big_map_canvas_size: uint8_t
#include <bn_affine_bg_big_map_canvas_size.h>

Available affine background map canvas sizes enum.

Enumerators
NORMAL

256x256 pixels.
BIG

512x512 pixels.
HUGE

1024x1024 pixels.