class
#include <bn_affine_bg_attributes.h>
affine_bg_attributes Manages the attributes to commit to the GBA register of an affine background.
Constructors, destructors, conversion operators
-
affine_bg_attributes(const affine_
bg_ map_ ptr& map, int priority, bool wrapping_enabled, bool mosaic_enabled) - Constructor.
-
affine_bg_attributes(affine_
bg_ map_ ptr&& map, int priority, bool wrapping_enabled, bool mosaic_enabled) - Constructor.
Public functions
-
auto map() const -> const affine_
bg_ map_ ptr& - Returns the affine_
bg_ map_ ptr of an affine background. -
void set_map(const affine_
bg_ map_ ptr& map) - Sets the affine_
bg_ map_ ptr of an affine background. -
void set_map(affine_
bg_ map_ ptr&& map) - Sets the affine_
bg_ map_ ptr of an affine background. - auto priority() const -> int
- Returns the priority of an affine background relative to sprites and other backgrounds.
- void set_priority(int priority)
- Sets the priority of an affine background relative to sprites and other backgrounds.
- auto wrapping_enabled() const -> bool
- Indicates if an affine background wraps around at the edges or not.
- void set_wrapping_enabled(bool wrapping_enabled)
- Sets if an affine background must wrap around at the edges or not.
- auto mosaic_enabled() const -> bool
- Indicates if the mosaic effect is applied to an affine background or not.
- void set_mosaic_enabled(bool mosaic_enabled)
- Sets if the mosaic effect must be applied to an affine background or not.
Friends
-
auto operator==(const affine_
bg_ attributes& a, const affine_ bg_ attributes& b) -> bool defaulted - Default equal operator.
Function documentation
bn:: affine_bg_attributes:: affine_bg_attributes(const affine_ bg_ map_ ptr& map,
int priority,
bool wrapping_enabled,
bool mosaic_enabled)
Constructor.
Parameters | |
---|---|
map | affine_ |
priority | Priority of an affine background relative to sprites and other backgrounds, in the range [0..3]. |
wrapping_enabled | Indicates if an affine background wraps around at the edges or not. |
mosaic_enabled | Indicates if the mosaic effect is applied to an affine background or not. |
Backgrounds with higher priority are drawn first (and therefore can be covered by later sprites and backgrounds).
bn:: affine_bg_attributes:: affine_bg_attributes(affine_ bg_ map_ ptr&& map,
int priority,
bool wrapping_enabled,
bool mosaic_enabled)
Constructor.
Parameters | |
---|---|
map | affine_ |
priority | Priority of an affine background relative to sprites and other backgrounds, in the range [0..3]. |
wrapping_enabled | Indicates if an affine background wraps around at the edges or not. |
mosaic_enabled | Indicates if the mosaic effect is applied to an affine background or not. |
Backgrounds with higher priority are drawn first (and therefore can be covered by later sprites and backgrounds).
void bn:: affine_bg_attributes:: set_map(const affine_ bg_ map_ ptr& map)
Sets the affine_
Parameters | |
---|---|
map | affine_ |
void bn:: affine_bg_attributes:: set_map(affine_ bg_ map_ ptr&& map)
Sets the affine_
Parameters | |
---|---|
map | affine_ |
int bn:: affine_bg_attributes:: priority() const
Returns the priority of an affine background relative to sprites and other backgrounds.
Backgrounds with higher priority are drawn first (and therefore can be covered by later sprites and backgrounds).
void bn:: affine_bg_attributes:: set_priority(int priority)
Sets the priority of an affine background relative to sprites and other backgrounds.
Parameters | |
---|---|
priority | Priority in the range [0..3]. |
Backgrounds with higher priority are drawn first (and therefore can be covered by later sprites and backgrounds).