bn::sprite_first_attributes class

Manages the attributes to commit to the first GBA register of a sprite.

Constructors, destructors, conversion operators

sprite_first_attributes(fixed y, bool mosaic_enabled, bool blending_enabled, bool window_enabled, bool visible) constexpr
Constructor.

Public functions

auto y() const -> fixed constexpr
Returns the vertical position of a sprite (relative to its camera, if it has one).
void set_y(fixed y) constexpr
Sets the vertical position of a sprite (relative to its camera, if it has one).
auto mosaic_enabled() const -> bool constexpr
Indicates if the mosaic effect is applied to a sprite or not.
void set_mosaic_enabled(bool mosaic_enabled) constexpr
Sets if the mosaic effect is applied to a sprite or not.
auto blending_enabled() const -> bool constexpr
Indicates if blending is applied to a sprite or not.
void set_blending_enabled(bool blending_enabled) constexpr
Sets if blending is applied to a sprite or not.
auto window_enabled() const -> bool constexpr
Indicates if a sprite must be part of the silhouette of the sprite window or not.
void set_window_enabled(bool window_enabled) constexpr
Sets if a sprite must be part of the silhouette of the sprite window or not.
auto visible() const -> bool constexpr
Indicates if a sprite must be committed to the GBA or not.
void set_visible(bool visible) constexpr
Sets if a sprite must be committed to the GBA or not.

Friends

auto operator==(const sprite_first_attributes& a, const sprite_first_attributes& b) -> friend bool defaulted constexpr
Default equal operator.

Function documentation

bn::sprite_first_attributes::sprite_first_attributes(fixed y, bool mosaic_enabled, bool blending_enabled, bool window_enabled, bool visible) constexpr

Constructor.

Parameters
y Vertical position of a sprite (relative to its camera, if it has one).
mosaic_enabled Indicates if the mosaic effect is applied to a sprite or not.
blending_enabled Indicates if blending is applied to a sprite or not.
window_enabled Indicates if a sprite must be part of the silhouette of the sprite window or not.
visible Indicates if a sprite must be committed to the GBA or not.

Keep in mind that blending and window attributes can't be enabled in a sprite at the same time.

void bn::sprite_first_attributes::set_blending_enabled(bool blending_enabled) constexpr

Sets if blending is applied to a sprite or not.

Keep in mind that blending and window attributes can't be enabled in a sprite at the same time.

void bn::sprite_first_attributes::set_window_enabled(bool window_enabled) constexpr

Sets if a sprite must be part of the silhouette of the sprite window or not.

Keep in mind that blending and window attributes can't be enabled in a sprite at the same time.