bn::blending namespace
#include <bn_blending.h>

Blending related functions.

Enums

enum class fade_color_type: uint8_t { BLACK, WHITE }
Available fade colors.

Functions

auto transparency_alpha() -> fixed
Returns the weight of the transparency blending, with 0 being fully transparent and 1 being fully visible.
void set_transparency_alpha(fixed transparency_alpha)
Sets the weight of the transparency blending, with 0 being fully transparent and 1 being fully visible.
auto intensity_alpha() -> fixed
Returns the weight of the intensity blending, with 0 being disabled and 1 being fully applied.
void set_intensity_alpha(fixed intensity_alpha)
Sets the weight of the intensity blending, with 0 being disabled and 1 being fully applied.
void set_transparency_and_intensity_alpha(fixed transparency_alpha, fixed intensity_alpha)
Sets the weights of the transparency and the intensity blendings.
auto transparency_top_weight() -> fixed
Returns the weight of the transparency blending for the top layer, with 0 being fully transparent and 1 being fully visible.
void set_transparency_top_weight(fixed transparency_top_weight)
Sets the weight of the transparency blending for the top layer, with 0 being fully transparent and 1 being fully visible.
auto transparency_bottom_weight() -> fixed
Returns the weight of the transparency blending for the bottom layer, with 0 being fully transparent and 1 being fully visible.
void set_transparency_bottom_weight(fixed transparency_bottom_weight)
Sets the weight of the transparency blending for the bottom layer, with 0 being fully transparent and 1 being fully visible.
void set_transparency_weights(fixed transparency_top_weight, fixed transparency_bottom_weight)
Sets the weights of the transparency blending, with 0 being fully transparent and 1 being fully visible.
auto transparency_attributes() -> blending_transparency_attributes
Returns the attributes to commit to the GBA transparency and intensity blending register.
void set_transparency_attributes(const blending_transparency_attributes& transparency_attributes)
Sets the attributes to commit to the GBA transparency and intensity blending register.
auto fade_color() -> fade_color_type
Returns the color used for fade blending.
void set_fade_color(fade_color_type fade_color)
Sets the color used for fade blending.
void set_black_fade_color()
Sets black as the color used for fade blending.
void set_white_fade_color()
Sets white as the color used for fade blending.
auto fade_alpha() -> fixed
Returns the weight of the fade blending, with 0 being disabled and 1 being fully applied.
void set_fade_alpha(fixed fade_alpha)
Sets the weight of the fade blending, with 0 being disabled and 1 being fully applied.
void set_fade_alpha(blending_fade_alpha fade_alpha)
Sets the weight of the fade blending, with 0 being disabled and 1 being fully applied.
void restore()
Restores blending to its initial state.

Enum documentation

enum class bn::blending::fade_color_type: uint8_t

Available fade colors.

Enumerators
BLACK

Black fade color.
WHITE

White fade color.

Function documentation

void bn::blending::set_transparency_alpha(fixed transparency_alpha)

Sets the weight of the transparency blending, with 0 being fully transparent and 1 being fully visible.

Parameters
transparency_alpha Transparency weight in the range [0..1].

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

void bn::blending::set_intensity_alpha(fixed intensity_alpha)

Sets the weight of the intensity blending, with 0 being disabled and 1 being fully applied.

Parameters
intensity_alpha Intensity weight in the range [0..1].

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

void bn::blending::set_transparency_and_intensity_alpha(fixed transparency_alpha, fixed intensity_alpha)

Sets the weights of the transparency and the intensity blendings.

Parameters
transparency_alpha Transparency weight in the range [0..1], with 0 being fully transparent and 1 being fully visible.
intensity_alpha Intensity weight in the range [0..1], with 0 being disabled and 1 being fully applied.

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

void bn::blending::set_transparency_top_weight(fixed transparency_top_weight)

Sets the weight of the transparency blending for the top layer, with 0 being fully transparent and 1 being fully visible.

Parameters
transparency_top_weight Transparency weight in the range [0..1].

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

void bn::blending::set_transparency_bottom_weight(fixed transparency_bottom_weight)

Sets the weight of the transparency blending for the bottom layer, with 0 being fully transparent and 1 being fully visible.

Parameters
transparency_bottom_weight Transparency weight in the range [0..1].

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

void bn::blending::set_transparency_weights(fixed transparency_top_weight, fixed transparency_bottom_weight)

Sets the weights of the transparency blending, with 0 being fully transparent and 1 being fully visible.

Parameters
transparency_top_weight Transparency weight in the range [0..1].
transparency_bottom_weight Transparency weight in the range [0..1].

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

void bn::blending::set_fade_alpha(fixed fade_alpha)

Sets the weight of the fade blending, with 0 being disabled and 1 being fully applied.

Parameters
fade_alpha Fade weight in the range [0..1].

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

void bn::blending::set_fade_alpha(blending_fade_alpha fade_alpha)

Sets the weight of the fade blending, with 0 being disabled and 1 being fully applied.

Parameters
fade_alpha blending_fade_alpha to set.

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