bn::sprite_first_attributes_hbe_ptr class
#include <bn_sprite_first_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 first GBA register of a sprite 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(sprite_ptr sprite, const span<const sprite_first_attributes>& attributes_ref) -> sprite_first_attributes_hbe_ptr
Creates a sprite_first_attributes_hbe_ptr which changes the attributes to commit to the first GBA register of a sprite in each screen horizontal line.
static auto create_optional(sprite_ptr sprite, const span<const sprite_first_attributes>& attributes_ref) -> optional<sprite_first_attributes_hbe_ptr>
Creates a sprite_first_attributes_hbe_ptr which changes the attributes to commit to the first GBA register of a sprite in each screen horizontal line.

Public functions

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

Friends

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

Function documentation

static sprite_first_attributes_hbe_ptr bn::sprite_first_attributes_hbe_ptr::create(sprite_ptr sprite, const span<const sprite_first_attributes>& attributes_ref)

Creates a sprite_first_attributes_hbe_ptr which changes the attributes to commit to the first GBA register of a sprite in each screen horizontal line.

Parameters
sprite Sprite to be modified.
attributes_ref Reference to an array of 160 sprite_first_attributes objects with the attributes to commit to the first GBA register of the given sprite in each screen horizontal line.
Returns The requested sprite_first_attributes_hbe_ptr.

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

static optional<sprite_first_attributes_hbe_ptr> bn::sprite_first_attributes_hbe_ptr::create_optional(sprite_ptr sprite, const span<const sprite_first_attributes>& attributes_ref)

Creates a sprite_first_attributes_hbe_ptr which changes the attributes to commit to the first GBA register of a sprite in each screen horizontal line.

Parameters
sprite Sprite to be modified.
attributes_ref Reference to an array of 160 sprite_first_attributes objects with the attributes to commit to the first GBA register of the given sprite in each screen horizontal line.
Returns The requested sprite_first_attributes_hbe_ptr if it could be allocated; bn::nullopt otherwise.

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

span<const sprite_first_attributes> bn::sprite_first_attributes_hbe_ptr::attributes_ref() const

Returns the referenced array of 160 sprite_first_attributes objects with the attributes to commit to the first GBA register of the managed sprite in each screen horizontal line.

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

void bn::sprite_first_attributes_hbe_ptr::set_attributes_ref(const span<const sprite_first_attributes>& attributes_ref)

Sets the reference to an array of 160 sprite_first_attributes objects with the attributes to commit to the first GBA register of the managed sprite in each screen horizontal line.

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

void bn::sprite_first_attributes_hbe_ptr::reload_attributes_ref()

Rereads the content of the referenced attributes to commit to the first GBA register of the managed sprite in each screen horizontal line.

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

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

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

Parameters
other sprite_first_attributes_hbe_ptr to exchange the contents with.

void swap(sprite_first_attributes_hbe_ptr& a, sprite_first_attributes_hbe_ptr& b)

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

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