Display » Backgrounds module

Big graphics layers.

Depending of their type, the GBA offers up to 4 of them.

Modules

module Background maps
module Regular backgrounds
module Affine backgrounds

Files

file bn_bg_palette_color_hbe_ptr.h
file bn_bg_palette_item.h
file bn_bg_palette_ptr.h
file bn_bg_palettes.h
file bn_bg_palettes_actions.h
file bn_bg_palettes_transparent_color_hbe_ptr.h
file bn_bg_tiles.h
file bn_bgs.h
file bn_bgs_mosaic.h
file bn_bgs_mosaic_actions.h
file bn_config_bg_blocks.h
file bn_config_bgs.h

Namespaces

namespace bn: Main Butano namespace.
namespace bn::bg_palettes: Background color palettes related functions.
namespace bn::bg_tiles: Background tiles related functions.
namespace bn::bgs: Backgrounds related functions.
namespace bn::bgs_mosaic: Functions related with the mosaic applied to the backgrounds.

Classes

class bn::bg_palette_inverted_manager: Manages if the colors of a bg_palette_ptr must be inverted or not.
class bn::bg_palette_inverted_toggle_action: Toggles if the colors of a bg_palette_ptr must be inverted or not when the action is updated a given number of times.
class bn::bg_palette_grayscale_manager: Manages the intensity of the grayscale effect applied to a bg_palette_ptr.
class bn::bg_palette_grayscale_to_action: Modifies the intensity of the grayscale effect applied to a bg_palette_ptr until it has a given state.
class bn::bg_palette_grayscale_loop_action: Modifies the intensity of the grayscale effect applied to a bg_palette_ptr from a minimum to a maximum. When the intensity is equal to the given final state, it goes back to its initial state and vice versa.
class bn::bg_palette_grayscale_toggle_action: Changes the intensity of the grayscale effect applied to a bg_palette_ptr when the action is updated a given number of times.
class bn::bg_palette_hue_shift_manager: Manages the intensity of the hue shift effect applied to a bg_palette_ptr.
class bn::bg_palette_hue_shift_to_action: Modifies the intensity of the hue shift effect applied to a bg_palette_ptr until it has a given state.
class bn::bg_palette_hue_shift_loop_action: Modifies the intensity of the hue shift effect applied to a bg_palette_ptr from a minimum to a maximum. When the intensity is equal to the given final state, it goes back to its initial state and vice versa.
class bn::bg_palette_hue_shift_toggle_action: Changes the intensity of the hue shift effect applied to a bg_palette_ptr when the action is updated a given number of times.
class bn::bg_palette_fade_manager: Manages the intensity of the fade effect applied to a bg_palette_ptr.
class bn::bg_palette_fade_to_action: Modifies the intensity of the fade effect applied to a bg_palette_ptr until it has a given state.
class bn::bg_palette_fade_loop_action: Modifies the intensity of the fade effect applied to a bg_palette_ptr from a minimum to a maximum. When the intensity is equal to the given final state, it goes back to its initial state and vice versa.
class bn::bg_palette_fade_toggle_action: Changes the intensity of the fade effect applied to a bg_palette_ptr when the action is updated a given number of times.
class bn::bg_palette_rotate_manager: Manages the number of colors to rotate to the right in a bg_palette_ptr.
class bn::bg_palette_rotate_by_action: Modifies the number of colors to rotate to the right in a bg_palette_ptr by delta_count when the action is updated a given number of times. When the property is over the given maximum, it goes back to the given minimum and vice versa.
class bn::bg_palette_rotate_to_action: Modifies the number of colors to rotate to the right in a bg_palette_ptr until it has a given state.
class bn::bg_palette_rotate_loop_action: Modifies the number of colors to rotate to the right in a bg_palette_ptr from a minimum to a maximum. When the number of colors to rotate to the right is equal to the given final state, it goes back to its initial state and vice versa.
class bn::bg_palette_rotate_toggle_action: Changes the number of colors to rotate to the right in a bg_palette_ptr when the action is updated a given number of times.
class bn::bg_palette_color_hbe_ptr: std::shared_ptr like smart pointer that retains shared ownership of a H-Blank effect which changes the color of a background color palette in each screen horizontal line.
class bn::bg_palette_item: Contains the required information to generate background color palettes.
class bn::bg_palette_ptr: std::shared_ptr like smart pointer that retains shared ownership of a background color palette.
template<> struct bn::hash<bg_palette_ptr>: Hash support for bg_palette_ptr.
class bn::bg_palettes_brightness_manager: Manages the brightness of all background color palettes.
class bn::bg_palettes_brightness_to_action: Modifies the brightness of all background color palettes until it has a given state.
class bn::bg_palettes_brightness_loop_action: Modifies the brightness of all background color palettes from a minimum to a maximum. When the brightness is equal to the given final state, it goes back to its initial state and vice versa.
class bn::bg_palettes_brightness_toggle_action: Changes the brightness of all background color palettes when the action is updated a given number of times.
class bn::bg_palettes_contrast_manager: Manages the contrast of all background color palettes.
class bn::bg_palettes_contrast_to_action: Modifies the contrast of all background color palettes until it has a given state.
class bn::bg_palettes_contrast_loop_action: Modifies the contrast of all background color palettes from a minimum to a maximum. When the contrast is equal to the given final state, it goes back to its initial state and vice versa.
class bn::bg_palettes_contrast_toggle_action: Changes the contrast of all background color palettes when the action is updated a given number of times.
class bn::bg_palettes_intensity_manager: Manages the intensity of all background color palettes.
class bn::bg_palettes_intensity_to_action: Modifies the intensity of all background color palettes until it has a given state.
class bn::bg_palettes_intensity_loop_action: Modifies the intensity of all background color palettes from a minimum to a maximum. When the intensity is equal to the given final state, it goes back to its initial state and vice versa.
class bn::bg_palettes_intensity_toggle_action: Changes the intensity of all background color palettes when the action is updated a given number of times.
class bn::bg_palettes_inverted_manager: Manages if the colors of all background color palettes must be inverted or not.
class bn::bg_palettes_inverted_toggle_action: Toggles if the colors of all background color palettes must be inverted or not when the action is updated a given number of times.
class bn::bg_palettes_grayscale_manager: Manages the intensity of the grayscale effect applied to all background color palettes.
class bn::bg_palettes_grayscale_to_action: Modifies the intensity of the grayscale effect applied to all background color palettes until it has a given state.
class bn::bg_palettes_grayscale_loop_action: Modifies the intensity of the grayscale effect applied to all background color palettes from a minimum to a maximum. When the intensity is equal to the given final state, it goes back to its initial state and vice versa.
class bn::bg_palettes_grayscale_toggle_action: Changes the intensity of the grayscale effect applied to all background color palettes when the action is updated a given number of times.
class bn::bg_palettes_hue_shift_manager: Manages the intensity of the hue shift effect applied to all background color palettes.
class bn::bg_palettes_hue_shift_to_action: Modifies the intensity of the hue shift effect applied to all background color palettes until it has a given state.
class bn::bg_palettes_hue_shift_loop_action: Modifies the intensity of the hue shift effect applied to all background color palettes from a minimum to a maximum. When the intensity is equal to the given final state, it goes back to its initial state and vice versa.
class bn::bg_palettes_hue_shift_toggle_action: Changes the intensity of the hue shift effect applied to all background color palettes when the action is updated a given number of times.
class bn::bg_palettes_fade_manager: Manages the intensity of the fade effect applied to all background color palettes.
class bn::bg_palettes_fade_to_action: Modifies the intensity of the fade effect applied to all background color palettes until it has a given state.
class bn::bg_palettes_fade_loop_action: Modifies the intensity of the fade effect applied to all background color palettes from a minimum to a maximum. When the intensity is equal to the given final state, it goes back to its initial state and vice versa.
class bn::bg_palettes_fade_toggle_action: Changes the intensity of the fade effect applied to all background color palettes when the action is updated a given number of times.
class bn::bg_palettes_transparent_color_hbe_ptr: std::shared_ptr like smart pointer that retains shared ownership of a H-Blank effect which changes the transparent color of the backgrounds in each screen horizontal line.
class bn::bgs_mosaic_horizontal_stretch_manager: Manages the horizontal stretch of the mosaic applied to the backgrounds.
class bn::bgs_mosaic_horizontal_stretch_to_action: Modifies the horizontal stretch of the mosaic applied to the backgrounds until it has a given state.
class bn::bgs_mosaic_horizontal_stretch_loop_action: Modifies the horizontal stretch of the mosaic applied to the backgrounds from a minimum to a maximum. When the horizontal stretch is equal to the given final state, it goes back to its initial state and vice versa.
class bn::bgs_mosaic_horizontal_stretch_toggle_action: Changes the horizontal stretch of the mosaic applied to the backgrounds when the action is updated a given number of times.
class bn::bgs_mosaic_vertical_stretch_manager: Manages the vertical stretch of the mosaic applied to the backgrounds.
class bn::bgs_mosaic_vertical_stretch_to_action: Modifies the vertical stretch of the mosaic applied to the backgrounds until it has a given state.
class bn::bgs_mosaic_vertical_stretch_loop_action: Modifies the vertical stretch of the mosaic applied to the backgrounds from a minimum to a maximum. When the vertical stretch is equal to the given final state, it goes back to its initial state and vice versa.
class bn::bgs_mosaic_vertical_stretch_toggle_action: Changes the vertical stretch of the mosaic applied to the backgrounds when the action is updated a given number of times.
class bn::bgs_mosaic_stretch_manager: Manages the stretch of the mosaic applied to the backgrounds.
class bn::bgs_mosaic_stretch_to_action: Modifies the stretch of the mosaic applied to the backgrounds until it has a given state.
class bn::bgs_mosaic_stretch_loop_action: Modifies the stretch of the mosaic applied to the backgrounds from a minimum to a maximum. When the stretch is equal to the given final state, it goes back to its initial state and vice versa.
class bn::bgs_mosaic_stretch_toggle_action: Changes the stretch of the mosaic applied to the backgrounds when the action is updated a given number of times.