sprites namespace
#include <bn_sprites.h>
Sprites related functions.
Contents
- Reference
Functions
- auto used_items_count() -> int
- Returns the number of used sprite items created with sprite_
ptr static constructors. - auto available_items_count() -> int
- Returns the number of available sprite items that can be created with sprite_
ptr static constructors. - auto min_bg_priority() -> int constexpr
- auto max_bg_priority() -> int constexpr
- auto min_z_order() -> int constexpr
- auto max_z_order() -> int constexpr
- void reload()
- Reloads the internal attributes of all sprites.
Function documentation
int bn:: sprites:: used_items_count()
Returns the number of used sprite items created with sprite_
A sprite item which is outside of the screen or hidden is not committed to the GBA, so there can be more than 128 sprite items.
int bn:: sprites:: available_items_count()
Returns the number of available sprite items that can be created with sprite_
A sprite item which is outside of the screen or hidden is not committed to the GBA, so there can be more than 128 sprite items.
int bn:: sprites:: min_bg_priority() constexpr
| Returns | Returns the minimum priority of a sprite relative to backgrounds. |
|---|
int bn:: sprites:: max_bg_priority() constexpr
| Returns | Returns the maximum priority of a sprite relative to backgrounds. |
|---|
int bn:: sprites:: min_z_order() constexpr
| Returns | Returns the minimum priority of a sprite relative to other sprites. |
|---|
int bn:: sprites:: max_z_order() constexpr
| Returns | Returns the maximum priority of a sprite relative to other sprites. |
|---|
void bn:: sprites:: reload()
Reloads the internal attributes of all sprites.
Normally you should not call this function, but it can be useful after messing with HDMA for example.