bn::backdrop_color_hbe_ptr class
#include <bn_backdrop_color_hbe_ptr.h>

std::shared_ptr like smart pointer that retains shared ownership of a H-Blank effect which changes the backdrop color in each screen horizontal line.

The backdrop color is the transparent color of the backgrounds.

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(const span<const color>& colors_ref) -> backdrop_color_hbe_ptr
Creates a backdrop_color_hbe_ptr which changes the backdrop color in each screen horizontal line.
static auto create_optional(const span<const color>& colors_ref) -> optional<backdrop_color_hbe_ptr>
Creates a backdrop_color_hbe_ptr which changes the backdrop color in each screen horizontal line.

Public functions

auto colors_ref() const -> span<const color>
Returns the referenced array of 160 color objects which indicate the backdrop color in each screen horizontal line.
void set_colors_ref(const span<const color>& colors_ref)
Sets the reference to an array of 160 color objects which indicate the backdrop color in each screen horizontal line.
void reload_colors_ref()
Rereads the content of the referenced color objects which indicate the backdrop color in each screen horizontal line.
void swap(backdrop_color_hbe_ptr& other)
Exchanges the contents of this backdrop_color_hbe_ptr with those of the other one.

Friends

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

Function documentation

static backdrop_color_hbe_ptr bn::backdrop_color_hbe_ptr::create(const span<const color>& colors_ref)

Creates a backdrop_color_hbe_ptr which changes the backdrop color in each screen horizontal line.

Parameters
colors_ref Reference to an array of 160 color objects which indicate the backdrop color in each screen horizontal line.
Returns The requested backdrop_color_hbe_ptr.

The colors are not copied but referenced, so they should outlive the backdrop_color_hbe_ptr to avoid dangling references.

static optional<backdrop_color_hbe_ptr> bn::backdrop_color_hbe_ptr::create_optional(const span<const color>& colors_ref)

Creates a backdrop_color_hbe_ptr which changes the backdrop color in each screen horizontal line.

Parameters
colors_ref Reference to an array of 160 color objects which indicate the backdrop color in each screen horizontal line.
Returns The requested backdrop_color_hbe_ptr if it could be allocated; bn::nullopt otherwise.

The colors are not copied but referenced, so they should outlive the backdrop_color_hbe_ptr to avoid dangling references.

span<const color> bn::backdrop_color_hbe_ptr::colors_ref() const

Returns the referenced array of 160 color objects which indicate the backdrop color in each screen horizontal line.

The colors are not copied but referenced, so they should outlive the backdrop_color_hbe_ptr to avoid dangling references.

void bn::backdrop_color_hbe_ptr::set_colors_ref(const span<const color>& colors_ref)

Sets the reference to an array of 160 color objects which indicate the backdrop color in each screen horizontal line.

The colors are not copied but referenced, so they should outlive the backdrop_color_hbe_ptr to avoid dangling references.

void bn::backdrop_color_hbe_ptr::reload_colors_ref()

Rereads the content of the referenced color objects which indicate the backdrop color in each screen horizontal line.

The colors are not copied but referenced, so they should outlive the backdrop_color_hbe_ptr to avoid dangling references.

void bn::backdrop_color_hbe_ptr::swap(backdrop_color_hbe_ptr& other)

Exchanges the contents of this backdrop_color_hbe_ptr with those of the other one.

Parameters
other backdrop_color_hbe_ptr to exchange the contents with.

void swap(backdrop_color_hbe_ptr& a, backdrop_color_hbe_ptr& b)

Exchanges the contents of a backdrop_color_hbe_ptr with those of another one.

Parameters
a First backdrop_color_hbe_ptr to exchange the contents with.
b Second backdrop_color_hbe_ptr to exchange the contents with.