[todo] description of the SATB sprite entry
| Sprite descprition and utilities | [todo] description of the SATB sprite entry |
| Sprite entry bitmasks | |
| SPRITE_X_MASK | Bitmask for the sprite X coordinate. |
| SPRITE_Y_MASK | Bitmask for the sprite Y coordinate. |
| SPRITE_CG_MODE_MASK | Bitmask for CG mode. |
| SPRITE_VERTICAL_FLIP_MASK | Bitmask for sprite vertical flip flag. |
| SPRITE_HORIZONTAL_FLIP_MASK | Bitmask for sprite horizontal flip flag. |
| SPRITE_HEIGHT_MASK | Bitmask for sprite height. |
| SPRITE_WIDTH_MASK | Bitmask for sprite width. |
| SPRITE_PRIORITY_MASK | Bitmask for sprite priority. |
| SPRITE_PALETTE_MASK | Bitmask for sprite palette index. |
| Sprite CG modes. | |
| SPRITE_CG_MODE_B01 | Bitplanes 0 and 1 are read, 2 and 3 are treated as zeroes. |
| SPRITE_CG_MODE_B23 | Bitplanes 2 and 3 are read, 0 and 1 are treated as zeroes. |
| Sprite size. | Sprite width can be 16 or 32. |
| SPRITE_HEIGHT_16 | 16 px sprite height. |
| SPRITE_HEIGHT_32 | 32 px sprite height. |
| SPRITE_HEIGHT_64 | 64 px sprite height. |
| SPRITE_WIDTH_16 | 16 px sprite width. |
| SPRITE_HEIGHT_32 | 32 px sprite width. |
| Sprite control flags | |
| SPRITE_PRIORITY_LOW | The sprite will be displayed in background. |
| SPRITE_PRIORITY_HIGH | The sprite will be displayed in foreground. |
| SPRITE_HORIZONTAL_FLIP | The sprite will be flipped horizontally. |
| SPRITE_VERTICAL_FLIP | The sprite will be flipped vertically. |
Bitmask for the sprite X coordinate.
SPRITE_X_MASK = $3f
Bitmask for the sprite Y coordinate.
SPRITE_Y_MASK = $3f
Bitmask for CG mode.
SPRITE_CG_MODE_MASK = $01
Bitmask for sprite vertical flip flag.
SPRITE_VERTICAL_FLIP_MASK = $80
Bitmask for sprite horizontal flip flag.
SPRITE_HORIZONTAL_FLIP_MASK = $08
Bitmask for sprite height.
SPRITE_HEIGHT_MASK = $30
Bitmask for sprite width.
SPRITE_WIDTH_MASK = $01
Bitmask for sprite priority.
SPRITE_PRIORITY_MASK = $80
Bitmask for sprite palette index.
SPRITE_PALETTE_MASK = $0f
Bitplanes 0 and 1 are read, 2 and 3 are treated as zeroes.
SPRITE_CG_MODE_B01 = $00
16 px sprite height.
SPRITE_HEIGHT_16 = $00
32 px sprite height.
SPRITE_HEIGHT_32 = $10
64 px sprite height.
SPRITE_HEIGHT_64 = $20
16 px sprite width.
SPRITE_WIDTH_16 = $00
The sprite will be displayed in background.
SPRITE_PRIORITY_LOW = $00
The sprite will be displayed in foreground.
SPRITE_PRIORITY_HIGH = $80
The sprite will be flipped horizontally.
SPRITE_HORIZONTAL_FLIP = $08
The sprite will be flipped vertically.
SPRITE_VERTICAL_FLIP = $80