Home /Modules/user-interface/README.md

README.md

user-interface/README.md · 220 line(s) · markdown

<img align="right" src="https://github.com/mearvk/SLeeLa/blob/master/images/debian/debian-logo.png" width="75" height="75" alt="SLeeLa">

SleelaUI™

SLeeLa's own, original User Interface toolkit — a self-contained C/C++ widget library with a software rasterizer and native per-OS backends. It is not GTK, Qt, wxWidgets, or a wrapper around any of them: SleelaUI draws its own widgets with its own 2D rasterizer, so its look is pixel-identical on every target. Its default is graphite/charcoal #1D2025 with a steel-blue accent. Five named presets are available: Default, White, Blue, Black, and Gray; selection is explicit in source or through a runtime .conf file. It talks to the real host window system through one small backend interface with three implementations.

SleelaUI™ — MEARVK LLC. Original SLeeLa work.

SleelaUI preview on the graphite default theme

The default graphite/charcoal theme with a steel-blue accent, rendered by the toolkit's own software rasterizer. Regenerate with make snapshot (no display required). The schematic text is the headless preview font; real backends render system glyphs.

Status & platform support

The toolkit follows the same cross-platform guarantee as the rest of SLeeLa: one portable surface, native backends underneath, and the runtime can report which backend is live (slui_backend() / slui_backend_name()).

PlatformWindow systemBackendFont engineBuild
Linux / UnixX11 (Xlib)src/backend/x11.cppFreeType + Fontconfigmake
macOS (Darwin)AppKit (NSWindow)src/backend/cocoa.mmCore Textmake
Windows 10+Win32 (user32/gdi32)src/backend/win32.cppGDI (GGO_GRAY8)make (MinGW)

A fourth src/backend/headless.cpp backend renders to memory with a built-in bitmap font so the whole toolkit — layout, painting, theming — builds and smoke-tests on CI with no display on any OS.

Architecture

            your program (C or C++)
                     │
         include/sleela_ui.h  (stable C ABI)
                     │
     ┌───────────────┴────────────────┐
     │        portable core            │  no OS calls, identical everywhere
     │  Widget tree · box layout       │
     │  Theme (graphite/charcoal default)    │
     │  Software rasterizer (Canvas)   │
     └───────────────┬────────────────┘
                     │  Backend interface (slui_backend.hpp)
     ┌───────────────┼────────────────┬──────────────┐
   X11 (Xlib)   Cocoa (AppKit)   Win32 (GDI)     Headless (CI)

The core makes every look-and-feel decision and produces the pixels. A backend only has to be correct, never styled: create a native window, translate input into SLUIEvent, rasterize a glyph to 8-bit coverage with the real host font engine, and blit the Canvas buffer to the window.

See ARCHITECTURE.md for the full design and UI-PRINCIPLES.md for the look-and-feel rules.

The Slick Black theme

Slick Black is the default and signature palette: a matte near-black surface family (the floor is a hair above pure black so antialiasing has somewhere to blend), small even surface steps, crisp white text, and a single cool steel-blue accent as "the one live thing." Every role pairing clears WCAG AA contrast and every control clears a 32px hit target. The whole palette is one struct — retheming is one edit, or load a .conf (see THEMING.md). A lighter SLUI_THEME_GRAPHITE preset and a fully host-defined SLUI_THEME_CUSTOM are also provided.

Control set

31 widget types, each drawn by the software rasterizer and backend-identical:

The interactive controls are keyboard-navigable (Tab/Shift-Tab focus ring, Enter/Space activate, arrows for ranges) and expose their state through the C ABI. The full catalogue — C constructor, SLeeLa class, description, and focus behaviour per widget — is in WIDGETS.DESCRIPTION.md.

Button icons

Buttons can display a JPEG image asset beside their label and retain a named, backend-independent vector fallback for when the image is unavailable. In C, use slui_widget_set_icon(button, "icons/wifi.jpg", "Wifi"); in SLeeLa, use uiWidgetSetIcon(button, "user-interface/icons/wifi.jpg", "Wifi") or SLButton.setIcon(SLIcon). The current asset decoder supports baseline JPEG.

Layout & flow manager

