Renderer

Class

Source: Renderer.h

Description

High-level graphics rendering system.

The Renderer class provides a unified API for drawing shapes, text, and images. It abstracts the underlying hardware implementation (DrawSurface) and manages display configuration, including rotation and offsets.

Methods

void init()

Description:

Initializes the renderer and the underlying draw surface.

void beginFrame()

Description:

Prepares the buffer for a new frame (clears screen).

void endFrame()

Description:

Finalizes the frame and sends the buffer to the display.

DrawSurface& getDrawSurface()

Description:

Gets the underlying DrawSurface implementation.

Returns: Reference to the DrawSurface.

void drawFilledCircle(int x, int y, int radius, Color color)

Description:

Draws a filled circle.

Parameters:

• x: Center X coordinate.
• y: Center Y coordinate.
• radius: Radius of the circle.
• color: Fill color.

void drawCircle(int x, int y, int radius, Color color)

Description:

Draws a circle outline.

Parameters:

• x: Center X coordinate.
• y: Center Y coordinate.
• radius: Radius of the circle.
• color: Outline color.

void drawRectangle(int x, int y, int width, int height, Color color)

Description:

Draws a rectangle outline.

Parameters:

• x: Top-left X coordinate.
• y: Top-left Y coordinate.
• width: Width of the rectangle.
• height: Height of the rectangle.
• color: Outline color.

void drawFilledRectangle(int x, int y, int width, int height, Color color)

Description:

Draws a filled rectangle.

Parameters:

• x: Top-left X coordinate.
• y: Top-left Y coordinate.
• width: Width of the rectangle.
• height: Height of the rectangle.
• color: Fill color.

void drawFilledRectangleW(int x, int y, int width, int height, uint16_t color)

Description:

Draws a filled rectangle with a 16-bit color.

Parameters:

• x: Top-left X coordinate.
• y: Top-left Y coordinate.
• width: Width of the rectangle.
• height: Height of the rectangle.
• color: Fill color (RGB565).

void drawLine(int x1, int y1, int x2, int y2, Color color)

Description:

Draws a line between two points.

Parameters:

• x1: Start X.
• y1: Start Y.
• x2: End X.
• y2: End Y.
• color: Line color.

void drawBitmap(int x, int y, int width, int height, const uint8_t *bitmap, Color color)

Description:

Draws a bitmap image.

Parameters:

• x: Top-left X coordinate.
• y: Top-left Y coordinate.
• width: Width of the bitmap.
• height: Height of the bitmap.
• bitmap: Pointer to the bitmap data.
• color: Color to draw the bitmap pixels (if monochrome) or ignored.

void drawPixel(int x, int y, Color color)

Description:

Draws a single pixel.

Parameters:

• x: X coordinate.
• y: Y coordinate.
• color: Pixel color.

void setDisplaySize(int w, int h)

Description:

Sets the logical display size (rendering resolution).

Parameters:

• w: Logical width.
• h: Logical height.

int getLogicalWidth() const

int getLogicalHeight() const

void setDisplayOffset(int x, int y)

Description:

Sets a global offset for all drawing operations.

Parameters:

• x: X offset.
• y: Y offset.

void setContrast(uint8_t level)

Description:

Sets the display contrast (brightness).

Parameters:

• level: Contrast level (0-255).

void setFont(const uint8_t* font)

Description:

Sets the font for text rendering.

Parameters:

• font: Pointer to the font data array.

int getXOffset() const

Description:

Gets the current global X offset.

Returns: The X offset.

int getYOffset() const

Description:

Gets the current global Y offset.

Returns: The Y offset.

void setRenderContext(PaletteContext* context)

Description:

Sets the render context for palette selection.

Parameters:

• context: The palette context to use (Background or Sprite). Pass nullptr to use method-specific defaults.

PaletteContext* getRenderContext() const

Description:

Gets the current render context.

Returns: Pointer to the current context, or nullptr if using defaults.

void setSpritePaletteSlotContext(uint8_t slot)

Description:

Sets the sprite palette slot context for multi-palette sprites.

Parameters:

• slot: Palette slot (0-7). To disable context, call with 0 or use default.

uint8_t getSpritePaletteSlotContext() const

