bn::affine_bg_mat_attributes_hbe_ptr class
#include <bn_affine_bg_mat_attributes_hbe_ptr.h>

std::shared_ptr like smart pointer that retains shared ownership of a H-Blank effect which changes the attributes which define the position and the transformation matrix of an affine_bg_ptr in each screen horizontal line.

Public static functions

static auto create(const affine_bg_ptr& bg, const span<const affine_bg_mat_attributes>& attributes_ref) -> affine_bg_mat_attributes_hbe_ptr: Creates an affine_bg_mat_attributes_hbe_ptr which changes the attributes which define the position and the transformation matrix of an affine_bg_ptr in each screen horizontal line.
static auto create_optional(const affine_bg_ptr& bg, const span<const affine_bg_mat_attributes>& attributes_ref) -> optional<affine_bg_mat_attributes_hbe_ptr>: Creates an affine_bg_mat_attributes_hbe_ptr which changes the attributes which define the position and the transformation matrix of an affine_bg_ptr in each screen horizontal line.

Public functions

auto id() const -> int: Returns the internal id.
auto visible() const -> bool: Indicates if this H-Blank effect must be committed to the GBA or not.
void set_visible(bool visible): Sets if this H-Blank effect must be committed to the GBA or not.
auto bg() const -> const affine_bg_ptr&: Returns the affine_bg_ptr modified by this H-Blank effect.
auto attributes_ref() const -> span<const affine_bg_mat_attributes>: Returns the referenced array of 160 affine_bg_mat_attributes objects to set to the given affine_bg_ptr in each screen horizontal line.
void set_attributes_ref(const span<const affine_bg_mat_attributes>& attributes_ref): Sets the reference to an array of 160 affine_bg_mat_attributes objects to set to the given affine_bg_ptr in each screen horizontal line.
void reload_attributes_ref(): Rereads the content of the referenced attributes to set to the given affine_bg_ptr in each screen horizontal line.
void swap(affine_bg_mat_attributes_hbe_ptr& other): Exchanges the contents of this affine_bg_mat_attributes_hbe_ptr with those of the other one.

Friends

void swap(affine_bg_mat_attributes_hbe_ptr& a, affine_bg_mat_attributes_hbe_ptr& b): Exchanges the contents of an affine_bg_mat_attributes_hbe_ptr with those of another one.
auto operator==(const affine_bg_mat_attributes_hbe_ptr& a, const affine_bg_mat_attributes_hbe_ptr& b) -> bool: Equal operator.
auto operator!=(const affine_bg_mat_attributes_hbe_ptr& a, const affine_bg_mat_attributes_hbe_ptr& b) -> bool: Not equal operator.

Function documentation

static affine_bg_mat_attributes_hbe_ptr bn::affine_bg_mat_attributes_hbe_ptr::create(const affine_bg_ptr& bg, const span<const affine_bg_mat_attributes>& attributes_ref)

Creates an affine_bg_mat_attributes_hbe_ptr which changes the attributes which define the position and the transformation matrix of an affine_bg_ptr in each screen horizontal line.

Parameters
bg	affine_bg_ptr to be modified.
attributes_ref	Reference to an array of 160 affine_bg_mat_attributes objects with the attributes to set to the given affine_bg_ptr in each screen horizontal line.
Returns	The requested affine_bg_mat_attributes_hbe_ptr.