A nameable flow/layout manager groups and places items as an orthogonal conflation of unit parts and organizations: named groups of named items, adjusted singly, by group, or n-ary; standardized units across US (in/ft/pt), Eurasian metric (mm/cm/m), and px; several flow solutions (stack, wrap, grid, dock, central weight/mass); and Named placement — MEDIUM = center, CENTRAL = weight/mass — with named ergonomic presets. See LAYOUT.md (sleela_ui_layout.h).

Drawing surface for developers & agents

Beyond widgets, sleela_ui_draw.h exposes the rasterizer directly: an owned RGBA draw context (single/double buffered), pixel-level get/set/blend, blend modes, a clip stack, a complete primitive set (lines, rects, circles, ellipses, arcs, triangles, gradients, text, blits), and a frame clock for refresh-rate pacing. The animated canvas view widget hands your draw callback a context each frame. Full reference: DRAW-API.md.

Lighting, shadow & relief

Canvas-aware objects can be lit for genuine relief — directional highlights, raised/recessed surfaces, soft cast shadows, and ambient occlusion — on Sleela's warm base. Lights come from a source (reserves its anchor object) or an emitter (reserves nothing, reusable); both light and shadow are emissions chosen by polarity. See LIGHTING.md (sleela_ui_light.h).

A light can be placed in real millimetres (a height it shines down from, plus left/right/up/down), driven by 100 differentiables through a Calculus-8 into a mood coloured from an Excellent Wash, with a natural tanor glow for lightless bulbs that refreshes "a little left". See MOODS.md (sleela_ui_mood.h).

Fonts & font effects

A font bundles a face (family, size, weight, slant, spacing) with a stack of effects — drop/inner shadow, glow, light, an emitter (text that radiates light into a scene), outline, relief emboss/engrave, and gradient fill — each with a quality knob (draft .. ultra). Attach a styled font to any text widget with slui_widget_set_font. See FONTS.md (sleela_ui_font.h).

Quick start (C)

#include "sleela_ui.h"

int main(void) {
    SLUIApp *app = slui_app_create("com.example.App");

    SLUITheme theme;
    slui_theme_preset(&theme, SLUI_THEME_SLEELA_BASE);   /* the default */

    SLUIWindowConfig cfg = {0};
    cfg.title = "Hello"; cfg.width = 480; cfg.height = 320;
    cfg.resizable = 1; cfg.theme = &theme;

    SLUIWindow *win = slui_window_create(app, &cfg);
    SLUIWidget *root = slui_window_root(win);

    SLUIWidget *col = slui_box(root, SLUI_ORIENT_VERTICAL, 12);
    slui_widget_set_margin(col, 20, 20, 20, 20);
    slui_label(col, "Welcome to SleelaUI");
    SLUIWidget *ok = slui_button(col, "Continue");
    slui_widget_set_suggested(ok, 1);

    slui_window_show(win);
    return slui_app_run(app);
}

Build

From user-interface/:

make           # build libsleelaui.a with the native backend for this OS
make example   # build the C gallery demo -> build/slui-gallery
make smoke     # build + run the headless smoke test (no display needed)
make install   # install the library, header, and desktop entry

The backend is auto-detected from the host (make help prints which one). On Linux/Unix the X11 build needs the X11, FreeType, and Fontconfig development packages; on Debian/Ubuntu:

sudo apt install libx11-dev libfreetype-dev libfontconfig-dev

Windows uses MinGW-w64 (links gdi32/user32); macOS uses Apple clang (links the Cocoa, CoreText, and CoreGraphics frameworks).

Run

./build/slui-gallery        # Slick Black window with every control

Why "at least the quality of GNOME"

The toolkit adopts GNOME/GTK's two-pass box layout model, consistent 4px spacing scale, one-accent-per-group discipline, always-visible focus ring, and AA-contrast baseline — then goes further by rendering identically on all three desktop platforms instead of inheriting three different native themes. The rules are written down and enforced in UI-PRINCIPLES.md.

— SleelaUI™ · MEARVK LLC · 2026


SLeeLa

<p align="center"><img src="images/sleela/sleela-wordmark.svg" alt="SLeeLa — The Now. The Ingredient." width="560"></p> <p align="center"><img src="https://github.com/mearvk/SLeeLa/blob/master/images/sleela-programming-language-002.jpg" alt="SLeeLa Marketing Logo" width="560"></p>