pico8::SprCursor Struct Reference

Represents the cursor state for sprite-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 pixels (column position).
int	y
	The y-coordinate in pixels (row position).
Color	color
	The drawing color for text (default: CURRENT).
int	z
	The depth (Z-value) for rendering order (default: 0).

Detailed Description

Represents the cursor state for sprite-based text rendering.

This structure stores the current cursor position, color, and depth (Z-value) for rendering text on the screen using sprites. It allows pixel-level control over the rendering position and supports fine-grained color and depth management.

Note

This is specific to the sprite rendering layer and requires sprint() or similar functions to be called every frame to maintain visibility. Clearing the framebuffer (e.g., with cls()) will remove all sprite-based text, requiring re-rendering in the subsequent frame.

Member Function Documentation

Reset()

void pico8::SprCursor::Reset ( )

inline

Resets the cursor state to its default values.

Sets the position to (0, 0), color to CURRENT, and depth to 0.

---

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

• include/pico8.h