PixelUI Documentation

Docs home Quick start Architecture Lifecycle GitHub

中文English

PixelUI is the C++ UI framework I wrote for small embedded displays. It uses U8g2 for drawing and ETL for fixed-capacity containers and callbacks. It started as part of my own hardware projects, so this documentation focuses on how the framework is actually used and keeps the current implementation limits visible.

This documentation targets v0.3.1-beta.

AppLauncher running in the Qt simulator.

Start here

1. Quick start: connect U8g2 and PixelUI to time, input, and rendering.
2. Launch AppLauncher: display the first screen.
3. Build your first App: learn about lifecycle, registration, and exit handling.
4. Use Widgets and Focus: components, parent-child trees, and key navigation.
5. Add animations, popups, or BlinkState.

Ready-made views

• IconView and ListView
• AppLauncher: an application entry point built on IconView.

Understand the architecture

• PixelUI architecture overview
• Event-driven rendering and task model
• App lifecycle and ViewManager
• Fixed application arena
• Resource limits and config.h
• Callbacks and object lifetime
• Canvas and page scrolling
• Coroutines
• Build and test the simulator
• Known limitations

Repository map

include/       Public headers; treat these as the API reference
src/           PixelUI and module implementations
examples/      App, Widget, ListView, and animation examples
simulator/     Qt6 desktop simulator
tests/         Capacity, lifecycle, and regression tests
third_party/   U8g2 and ETL submodules

The documentation explains how to use the framework. If it differs from the v0.3.1-beta source, follow the tagged source first, and please open an issue or PR to let me know.