bn::blending_fade_alpha_hbe_ptr class
#include <bn_blending_fade_alpha_hbe_ptr.h>

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

Keep in mind that fade blending and other blendings can't be enabled at the same time.

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 blending_fade_alpha>& alphas_ref) -> blending_fade_alpha_hbe_ptr
Creates a blending_fade_alpha_hbe_ptr which changes the weight of the fade blending in each screen horizontal line.
static auto create_optional(const span<const blending_fade_alpha>& alphas_ref) -> optional<blending_fade_alpha_hbe_ptr>
Creates a blending_fade_alpha_hbe_ptr which changes the weight of the fade blending in each screen horizontal line.

Public functions

auto alphas_ref() const -> span<const blending_fade_alpha>
Returns the referenced array of 160 blending_fade_alpha objects which indicate the weight of the fade blending in each screen horizontal line.
void set_alphas_ref(const span<const blending_fade_alpha>& alphas_ref)
Sets the reference to an array of 160 blending_fade_alpha objects which indicate the weight of the fade blending in each screen horizontal line.
void reload_alphas_ref()
Rereads the content of the referenced blending_fade_alpha objects which indicate the weight of the fade blending in each screen horizontal line.
void swap(blending_fade_alpha_hbe_ptr& other)
Exchanges the contents of this blending_fade_alpha_hbe_ptr with those of the other one.

Friends

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

Function documentation

static blending_fade_alpha_hbe_ptr bn::blending_fade_alpha_hbe_ptr::create(const span<const blending_fade_alpha>& alphas_ref)

Creates a blending_fade_alpha_hbe_ptr which changes the weight of the fade blending in each screen horizontal line.

Parameters
alphas_ref Reference to an array of 160 blending_fade_alpha objects which indicate the weight of the fade blending in each screen horizontal line.
Returns The requested blending_fade_alpha_hbe_ptr.

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

static optional<blending_fade_alpha_hbe_ptr> bn::blending_fade_alpha_hbe_ptr::create_optional(const span<const blending_fade_alpha>& alphas_ref)

Creates a blending_fade_alpha_hbe_ptr which changes the weight of the fade blending in each screen horizontal line.

Parameters
alphas_ref Reference to an array of 160 blending_fade_alpha objects which indicate the weight of the fade blending in each screen horizontal line.
Returns The requested blending_fade_alpha_hbe_ptr if it could be allocated; bn::nullopt otherwise.

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

span<const blending_fade_alpha> bn::blending_fade_alpha_hbe_ptr::alphas_ref() const

Returns the referenced array of 160 blending_fade_alpha objects which indicate the weight of the fade blending in each screen horizontal line.

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

void bn::blending_fade_alpha_hbe_ptr::set_alphas_ref(const span<const blending_fade_alpha>& alphas_ref)

Sets the reference to an array of 160 blending_fade_alpha objects which indicate the weight of the fade blending in each screen horizontal line.

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

void bn::blending_fade_alpha_hbe_ptr::reload_alphas_ref()

Rereads the content of the referenced blending_fade_alpha objects which indicate the weight of the fade blending in each screen horizontal line.

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

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

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

Parameters
other blending_fade_alpha_hbe_ptr to exchange the contents with.

void swap(blending_fade_alpha_hbe_ptr& a, blending_fade_alpha_hbe_ptr& b)

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

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