Description:

Gets the current sprite palette slot context.

Returns: Current palette slot, or 0xFF if context is inactive.

void drawSprite(const Sprite& sprite, int x, int y, Color color, bool flipX = false)

Description:

Draws a 1bpp monochrome sprite using the Sprite descriptor.

Parameters:

• sprite: Sprite descriptor (data, width, height).
• x: Top-left X coordinate in logical screen space.
• y: Top-left Y coordinate in logical screen space.
• color: Color used for "on" pixels.
• flipX: If true, sprite is mirrored horizontally.

void drawSprite(const Sprite& sprite, int x, int y, float scaleX, float scaleY, Color color, bool flipX = false)

Description:

Draws a scaled 1bpp monochrome sprite.

Parameters:

• sprite: Sprite descriptor.
• x: Top-left X coordinate.
• y: Top-left Y coordinate.
• scaleX: Horizontal scaling factor (e.g., 1.25).
• scaleY: Vertical scaling factor (e.g., 1.25).
• color: Color used for "on" pixels.
• flipX: If true, sprite is mirrored horizontally before scaling.

void drawSprite(const Sprite2bpp& sprite, int x, int y, uint8_t paletteSlot = 0, bool flipX = false)

Description:

Draws a 2bpp sprite using a specific palette slot.

Parameters:

• sprite: The 2bpp sprite descriptor.
• x: Top-left X coordinate.
• y: Top-left Y coordinate.
• paletteSlot: The palette slot to use.
• flipX: True to mirror horizontally.

void drawSprite(const Sprite4bpp& sprite, int x, int y, uint8_t paletteSlot = 0, bool flipX = false)

Description:

Draws a 4bpp sprite using a specific palette slot.

Parameters:

• sprite: The 4bpp sprite descriptor.
• x: Top-left X coordinate.
• y: Top-left Y coordinate.
• paletteSlot: The palette slot to use.
• flipX: True to mirror horizontally.

void drawSprite(const Sprite2bpp& sprite, int x, int y, bool flipX)

Description:

Draws a 2bpp sprite (legacy).

Parameters:

• sprite: The 2bpp sprite descriptor.
• x: Top-left X coordinate.
• y: Top-left Y coordinate.
• flipX: True to mirror horizontally.

void drawSprite(const Sprite4bpp& sprite, int x, int y, bool flipX)

Description:

Draws a 4bpp sprite (legacy).

Parameters:

• sprite: The 4bpp sprite descriptor.
• x: Top-left X coordinate.
• y: Top-left Y coordinate.
• flipX: True to mirror horizontally.

* Each layer is rendered in array order using the existing drawSprite()

void drawMultiSprite(const MultiSprite& sprite, int x, int y)

Description:

Draws a multi-layer sprite composed of several 1bpp layers.

Parameters:

• sprite: Multi-layer sprite descriptor.
• x: Top-left X coordinate in logical screen space.
• y: Top-left Y coordinate in logical screen space.

void drawMultiSprite(const MultiSprite& sprite, int x, int y, float scaleX, float scaleY)

Description:

Draws a scaled multi-layer sprite.

Parameters:

• sprite: Multi-layer sprite descriptor.
• x: Top-left X coordinate.
• y: Top-left Y coordinate.
• scaleX: Horizontal scaling factor.
• scaleY: Vertical scaling factor.

void drawTileMap(const TileMap2bpp& map, int originX, int originY)

Description:

Draws a tilemap of 2bpp sprites.

Parameters:

• map: The tilemap descriptor.
• originX: X coordinate of the top-left corner.
• originY: Y coordinate of the top-left corner.

void drawTileMap(const TileMap4bpp& map, int originX, int originY)

Description:

Draws a tilemap of 4bpp sprites.

Parameters:

• map: The tilemap descriptor.
• originX: X coordinate of the top-left corner.
• originY: Y coordinate of the top-left corner.

void setOffsetBypass(bool bypass)

Description:

Enables or disables ignoring global offsets for subsequent draw calls.

Parameters:

• bypass: True to ignore offsets, false to apply them (default).

bool isOffsetBypassEnabled() const

Description:

Checks if offset bypass is currently enabled.

Returns: True if offsets are being ignored.