bn::bg_palette_color_hbe_ptr class
#include <bn_bg_palette_color_hbe_ptr.h>

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.

Base classes

class hbe_ptr: std::shared_ptr like smart pointer that retains shared ownership of a H-Blank effect.

Public static functions

static auto create(bg_palette_ptr palette, int color_index, const span<const color>& colors_ref) -> bg_palette_color_hbe_ptr: Creates a bg_palette_color_hbe_ptr which changes the color of a background color palette in each screen horizontal line.
static auto create_optional(bg_palette_ptr palette, int color_index, const span<const color>& colors_ref) -> optional<bg_palette_color_hbe_ptr>: Creates a bg_palette_color_hbe_ptr which changes the color of a background color palette in each screen horizontal line.

Public functions

auto palette() const -> const bg_palette_ptr&: Returns the background color palette modified by this H-Blank effect.
auto color_index() const -> int: Returns the index of the color of the given background color palette to be modified.
auto colors_ref() const -> span<const color>: Returns the referenced array of 160 colors to set to the color of a background color palette in each screen horizontal line.
void set_colors_ref(const span<const color>& colors_ref): Sets the reference to an array of 160 colors to set to the color of a background color palette in each screen horizontal line.
void reload_colors_ref(): Rereads the content of the referenced colors to set to the color of a background color palette in each screen horizontal line.
void swap(bg_palette_color_hbe_ptr& other): Exchanges the contents of this bg_palette_color_hbe_ptr with those of the other one.

Friends

void swap(bg_palette_color_hbe_ptr& a, bg_palette_color_hbe_ptr& b): Exchanges the contents of a bg_palette_color_hbe_ptr with those of another one.

Function documentation

static bg_palette_color_hbe_ptr bn::bg_palette_color_hbe_ptr::create(bg_palette_ptr palette, int color_index, const span<const color>& colors_ref)

Creates a bg_palette_color_hbe_ptr which changes the color of a background color palette in each screen horizontal line.

Parameters
palette	Background color palette to be modified.
color_index	Index of the color of the given background color palette to be modified.
colors_ref	Reference to an array of 160 colors to set to the color of a background color palette in each screen horizontal line.
Returns	The requested bg_palette_color_hbe_ptr.