PixelUI Documentation

Docs home Quick start Architecture Lifecycle GitHub

中文English

PixelUI is a C++ UI framework for small embedded displays. It uses U8g2 for drawing and ETL for fixed-capacity containers and callbacks. The host application supplies the display, time, and input; PixelUI manages Apps, Widgets, Popups, Animations, and rendering.

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
• Numeric ranges, formatting, and editing
• Canvas and page scrolling
• Coroutines
• Build and test the simulator

Repository map

include/       Public headers
src/           PixelUI and module implementations
examples/      Examples
simulator/     Qt6 desktop simulator
tests/         Capacity, lifecycle, and regression tests
third_party/   U8g2 and ETL submodules