pico8::BgCursor Struct Reference

Represents the cursor state for background-based text rendering. More...

#include <pico8.h>

Public Member Functions
void	Reset ()
	Resets the cursor state to its default values.

Public Attributes
int	x
	The x-coordinate in 8x8 TILE units.
int	y
	The y-coordinate in 8x8 TILE units.
BgPal	pal
	The palette index for text rendering (default: BG_PAL_CURRENT).

Detailed Description

Represents the cursor state for background-based text rendering.

This structure manages the cursor for rendering text on the background layer. Background rendering operates in 8x8 TILE units and uses palette-based colors.

Note

Unlike sprites, background text persists across frames and does not require re-rendering unless explicitly cleared or overwritten.

Member Function Documentation

Reset()

void pico8::BgCursor::Reset ( )

inline

Resets the cursor state to its default values.

Sets the position to (0, 0) and palette to BG_PAL_CURRENT.

---

The documentation for this struct was generated from the following file:

• include/pico8.h