bn::regular_bg_attributes_hbe_ptr class
#include <bn_regular_bg_attributes_hbe_ptr.h>

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.

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(regular_bg_ptr bg, const span<const regular_bg_attributes>& attributes_ref) -> regular_bg_attributes_hbe_ptr
Creates a regular_bg_attributes_hbe_ptr which changes the attributes to commit to the GBA register of a regular background in each screen horizontal line.
static auto create_optional(regular_bg_ptr bg, const span<const regular_bg_attributes>& attributes_ref) -> optional<regular_bg_attributes_hbe_ptr>
Creates a regular_bg_attributes_hbe_ptr which changes the attributes to commit to the GBA register of a regular background in each screen horizontal line.

Public functions

auto bg() const -> const regular_bg_ptr&
Returns the regular background modified by this H-Blank effect.
auto attributes_ref() const -> span<const regular_bg_attributes>
Returns the referenced array of 160 regular_bg_attributes objects with the attributes to commit to the GBA register of the managed regular background in each screen horizontal line.
void set_attributes_ref(const span<const regular_bg_attributes>& attributes_ref)
Sets the reference to an array of 160 regular_bg_attributes objects with the attributes to commit to the GBA register of the managed regular background in each screen horizontal line.
void reload_attributes_ref()
Rereads the content of the referenced attributes to the GBA register of the managed regular background in each screen horizontal line.
void swap(regular_bg_attributes_hbe_ptr& other)
Exchanges the contents of this regular_bg_attributes_hbe_ptr with those of the other one.

Friends

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

Function documentation

static regular_bg_attributes_hbe_ptr bn::regular_bg_attributes_hbe_ptr::create(regular_bg_ptr bg, const span<const regular_bg_attributes>& attributes_ref)

Creates a regular_bg_attributes_hbe_ptr which changes the attributes to commit to the GBA register of a regular background in each screen horizontal line.

Parameters
bg Regular background to be modified.
attributes_ref Reference to an array of 160 regular_bg_attributes objects with the attributes to commit to the GBA register of the given regular background in each screen horizontal line.
Returns The requested regular_bg_attributes_hbe_ptr.

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

static optional<regular_bg_attributes_hbe_ptr> bn::regular_bg_attributes_hbe_ptr::create_optional(regular_bg_ptr bg, const span<const regular_bg_attributes>& attributes_ref)

Creates a regular_bg_attributes_hbe_ptr which changes the attributes to commit to the GBA register of a regular background in each screen horizontal line.

Parameters
bg Regular background to be modified.
attributes_ref Reference to an array of 160 regular_bg_attributes objects with the attributes to commit to the GBA register of the given regular background in each screen horizontal line.
Returns The requested regular_bg_attributes_hbe_ptr if it could be allocated; bn::nullopt otherwise.

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

span<const regular_bg_attributes> bn::regular_bg_attributes_hbe_ptr::attributes_ref() const

Returns the referenced array of 160 regular_bg_attributes objects with the attributes to commit to the GBA register of the managed regular background in each screen horizontal line.

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

void bn::regular_bg_attributes_hbe_ptr::set_attributes_ref(const span<const regular_bg_attributes>& attributes_ref)

Sets the reference to an array of 160 regular_bg_attributes objects with the attributes to commit to the GBA register of the managed regular background in each screen horizontal line.

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

void bn::regular_bg_attributes_hbe_ptr::reload_attributes_ref()

Rereads the content of the referenced attributes to the GBA register of the managed regular background in each screen horizontal line.

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

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

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

Parameters
other regular_bg_attributes_hbe_ptr to exchange the contents with.

void swap(regular_bg_attributes_hbe_ptr& a, regular_bg_attributes_hbe_ptr& b)

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

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