The visual language of the bench, resolved at runtime. More...

#include <stdint.h>
#include "gfx.h"
#include "ui_layout.h"

Macros
#define	UI_BG ui_theme_color(UI_C_BG)
#define	UI_PANEL ui_theme_color(UI_C_PANEL)
#define	UI_PANEL_HI ui_theme_color(UI_C_PANEL_HI)
#define	UI_PANEL_SUNK ui_theme_color(UI_C_PANEL_SUNK)
#define	UI_EDGE ui_theme_color(UI_C_EDGE)
#define	UI_EDGE_HI ui_theme_color(UI_C_EDGE_HI)
#define	UI_GRID ui_theme_color(UI_C_GRID)
#define	UI_GRID_STRONG ui_theme_color(UI_C_GRID_STRONG)
#define	UI_TEXT ui_theme_color(UI_C_TEXT)
#define	UI_TEXT_DIM ui_theme_color(UI_C_TEXT_DIM)
#define	UI_TEXT_FAINT ui_theme_color(UI_C_TEXT_FAINT)
#define	UI_TEXT_ON_LIGHT ui_theme_color(UI_C_TEXT_ON_LIGHT)
#define	UI_ACCENT ui_theme_color(UI_C_ACCENT)
#define	UI_OK ui_theme_color(UI_C_OK)
#define	UI_WARN ui_theme_color(UI_C_WARN)
#define	UI_DANGER ui_theme_color(UI_C_DANGER)
#define	UI_VOLT ui_theme_color(UI_C_VOLT)
#define	UI_CURR ui_theme_color(UI_C_CURR)
#define	UI_POWER ui_theme_color(UI_C_POWER)
#define	UI_RPM ui_theme_color(UI_C_RPM)
#define	UI_LILAC ui_theme_color(UI_C_LILAC)
#define	UI_TEAL ui_theme_color(UI_C_TEAL)
#define	UI_CHAMFER 10
	A card's or a button's cut corner: 10px.
#define	UI_CHAMFER_SM 5
	A chip's or a small control's cut corner: 5px.
#define	UI_FONT_LABEL (&gfx_font_8x16)
#define	UI_FONT_HEAD (&gfx_font_16x28)
#define	UI_FONT_NUM (&gfx_font_num_24x30)
#define	UI_FONT_BAND (&gfx_font_10x20)
	The band's chip labels, the help bubbles' text and the alert band's text: 10 x 20.
#define	UI_FONT_TAG (&gfx_font_20x36)
	The home tag and the wordmark: 20 x 36.
#define	UI_FONT_FINE (&gfx_font_8x16)
	The 8x16 face for data columns: log table, analyser values, pad numbers.
#define	UI_FONT_BODY (&gfx_font_12x24)
	The 12x24 face for prose: help text, warnings, questions, run results.

Enumerations
enum	ui_color_id_t { UI_C_BG = 0 , UI_C_PANEL , UI_C_PANEL_HI , UI_C_PANEL_SUNK , UI_C_EDGE , UI_C_EDGE_HI , UI_C_GRID , UI_C_GRID_STRONG , UI_C_TEXT , UI_C_TEXT_DIM , UI_C_TEXT_FAINT , UI_C_TEXT_ON_LIGHT , UI_C_ACCENT , UI_C_OK , UI_C_WARN , UI_C_DANGER , UI_C_VOLT , UI_C_CURR , UI_C_POWER , UI_C_RPM , UI_C_LILAC , UI_C_TEAL , UI_C_COUNT }
enum	ui_theme_id_t { UI_THEME_DARK = 0 , UI_THEME_LIGHT , UI_THEME_COUNT }

Functions
static gfx_color_t	ui_theme_color (ui_color_id_t id)
void	ui_theme_set (ui_theme_id_t theme)
void	ui_theme_set_brightness (int percent)
	Scales the whole palette.
void	ui_theme_set_contrast (int percent)
	Pushes colours away from mid-grey, or pulls them toward it.
ui_theme_id_t	ui_theme_get (void)
int	ui_theme_brightness (void)
int	ui_theme_contrast (void)
static gfx_seg_style_t	ui_seg_hero (void)

Variables
gfx_color_t	g_ui_palette [UI_C_COUNT]

Detailed Description

The visual language of the bench, resolved at runtime.

Two palettes, dark and light. In the dark palette the background is near-black so the four telemetry colours run at full chroma; in both, every text colour sits well clear of its background.

Colours are an array lookup rather than compile-time constants, because theme, brightness and contrast are settings. Brightness and contrast are applied to the 8-bit palette before packing to RGB565 (16-bit red, green, blue), so they do not quantise the way scaling packed colours would.

No ESP-IDF (Espressif Internet-of-Things Development Framework): the whole UI (user interface) renders on the host.

SPDX-License-Identifier: MIT

Function Documentation

◆ ui_theme_set()

void ui_theme_set ( ui_theme_id_t theme )

Recompute the palette. Call ui_router_invalidate() after.

◆ ui_theme_set_brightness()

void ui_theme_set_brightness ( int percent )

Scales the whole palette.

Parameters

percent the brightness, 20..100%

◆ ui_theme_set_contrast()

void ui_theme_set_contrast ( int percent )

Pushes colours away from mid-grey, or pulls them toward it.

Parameters

percent the contrast, 60..140%

Variable Documentation

◆ g_ui_palette

gfx_color_t g_ui_palette[UI_C_COUNT]

extern

The live palette. Indexed by ui_color_id_t; recomputed by the setters.

Macros

Enumerations

Functions