graphics.html 44 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634
  1. <!doctype html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1">
  6. <title>Graphics &amp; UI | NebOS Architecture</title>
  7. <meta name="description" content="NebOS graphics architecture: VBE framebuffer, shadow buffer, damage rectangles, blit vtable, window manager, canvas ABI, ngui toolkit and image library.">
  8. <link rel="icon" href="favicon.svg" type="image/svg+xml">
  9. <link rel="stylesheet" href="style.css">
  10. </head>
  11. <body>
  12. <a class="skip" href="#main">Skip to content</a>
  13. <header class="site-header">
  14. <a class="brand" href="index.html">
  15. <span class="brand-mark" aria-hidden="true"></span>
  16. <span>NebOS <span class="brand-sub">Architecture</span></span>
  17. </a>
  18. <nav class="site-nav" aria-label="Architecture sections">
  19. <a href="index.html">Overview</a>
  20. <a href="boot.html">Boot</a>
  21. <a href="memory.html">Memory</a>
  22. <a href="cpu.html">CPU</a>
  23. <a href="drivers.html">Drivers</a>
  24. <a href="filesystems.html">Filesystems</a>
  25. <a href="graphics.html" aria-current="page">Graphics</a>
  26. <a href="network.html">Network</a>
  27. <a href="userland.html">Userland</a>
  28. <a href="development.html">Development</a>
  29. </nav>
  30. </header>
  31. <main id="main" class="page">
  32. <div class="page-head">
  33. <p class="kicker">Graphics &amp; UI</p>
  34. <h1>Draw into a shadow, publish by damage.</h1>
  35. <p class="lede">
  36. The display path is intentionally simple: drawing lands in a RAM
  37. shadow buffer, damage rectangles describe what changed, and a
  38. budgeted flush copies those rectangles to VRAM. Windows add a
  39. compositor and a mapped-canvas ABI on top; a small immediate-mode
  40. toolkit supplies the widgets.
  41. </p>
  42. <div class="meta">
  43. <span class="pill">VBE LFB</span>
  44. <span class="pill">1 MiB flush budget</span>
  45. <span class="pill">8 windows</span>
  46. <span class="pill">RGB565 canvases</span>
  47. </div>
  48. </div>
  49. <nav class="toc" aria-label="On this page">
  50. <h2>On this page</h2>
  51. <ul>
  52. <li><a href="#framebuffer">Framebuffer</a></li>
  53. <li><a href="#shadow">Shadow &amp; damage</a></li>
  54. <li><a href="#blit">Blit backends</a></li>
  55. <li><a href="#wm">Window manager</a></li>
  56. <li><a href="#canvas">Canvas ABI</a></li>
  57. <li><a href="#ngui">ngui toolkit</a></li>
  58. <li><a href="#apps">Applications</a></li>
  59. <li><a href="#images">Image library</a></li>
  60. <li><a href="#icons">UI icons</a></li>
  61. <li><a href="#cursors">Mouse cursors</a></li>
  62. <li><a href="#gpu">GPU quirks</a></li>
  63. <li><a href="#backlight">Panel backlight</a></li>
  64. <li><a href="#sources">Source map</a></li>
  65. </ul>
  66. </nav>
  67. <section id="framebuffer">
  68. <h2>Framebuffer</h2>
  69. <p>
  70. The boot path writes a <code>struct vga_boot_fb_info</code> to
  71. <code>0x600</code>: LFB base, pitch, width, height, bits per pixel
  72. and an RGBX flag for GOP's byte order. The legacy VESA stage chooses
  73. a mode with at least 16 bpp, a linear framebuffer, it must fit the
  74. card's VRAM, at most 1920 pixels wide, and its shadow (pitch ×
  75. height) must fit the 8 MB reserve. 1920×1080 is the practical
  76. maximum: its 8.29 MB shadow fits, and its 4.15 MB RGB565 canvas
  77. fits the 4 MB window slot; 1920×1200 is rejected because its
  78. canvas would need 4.6 MB. The UEFI loader applies the same GOP
  79. limits.
  80. </p>
  81. <p>
  82. <span class="file">vga.c</span> owns the visible surface. On a
  83. normal boot the render target is a RAM shadow buffer at
  84. <code>0x100000</code>, not the LFB; the 8 MB reserve holds a
  85. 1920×1080×32 frame (8.29 MB) with about 94 KB to spare. A surface
  86. carries width, height, pitch, format and a
  87. pixel-pointer, so the same drawing code can target a window layer or
  88. a canvas.
  89. </p>
  90. </section>
  91. <section id="shadow">
  92. <h2>Shadow buffer &amp; damage</h2>
  93. <p>
  94. Drawing never writes VRAM directly. Each operation records a damage
  95. rectangle; overlapping or touching rectangles merge, so a keystroke's
  96. cells collapse into one small rect while unrelated damage stays
  97. apart. The main loop calls <code>vga_present_shadow()</code> on every
  98. iteration with a byte budget of <code>VGA_FLUSH_BUDGET_BYTES</code>
  99. (1 MiB by default).
  100. </p>
  101. <ul>
  102. <li><strong>Small rects copy whole.</strong> A window repaint within the budget never tears.</li>
  103. <li><strong>Large rects are chunked.</strong> A full-screen redraw continues across loop iterations; newer damage is queued behind it.</li>
  104. <li><strong>No fixed frame rate.</strong> The loop flushes whenever there is pending damage, so a cursor move reaches the screen within one loop.</li>
  105. <li><strong>Re-entry guard.</strong> <code>vga_present_shadow()</code> refuses to run while another process is mid-flush; a full-screen copy is long enough to be preempted.</li>
  106. <li><strong>Window drags flush immediately.</strong> <code>wm_drag_shadow</code> copies each drag step as one consistent frame.</li>
  107. </ul>
  108. <p>
  109. When the target is not the screen — a window layer or an app canvas —
  110. <code>vga_target_damage()</code> is a no-op. The render target
  111. override is stored in the PCB, so a preempted draw cannot leak into
  112. another process's window.
  113. </p>
  114. </section>
  115. <section id="blit">
  116. <h2>Blit backends</h2>
  117. <p>
  118. <span class="file">blit.c</span> is the pixel-operation vtable:
  119. fill, copy, blend, canvas, present and flip. Software is the only
  120. backend today, but the WM calls the vtable rather than a fixed
  121. function, so an accelerator can replace individual operations
  122. without touching window logic.
  123. </p>
  124. <p>
  125. The software fill uses an SSE2 row store when the CPU supports it.
  126. Rows that do not fit the cache use streaming stores
  127. (<code>movntdq</code>, one <code>sfence</code> per fill), which
  128. avoids read-for-ownership traffic that makes large fills DRAM-bound
  129. on the Atom. SSE/SSE2 are never assumed: the kernel is built with
  130. <code>-mno-sse</code>, and <code>cpu_has_sse2()</code> probes CPUID,
  131. sets <code>CR4.OSFXSR/OSXMMEXCPT</code> and is re-run on every AP.
  132. </p>
  133. <p>
  134. <code>gfxbench</code> times fill, copy, cell, canvas and flush paths
  135. and reports the bytes actually copied by the presenter.
  136. </p>
  137. </section>
  138. <section id="wm">
  139. <h2>Window manager</h2>
  140. <p>
  141. The WM is a process that owns the desktop and a fixed array of eight
  142. windows. It draws a system bar with the NebOS start button, the
  143. clock, the temperature, and, on ThinkPads and Chromebooks, an
  144. AC/battery status icon at the far right (the Adwaita
  145. <code>ac-adapter</code> symbol on AC, and the <code>battery</code>
  146. outline with our own level fill inside on battery), plus
  147. draggable
  148. terminal and canvas windows with a title bar and close button.
  149. A normal window has no visible frame; an invisible resize band
  150. (1 px inside, 3 px outside its outer edge) is the resize grab
  151. area, and the active title bar uses the toolkit's highlight
  152. colour. The desktop starts as a flat colour; <code>view</code>'s
  153. <em>Background</em> button stores a pre-scaled RGB565 file
  154. (<code>/data/WALLPAPR.BIN</code> on an installed board, else
  155. <code>/share/wallpaper</code>) and signals the WM through
  156. <code>SYS_WM_WALLPAPER</code>, which reloads and stretches it
  157. under the windows. The WM has no image decoder of its own.
  158. Click-to-focus, drag-by-title-bar and close are routed through the
  159. same pointer path. To the left of the rightmost AC/battery status
  160. icon, a network status icon shows the Adwaita
  161. <code>network-wired</code> symbol for wired Ethernet, a
  162. <code>network-wireless-signal-*</code> symbol for a connected WiFi
  163. link, the <code>phone</code> symbol for RNDIS tethering, and
  164. <code>network-wired-disconnected</code> in red when no NIC is
  165. active (<code>network-wireless-offline</code> when a WiFi card is
  166. present but not associated).
  167. The whole right status cluster — temperature, date/time,
  168. network and AC/battery items plus the gaps between them — is
  169. one button with a single rounded hover pill; the empty bar
  170. between the start button and the cluster is not clickable. Both
  171. bar buttons use the same height and rounded style, stopping just
  172. above the rainbow separator, and turn selection-blue while their
  173. panel is open. It opens the anchored <code>bin/netmenu</code>
  174. control panel (a second click closes it).
  175. It opens collapsed: the battery/clock summary and Quick settings
  176. pills are visible, while the network, power-mode and date/time
  177. settings stay hidden until their pill is clicked. Present NICs
  178. can then be selected (DHCP runs), and scanned WiFi networks can be
  179. joined, asking for the WPA2 passphrase first when the AP requires
  180. one.
  181. </p>
  182. <p>
  183. The NebOS banner in the top-left is the start button. Clicking it
  184. opens a Windows-like start menu drawn by the WM as a flat overlay,
  185. not a window, so it floats above every canvas without consuming a
  186. window slot. The panel uses the control panel's theme: a flat
  187. <code>theme.bg</code> surface with no rim, a dim
  188. <code>Applications</code> caption as its first row, rounded hover
  189. rows and a rounded Power tile. Every self-contained GUI
  190. application in the pack gets a row with a coloured letter tile —
  191. Terminal, Files, Web, Gallery, Chat, Clock, Text editor, Colors,
  192. Mines, Cards, Disks, Tasks, Services, Settings and Date &amp; Time — the
  193. pointer highlights the hovered row, and an outside press dismisses
  194. the panel. Row height shrinks to keep the whole list inside the
  195. work area on short panels. The last row, Power, opens a submenu
  196. with Reboot and Power off; both run the privileged kernel command
  197. through <code>SYS_SPAWN_KCMD</code>. The bar notice and the
  198. right-aligned status never draw left of
  199. <code>WM_BAR_LEFT_END</code>.
  200. </p>
  201. <p>
  202. A popover is a chromeless canvas window created with
  203. <code>u_win_create_popover()</code> (<code>WIN_F_POPOVER</code>).
  204. The WM anchors it flush under the top bar at the right screen
  205. edge, treats it as always topmost in painting and hit-testing,
  206. and draws no chrome at all:
  207. the canvas fills the whole window rectangle, with no title bar,
  208. shadow, rim or rounded outer corners, so it reads as a flat menu
  209. panel. The kernel uses the window origin for content-relative
  210. pointer and scroll coordinates. An outside press dismisses the
  211. popover and the click then continues normally; a second click on
  212. the status cluster toggles it. The panel itself is drawn with the
  213. ngui components: a battery/AC and clock summary, a brightness
  214. slider when the panel PWM is present, and Quick settings tiles for
  215. Network, the CPU power mode (<code>SYS_CPUFREQ</code>) and Date
  216. &amp; Time. Clicking a tile expands that section in place — the
  217. network devices/Wi-Fi/connection lists, the three power modes, or
  218. an inline date/time editor with Set, Now and Sync NTP (no separate
  219. window). <code>SYS_WIN_RESIZE_SELF</code> grows or shrinks the
  220. popover to the section, clamped to <code>SYS_SCREEN_INFO</code>'s
  221. framebuffer; the section scrolls with the wheel, touchpad or page
  222. keys when it is taller than the screen, and its overlay scrollbar
  223. slides in while the pointer is over the panel.
  224. </p>
  225. <p>
  226. The WM is the ring-3 process loaded from
  227. <code>/ramfs/bin/wm</code>; init is its only creator and there is
  228. no kernel WM fallback. The kernel window server in
  229. <span class="file">wm.c</span> owns the shadow mapping, the
  230. per-window canvases, input routing, the cursor, kexec detection and
  231. the boot-console handoff. <code>SYS_WM_ATTACH</code> admits only a
  232. process named <code>wm</code> whose parent is the current init pid;
  233. it maps the shadow, resets the window mapping state and disables
  234. the boot console. If init or the WM binary is missing the console
  235. stays visible. The WM starts the first terminal after the storage
  236. mount (<code>wm_server_boot_ready</code>); the console uses the same
  237. 8×16 face and top-left origin as the terminal, so the first frame
  238. replaces it without a size or position jump. A wedged WM is killed
  239. by the kernel watchdog and init respawns it; its terminal, bootscan
  240. window and start-menu apps die with it.
  241. </p>
  242. <figure class="figure">
  243. <svg viewBox="0 0 920 260" role="img" aria-labelledby="wm-title wm-desc">
  244. <title id="wm-title">Window anatomy</title>
  245. <desc id="wm-desc">A window consists of a title bar, a content area backed by an RGB565 canvas, and a close control. The WM composites the canvas into the screen shadow buffer.</desc>
  246. <rect class="svg-box" x="70" y="22" width="780" height="200" rx="10"/>
  247. <rect class="svg-box accent" x="70" y="22" width="780" height="34" rx="10"/>
  248. <text class="svg-text" x="88" y="45">Terminal · /ramfs/bin/ls</text>
  249. <text class="svg-text" x="800" y="45">×</text>
  250. <rect class="svg-box green" x="86" y="72" width="748" height="132" rx="6"/>
  251. <text class="svg-text" x="104" y="98">content canvas · RGB565 · mapped at 0x50000000</text>
  252. <text class="svg-sub" x="104" y="120">text cells, images, widgets, or arbitrary drawing</text>
  253. </svg>
  254. <figcaption>
  255. <strong>One window, one canvas.</strong> The title bar belongs to
  256. the WM; the content is whatever the owning process draws into its
  257. mapped back buffer. The WM never reads the process's memory — it
  258. composites the front canvas on <code>PRESENT</code>.
  259. </figcaption>
  260. </figure>
  261. <ul>
  262. <li><strong>Terminal windows</strong> are canvas clients: <span class="file">ucmd_term.c</span> renders its rows into the RGB565 window canvas; keys arrive through the generic <code>SYS_KEY_POLL</code> or <code>SYS_WIN_KEY_WAIT</code>. The WM no longer has a text-cell path.</li>
  263. <li><strong>Canvas windows</strong> are generic: the app gets a back buffer, pointer position/buttons/focus and queued press/release edges with capture.</li>
  264. <li><strong>Focus and z-order</strong> are explicit; closing a window kills its session and frees its canvas.</li>
  265. </ul>
  266. <h3>Compositing cost</h3>
  267. <p>
  268. The WM keeps a front-to-back order: the focused window first, then
  269. the remaining windows in descending slot order. For each damage
  270. rectangle it fills the desktop once and walks that order, subtracting
  271. every window in front from the region still uncovered. A window is
  272. drawn only in its exposed pieces, so a fully occluded window costs
  273. nothing and the stack is never repainted back-to-front. The kernel
  274. pointer hit-test uses the same order. A focused-window drag copies
  275. its shadow block to the new position and repaints only the old
  276. strips the new rectangle does not cover, instead of compositing the
  277. window at both positions. If either rectangle is partly off-screen
  278. the shadow has no valid pixels for the hidden part, so that step
  279. repaints the window rect instead of copying desktop background into
  280. it.
  281. </p>
  282. <p>
  283. <code>SYS_WIN_PRESENT</code> carries a content-relative damage
  284. rectangle. The terminal tracks its dirty rows, so a keystroke copies
  285. and composites one 8×16 row block instead of the whole 512×512
  286. canvas. The kernel unions the rectangles between WM polls and
  287. <code>SYS_WM_INFO</code> returns that union; a present with
  288. <code>w == 0</code> or <code>h == 0</code> still means the whole
  289. canvas. The WM overwrites <code>/share/wmstats</code> every two
  290. seconds with the interval's frame count, compositing time, worst
  291. frame and pixels drawn (<code>usurf_pixels</code>), which is the
  292. on-target compositor measurement.
  293. </p>
  294. </section>
  295. <section id="canvas">
  296. <h2>Canvas ABI</h2>
  297. <p>
  298. <code>SYS_WIN_CREATE</code> maps the calling command's window canvas
  299. read/write at <code>0x50000000</code>. The process draws RGB565
  300. pixels and publishes a finished frame with
  301. <code>SYS_WIN_PRESENT</code>, optionally passing a content-relative
  302. rectangle (<code>struct wm_win_present</code>) for the changed
  303. region. Present copies that region from the back buffer into the
  304. composited front canvas with interrupts off, so a half-drawn frame
  305. can never reach the screen. Frames carry monotonic sequence
  306. counters, so the WM cannot lose one. <code>content_gen</code> comes
  307. from a global counter and is unique per window creation, so a new
  308. window that reuses a just-closed slot forces the WM to remap its
  309. front canvas instead of reusing a stale mapping. The ring-3 WM
  310. revalidates the generation after <code>u_wm_begin()</code>:
  311. the kernel refuses client self-resizes while a frame is active,
  312. so a resize between the pre-frame map refresh and the draw can no
  313. longer unmap the canvas under the WM.
  314. </p>
  315. <p>
  316. <code>SYS_WIN_CREATE</code> creates a generic canvas window.
  317. <code>struct win_create.flags</code> can request
  318. <code>WIN_F_POPOVER</code>, a chromeless overlay: the canvas fills
  319. the window and the WM supplies only the topmost placement.
  320. <code>SYS_WIN_RESIZE_SELF</code> (115) resizes the caller's canvas
  321. and <code>SYS_SCREEN_INFO</code> (116) reports the framebuffer
  322. size, so a popover can collapse or grow. Input is exposed through
  323. <code>SYS_WIN_POINTER</code>
  324. (content-relative position, button mask, focus),
  325. <code>SYS_WIN_EVENT</code>, which
  326. queues press/release edges and a capture window, and
  327. <code>SYS_WIN_SCROLL</code>, which returns wheel/touchpad scroll
  328. accumulated for the window under the pointer in pixels
  329. (<code>+dy</code> is later content). A click that starts
  330. in a window still receives its release after the pointer leaves.
  331. The ngui helper <code>ngui_scroll_wheel()</code> applies the delta
  332. to a pane when the pointer is over it. A pane's scrollbar is an
  333. overlay: an 8 px rounded pill at its right edge that stays hidden
  334. while the pointer is outside, slides in over about 100 ms on
  335. hover, and never reduces the content rectangle or reflows a row.
  336. <code>hide_bar</code> suppresses it entirely.
  337. The WM process itself is special: it maps the screen shadow at
  338. <code>0x58000000</code> and each front canvas at
  339. <code>0x59000000 + index × 4 MB</code>, which is how it composites
  340. without reading another process's memory. The 4 MB slot covers a
  341. full-screen 1920×1080 RGB565 canvas (4.15 MB) minus the chrome;
  342. the old 2 MB slot capped a full-height window at roughly 1050 px
  343. wide.
  344. <code>SYS_WM_RESIZE</code> (WM side) and
  345. <code>SYS_WIN_ACK_RESIZE</code> (client side) swap in a resized
  346. canvas; the content size is bounded by the framebuffer, so a
  347. window can grow to the edge of the screen.
  348. </p>
  349. <p>
  350. Double-clicking a title bar maximizes the window to the work area
  351. below the system bar (<code>0, WM_BAR_H, fbw, fbh - WM_BAR_H</code>);
  352. the next double-click restores the saved geometry. Dropping a
  353. title-bar drag with the pointer on the left or right screen edge
  354. (<code>WM_SNAP_EDGE</code>, 2 px) snaps the window to that half of
  355. the work area at full height, and the top edge maximizes it. The
  356. restore geometry is saved only when a window leaves the normal state,
  357. so snapping and then maximizing still restores the original size.
  358. Dragging a maximized or snapped window restores it first, with the
  359. grab point kept at the same fraction of the title bar, and a manual
  360. resize clears the state. While a window is dragged, the screen edges
  361. and the facing edges of other windows resist it: the window stays
  362. flush until the pointer overshoots by <code>WM_RESIST</code> (24 px),
  363. which makes side-by-side placement exact. Windows can be dragged past the left, right and
  364. bottom edges; <code>WM_DRAG_VISIBLE</code> (48 px) of the title bar
  365. always stays on-screen for recovery, and the top bar is never
  366. overlapped. An invisible resize band (1 px inside, 3 px outside)
  367. runs along every edge and corner: the grabbed edges follow the
  368. pointer while the opposite edges stay put, clamped to the work
  369. area. While a drag or resize is active the WM owns the pointer,
  370. so the window content does not see the held button.
  371. </p>
  372. <div class="note">
  373. <p><strong>Buttons fire on the release edge.</strong> The toolkit keeps
  374. a button <code>active</code> until <code>ui-&gt;released</code>;
  375. inferring release from the sampled button mask races the WM event
  376. queue and drops clicks.</p>
  377. </div>
  378. <p>
  379. When a process exits or crashes, the reaper releases its window
  380. mappings and the window server frees the canvas. Closing a window
  381. kills its owner. Keys go through the window key queue
  382. (<code>SYS_WIN_KEY_WAIT</code>) or the generic
  383. <code>SYS_KEY_POLL</code>; Ctrl+C still reaches the terminal.
  384. </p>
  385. </section>
  386. <section id="ngui">
  387. <h2>ngui toolkit</h2>
  388. <p>
  389. <span class="file">ngui.c</span>/<span class="file">ngui.h</span> is an
  390. immediate-mode GUI toolkit shared by the ring-3 apps. It provides
  391. clipped RGB565 primitives, buttons, menu items, text fields, the
  392. Adwaita symbolic icons (see <a href="#icons">UI icons</a>), a theme palette, layout cut helpers and scrolling
  393. panes. It is linked into <code>files</code>, <code>mines</code>,
  394. <code>solitaire</code>, <code>process</code>, <code>chat</code>,
  395. the control panel and the real <code>gallery.elf</code>.
  396. </p>
  397. <ul>
  398. <li><strong>Text fields</strong> support drag-selection, double-click select-all, Ctrl+Left/Right word jumps, Ctrl+Delete/Backspace word deletion and Ctrl+A. They use the proportional face with measured caret, selection and horizontal scrolling; a field marked <code>disabled</code> ignores pointer and keyboard input, drops the focus and paints its value dimmed in the same proportional face. A field marked <code>secret</code> is measured and painted from a <code>*</code> mask (caret, selection and click positions follow the mask, Ctrl+Left/Right jump to the ends), and Tab returns <code>NGUI_INPUT_NEXT</code> together with <code>NGUI_INPUT_CANCEL</code> so forms can move the focus. Fields hold up to 511 characters (<code>NGUI_INPUT_MAX</code> 512). The terminal and editor keep the 8×16 cell grid.</li>
  399. <li><strong>Popover components</strong> give a menu panel its surface: <code>ngui_popover_begin()</code> fills the canvas and returns the body and footer rectangles (no title bar or close button); <code>ngui_section()</code> draws a captioned section header with an optional right-aligned action button; <code>ngui_list_row()</code> is a two-line hover/selected row with optional signal bars and trailing text; <code>ngui_tile()</code> is a rounded quick-settings tile and <code>ngui_slider()</code> a draggable horizontal slider. The WM draws no outer chrome, so the app paints the whole window.</li>
  400. <li><strong>Scroll panes</strong> keep the wheel and page keys, and draw a Firefox-style overlay pill instead of a permanent track. It is hidden by default, animates in from the pane's right edge while the pointer is over the pane, brightens over the hit strip and turns accent-coloured while dragged. Presses in the strip start a drag (or jump the thumb) and do not reach the rows or buttons beneath it; content uses the full pane width in every app.</li>
  401. <li><strong>Clip stack</strong> keeps nested panes and popups inside their parents.</li>
  402. <li><strong>Layout cuts</strong> split a rectangle into rows, columns and fixed margins without a constraint solver.</li>
  403. <li><strong>No retained widget tree.</strong> Apps redraw from state every frame, which keeps the toolkit small and predictable.</li>
  404. </ul>
  405. <p>
  406. Proportional text comes from <span class="file">ufont.c</span>: a
  407. fixed-point, integer-only TrueType parser and antialiased rasterizer.
  408. The pack carries Latin-1 Arimo regular/bold/italic/bold-italic,
  409. Liberation Mono and a curated monochrome Noto Emoji subset under
  410. <code>/ramfs/fonts</code>. The browser, ngui apps and the WM chrome
  411. use real pixel sizes from 8 to 48 px; the browser maps CSS
  412. <code>font-size</code>, <code>font-weight</code>,
  413. <code>font-style</code> and <code>font-family: monospace</code> to
  414. the faces. Pages may bring their own faces with
  415. <code>@font-face</code>: TrueType/OpenType (TrueType outlines) or
  416. WOFF&nbsp;1.0, which <span class="file">ufont_woff.c</span>
  417. unwraps by inflating each table; per family the browser keeps one
  418. face per weight/style and picks the nearest one at layout. Its
  419. arena is 3&nbsp;MB instead of the default 512&nbsp;KB so web fonts
  420. fit beside the built-in set. Missing fonts fall back to the 8×16 bitmap. The browser
  421. detaches the font arena before <code>heap_reset()</code> and
  422. reattaches after <code>heap_start()</code>; terminal content and
  423. the editor keep the bitmap cells.
  424. </p>
  425. <p>
  426. UTF-8 text is available through <code>ngui_text_utf8*</code> and
  427. <code>ngui_menu_item_utf8()</code>. Per codepoint, the selected
  428. primary face is tried first, then the lazily loaded emoji face;
  429. cmap format 12 covers codepoints above the BMP. The emoji set is
  430. deliberately limited to common single-codepoint glyphs that fit the
  431. rasterizer's 256-point/16-contour limits. ZWJ sequences, flags,
  432. skin tones and color glyphs fall back to a tofu or
  433. <code>?</code>; the browser keeps its Latin-1 byte path.
  434. </p>
  435. </section>
  436. <section id="apps">
  437. <h2>Applications</h2>
  438. <div class="grid">
  439. <div class="card">
  440. <h3>files</h3>
  441. <p>File browser on the VFS: opens text in <code>edit</code>, images in <code>view</code> and HTML in <code>browser</code>. The first ngui user.</p>
  442. </div>
  443. <div class="card">
  444. <h3>process</h3>
  445. <p>Graphical task manager (the start menu's <em>Tasks</em> entry or <code>process</code>, the ngui counterpart of <code>top</code>): 60 s CPU, physical-memory and NIC-throughput graphs fed by one sample per second, and a process tree (PID, state, CPU%, memory, CPU time, name) whose rows are indented under their <code>parent_pid</code>; sibling groups sort by clicking a header. A selected row shows its pid/ppid and details and <em>End task</em> terminates the subtree after a second confirming click; kernel threads, the monitor itself and init are protected. PgUp/PgDn and the wheel scroll, Esc closes.</p>
  446. </div>
  447. <div class="card">
  448. <h3>service</h3>
  449. <p>Init's service manager client (<code>service --gui</code>, or the start menu's <em>Services</em> entry): <code>init</code>, <code>wm</code> and user services with Start/Stop/Restart/Kill, status and a live log pane. Kill asks for a second click; WM stop is refused because it is the session service.</p>
  450. </div>
  451. <div class="card">
  452. <h3>gallery</h3>
  453. <p>Live showcase of every ngui control and primitive. Ships in the pack as <code>bin/gallery.app</code>; a launcher prefers <code>/share/GALLERY</code> for development.</p>
  454. </div>
  455. <div class="card">
  456. <h3>chat</h3>
  457. <p>Cloudron Chat client: native OIDC login, channel/DM sidebar with unread badges and presence dots, a wrapped timeline with avatars, day headers, reply snippets and link-preview cards (site, title, description and an optional thumbnail; clicking one opens the link in the browser), a composer and browse/new-DM pickers. Media downloads use a warm <code>curl __serve</code> helper; message images are also decoded there (480&times;320 bounds), while avatars decode at 32&times;32 on the chat thread, so the window keeps drawing. Saved sessions resume from <code>/data</code>. The start menu's <em>Chat</em> entry launches it.</p>
  458. </div>
  459. <div class="card">
  460. <h3>disks</h3>
  461. <p>Storage manager: devices, MBR partitions and mounts, per-volume mount name, read-only and automount, and Format / Install NebOS dialogs that show the kernel command's output. The start menu's <em>Disks</em> entry and the <em>Disks</em> button in <code>files</code> launch it.</p>
  462. </div>
  463. <div class="card">
  464. <h3>solitaire</h3>
  465. <p>Klondike with drag-and-drop, draw-one/three, scoring, animation and pixel-art cards on the canvas service.</p>
  466. </div>
  467. <div class="card">
  468. <h3>view</h3>
  469. <p>Image viewer with fit, 1:1, zoom, pan, EXIF orientation and animated GIF playback. Its <em>Background</em> button (or the <code>b</code> key) installs the image as the desktop wallpaper, persisted in <code>/data/WALLPAPR.BIN</code> when the data volume is mounted.</p>
  470. </div>
  471. <div class="card">
  472. <h3>clock / colors / settime</h3>
  473. <p>Small canvas demos: an analog clock, a colour test window, and the standalone Date &amp; Time editor (<code>settime</code>). The control panel's Date &amp; Time tile reveals its own inline editor, which reads and writes the CMOS RTC and can fetch UTC from an SNTP server.</p>
  474. </div>
  475. <div class="card">
  476. <h3>browser</h3>
  477. <p>HTML/CSS renderer with flex rows, auto-fit and <code>repeat(N, 1fr)</code> card grids, <code>aspect-ratio</code> frames, inline-block runs, inline SVG icons, basic tables and inline SVG diagrams. It decodes inline images at their laid-out bounds (a JPEG gets a reduced IDCT) in the fetch helper, caches a display-size bitmap per image so repaints are 1:1, and fetches through the same helper; image repaints are coalesced and <code>/share/IMGSTAT</code> reports where a load spent its time. Inline and external scripts run on the vendored QuickJS engine (ES2025), and forms render and submit natively. Right-clicking the page opens a context menu that saves images, link targets or the page itself into <code>/data/DOWNLOAD</code> (or <code>/share/DOWNLOAD</code>); a toolbar download button shows live progress and the download history. The largest ring-3 application in the tree.</p>
  478. </div>
  479. </div>
  480. </section>
  481. <section id="images">
  482. <h2>Image library</h2>
  483. <p>
  484. The codecs are independent of the OS and the toolkit: each takes an
  485. input buffer plus a caller-provided <code>struct img_mem</code> arena
  486. and returns an RGB565 image with an optional 8-bit alpha plane. The
  487. browser and the chat client link the same objects and decode HTTP
  488. bodies in memory.
  489. </p>
  490. <ul>
  491. <li><strong>Formats.</strong> PNG, baseline and progressive JPEG, animated GIF, BMP, TGA, PNM, ICO/CUR and PAM. The browser also takes SVG files (<code>&lt;img src="logo.svg"&gt;</code>, CSS backgrounds): the markup is parsed into a detached subtree and drawn by its inline-SVG renderer into an RGB565 + alpha bitmap.</li>
  492. <li><strong>Drawing.</strong> <code>img_draw()</code> is a clipped, scaled RGB565 blit: box-filter downscale, bilinear upscale, alpha over a checkerboard or over the destination. A 1:1 opaque source takes a row copy, and a 1:1 alpha source blends in RGB565 without the 8-bit round trip.</li>
  493. <li><strong>Display-size decode.</strong> <code>struct img_options</code> carries optional <code>max_w</code>/<code>max_h</code> bounds. JPEG honours them with a scaled IDCT (1/2 4x4, 1/4 2x2, 1/8 1x1, Loeffler/IGJ), so a 1200x800 photo painted at 400&times;267 is decoded at roughly 600&times;400 instead of full size and then box-filtered. PNG/GIF/other codecs ignore the bounds and the caller scales them with <code>img_draw()</code>. The browser's <code>curl __serve</code> helper runs this decode for remote <code>&lt;img&gt;</code> and publishes the finished RGB565+alpha bitmap, so the UI thread only copies it.</li>
  494. <li><strong>Orientation.</strong> EXIF orientation is applied; arithmetic JPEG and CMYK are rejected.</li>
  495. <li><strong>Cost.</strong> Downscaling runs on the CPU. The browser decodes at the CSS/attribute box and caches one display-size bitmap per image, so a repaint is a 1:1 blit; the viewer caches one image; the chat client caches 480&times;320 message images and 32&times;32 circular avatars. <code>/share/IMGSTAT</code> records the browser's net, io, decode, scale, paint and reflow times.</li>
  496. </ul>
  497. </section>
  498. <section id="icons">
  499. <h2>UI icons</h2>
  500. <p>
  501. ngui's icons (<code>ngui_icon()</code>, <code>ngui_icon_button()</code>:
  502. back/forward, reload, home and downloads in the browser toolbar,
  503. folder/file/drive in <code>files</code>) and the WM's top-bar network/battery
  504. indicators are GNOME Adwaita symbolic icons
  505. (adwaita-icon-theme 51, LGPL-3 or CC-BY-SA-3.0). The unchanged
  506. <code>*-symbolic.svg</code> files live in
  507. <span class="file">assets/icons/adwaita/</span>; the host tool
  508. <span class="file">tools/mkicons.c</span> rasterizes each one with the
  509. browser's <span class="file">svg_raster.c</span> into a 16&times;16
  510. 8-bit coverage mask and writes one <code>NBICO1</code> bundle,
  511. <code>/ramfs/icons/adwaita16.icn</code> (layout in
  512. <span class="file">include/icon_abi.h</span>): a 16-byte header and
  513. 25 masks, ~6.3&nbsp;KB raw and ~1.4&nbsp;KB gzip, so both the USB
  514. and the floppy pack carry it.
  515. </p>
  516. <ul>
  517. <li><strong>Icon list.</strong> <code>ICON_LIST</code> is an X-macro of enum suffix, short name and theme file. Its order is the icon id and the bundle order (append only); it generates <code>enum ngui_icon</code> and <code>ngui_icon_name()</code>, and the gallery shows every entry. <code>uwm_lib.h</code> applies the same list to <code>enum uwm_icon</code>, so the ring-3 WM can use ids without linking ngui.</li>
  518. <li><strong>Tinting.</strong> Symbolic icons are one colour, so only coverage is stored. <code>ngui_icon()</code> blends the mask in the caller's colour (the theme text colour on buttons, <code>icon_folder</code>/<code>icon_disk</code>/<code>icon_file</code> in <code>files</code>), centred and clipped. <code>usurf_icon()</code> does the same over the WM's 16/24/32 bpp shadow. The bar's battery clears the striped <code>battery</code> mask's interior to a quarter-brightness shade and draws its level fill over the lower part, so the gauge reads at 16&nbsp;px.</li>
  519. <li><strong>Loading.</strong> Each process (every ngui app and the WM) reads the bundle once into a BSS buffer, so the browser's <code>heap_reset()</code> cannot free it. The read is capped at the ids the process was built with, so an older app still works with a newer bundle. Without the bundle the icon is left blank; there is no line-drawn fallback, because it cost ~2&nbsp;KB of code in each app.</li>
  520. <li><strong>Strict converter.</strong> mkicons reads only what symbolic icons use (<code>&lt;svg viewBox&gt;</code>, <code>&lt;g&gt;</code>, <code>&lt;path&gt;</code>, <code>&lt;rect&gt;</code>, <code>&lt;circle&gt;</code>, <code>&lt;ellipse&gt;</code>, fill, fill-rule, opacity) and fails the build on transforms, strokes, <code>style</code> or unknown elements instead of drawing a wrong icon. <code>./mkicons assets/icons/adwaita 16 out.icn -v</code> prints an ASCII preview of every mask.</li>
  521. </ul>
  522. </section>
  523. <section id="cursors">
  524. <h2>Mouse cursors</h2>
  525. <p>
  526. The cursor set is the GNOME Adwaita theme (adwaita-cursors 51,
  527. LGPL-3 or CC-BY-SA-3.0). Its 24&nbsp;px Xcursor images are copied
  528. into <span class="file">assets/cursors/adwaita/</span> (trimmed by
  529. <span class="file">tools/xcursor_trim.py</span>), and the host tool
  530. <span class="file">tools/mkcursors.c</span> turns them into one
  531. <code>NBCUR1</code> bundle, <code>/ramfs/cursors/adwaita24.cur</code>
  532. (layout in <span class="file">include/cursor_abi.h</span>):
  533. 35 shapes named after the CSS <code>cursor</code> keywords, each
  534. with its size, hotspot, frame count and premultiplied ARGB8888
  535. frames. The animated <code>wait</code>/<code>progress</code>
  536. spinners keep every fourth of Adwaita's 60 frames (15 frames at
  537. 64&nbsp;ms, the same speed). The bundle is ~146&nbsp;KB raw,
  538. ~18&nbsp;KB gzip, and only in the full pack: the floppy lite pack
  539. has no room, so a floppy boot keeps the built-in 16&times;16 arrow.
  540. </p>
  541. <ul>
  542. <li><strong>Loading.</strong> <span class="file">cursor.c</span> copies the bundle out of the ramfs into its own pages after <code>ramfs_init()</code> and after every <code>ramfs_replace()</code> (the old pack is freed), then tells <span class="file">mouse.c</span> to re-fetch its image.</li>
  543. <li><strong>Selection.</strong> On every <code>SYS_WM_POLL</code> the window server resolves the shape: the WM's override (<code>SYS_WM_SET_CURSOR</code>: resize arrows on the resize band and while resizing, the move cross during a title-bar drag, a hand over the start button, the start menu and the status cluster), else the cursor of the window holding the pointer capture, else the content cursor (<code>SYS_WIN_SET_CURSOR</code>) of the window under the pointer, else the arrow.</li>
  544. <li><strong>Clients.</strong> ngui resets the cursor to the arrow for each redrawn frame, a hovered text field asks for the I-beam, <code>ngui_cursor_rect()</code>/<code>ngui_set_cursor()</code> serve apps, and <code>ngui_end_ex()</code> sends it when it changed. The terminal uses the I-beam; the browser maps the inherited CSS <code>cursor</code> property and, for <code>auto</code>, a hand over links, an I-beam over text fields and the progress arrow while a page loads. The gallery's Cursors section shows every shape.</li>
  545. <li><strong>Drawing.</strong> <code>cur_x</code>/<code>cur_y</code> stay the hotspot; the image's top-left is the hotspot minus the image's hotspot and may be off-screen. The software cursor saves up to 32&times;32 pixels under it and blends the premultiplied pixels over them. Intel Ironlake and Radeon copy the ARGB image into their 64&times;64 planes (Intel uses CURPOS sign bits for negative positions and follows the matching primary plane's gamma enable, because the display palette is after the plane blender and a cursor-only gamma pass brightens its antialiased edges on a VBE mode whose primary bypasses the palette; Radeon uses <code>HORZ_VERT_OFF</code> plus a shifted <code>CUR_OFFSET</code>); Cirrus reduces it to its two colours and clamps the position at 0. Animated frames advance from <code>mouse_poll_update()</code>.</li>
  546. </ul>
  547. </section>
  548. <section id="gpu">
  549. <h2>GPU quirks</h2>
  550. <ul>
  551. <li><strong>ATI Mach64.</strong> A CRTC fixup is applied after mode set. The legacy CRTC is skipped under UEFI.</li>
  552. <li><strong>NVIDIA.</strong> VBE/GOP only; the kernel never touches the legacy VGA CRTC. On the ION, the framebuffer is stolen DRAM behind a BAR3 aperture; <span class="file">nvidia.c</span> finds the stolen range and writes through a cached alias once a WC MTRR covers it. The nv50 display-engine probe is gated to the ION/nv50 chipsets so Maxwell parts (the GM206 GTX 960) are not poked through nv50 registers. On AMD family 15h the WC MTRR path uses only a free variable entry, leaves <code>MTRRdefType</code> untouched and writes a zero high mask (the LFB is below 4 GB); this is validated on the 970A-DS3P.</li>
  553. <li><strong>Intel.</strong> The Ironlake-era path supports a hardware cursor where available; the software cursor is the common fallback. Cherryview/Braswell also exposes the panel backlight (below).</li>
  554. <li><strong>UEFI.</strong> <code>vga.c</code> honours the RGBX flag and skips the VBE-only ATI CRTC reset and NVIDIA stolen-VRAM alias. <span class="file">mouse.c</span> forces the software cursor.</li>
  555. </ul>
  556. </section>
  557. <section id="backlight">
  558. <h2>Panel backlight</h2>
  559. <p>
  560. The HP Chromebook 11 G5 (<code>google/setzer</code>, Braswell)
  561. drives its internal panel PWM from the display engine, not from
  562. the Chrome EC. The board VBT (<code>data.vbt</code>, block 43)
  563. declares PWM controller 0 at 200 Hz, active high. Linux uses the
  564. same Valleyview/Cherryview registers through
  565. <code>intel_backlight</code>.
  566. </p>
  567. <ul>
  568. <li><strong>Registers.</strong> <code>BLC_PWM_CTL2</code> at GPU BAR0 + <code>0x1E1250</code> (pipe A; pipe B is <code>+0x100</code>): bit 31 enables, bit 28 is polarity. <code>BLC_PWM_CTL</code> at <code>0x1E1254</code>: period in bits 31:16, duty in bits 15:0. The Cherryview PWM clock is 19.2 MHz with a fixed /16 increment, so 200 Hz is a period of 6000.</li>
  569. <li><strong>Probe.</strong> <span class="file">backlight.c</span> matches Intel <code>8086:22b0</code>/<code>22b1</code>, maps the graphics MMIO BAR, reads both pipes, follows the one the firmware enabled and falls back to controller 0. It logs the chosen pipe, period, duty and raw registers to COM1.</li>
  570. <li><strong>Use.</strong> The <code>backlight</code> command prints the percentage and PWM state; <code>backlight up|down</code> steps by 10%, <code>backlight 0-100</code> sets a level (clamped to 5..100), and <code>backlight probe</code> dumps both pipes' registers. <code>SYS_BACKLIGHT</code> gives ring 3 the same get/set/step, which drives the control panel's brightness slider. F6/F7 (the ChromeOS EC action-row brightness keys) and the standard <code>E0 14</code>/<code>E0 15</code> brightness scancodes adjust it; the keys are consumed in <span class="file">io.c</span> and never reach a window.</li>
  571. <li><strong>Overlay.</strong> <code>SYS_WM_POLL</code> also reports the backlight percentage and a change counter. After each change the ring-3 WM (<span class="file">ucmd_wm.c</span>) draws a centered <em>Brightness</em> bubble with a sun icon, the percentage and a level bar, keeps it up for 3 s, and composits it above the windows on every pass while it is visible.</li>
  572. <li><strong>Limits.</strong> Only the Cherryview/Braswell native PWM (<code>8086:22b0</code>/<code>22b1</code>) is driven. The level is not persisted; a cold boot returns to the firmware's duty.</li>
  573. </ul>
  574. </section>
  575. <section id="sources">
  576. <h2>Source map</h2>
  577. <ul class="filelist">
  578. <li><code>kernel/vga.c</code>, <code>kernel/vga.h</code> — framebuffer and damage</li>
  579. <li><code>kernel/bootcon.c</code> — direct-to-LFB boot console</li>
  580. <li><code>kernel/vga_copy.S</code> — copy primitives</li>
  581. <li><code>kernel/blit.c</code>, <code>kernel/blit.h</code> — pixel vtable</li>
  582. <li><code>kernel/cpu.c</code> — SSE2 probing</li>
  583. <li><code>kernel/wm.c</code>, <code>kernel/wm.h</code>, <code>include/wm_abi.h</code> — kernel window server and shared ABI</li>
  584. <li><code>kernel/init.c</code>, <code>kernel/init.h</code> — starts PID 1; init is the only WM creator</li>
  585. <li><code>user/apps/wm/ucmd_wm.c</code>, <code>user/lib/uwm/uwm_lib.c</code> — ring-3 WM</li>
  586. <li><code>user/apps/netmenu/ucmd_netmenu.c</code> — top-bar control panel (network/WiFi, brightness, power mode, Date &amp; Time)</li>
  587. <li><code>user/apps/settime/ucmd_settime.c</code>, <code>kernel/rtc.c</code>, <code>kernel/ntp.c</code> — Date &amp; Time editor, RTC access and SNTP sync</li>
  588. <li><code>kernel/gfx.c</code>, <code>kernel/gfx.h</code> — RGB565 window canvases</li>
  589. <li><code>kernel/sys_wm.c</code>, <code>kernel/sys_wm.h</code> — WM/window ABI</li>
  590. <li><code>user/apps/browser/browser.c</code>, <code>user/apps/browser/browser_html.c</code> — HTML/CSS renderer and inline SVG</li>
  591. <li><code>user/lib/ngui/ngui.c</code>, <code>user/lib/ngui/ngui.h</code> — toolkit</li>
  592. <li><code>user/lib/ufont/ufont.c</code>, <code>user/lib/ufont/ufont_ttf.c</code>, <code>user/lib/ufont/ufont_draw.c</code> — fixed-point TrueType text</li>
  593. <li><code>user/lib/ufont/ufont_woff.c</code> — WOFF 1.0 to sfnt (browser only)</li>
  594. <li><code>fonts/*.ttf</code> — Arimo / Liberation Mono / Noto Emoji subsets in the pack</li>
  595. <li><code>user/apps/files/ucmd_files.c</code>, <code>user/apps/process/ucmd_process.c</code>, <code>user/apps/gallery/gallery.c</code>, <code>user/apps/solitaire/ucmd_solitaire.c</code>, <code>user/apps/chat/ucmd_chat.c</code></li>
  596. <li><code>user/lib/img/img*.c</code> — image codecs</li>
  597. <li><code>kernel/ati.c</code>, <code>kernel/nvidia.c</code>, <code>kernel/intel.c</code>, <code>kernel/nv50.c</code></li>
  598. <li><code>kernel/backlight.c</code>, <code>kernel/backlight.h</code> — Cherryview/VLV panel PWM</li>
  599. <li><code>kernel/cursor.c</code>, <code>kernel/cursor.h</code>, <code>kernel/mouse.c</code>, <code>kernel/cursor_shape.h</code> — cursor bundle loader, drawing and the built-in fallback arrow; <code>kernel/cirrus.c</code>, <code>kernel/radeon.c</code> — hardware cursors</li>
  600. <li><code>include/icon_abi.h</code>, <code>tools/mkicons.c</code>, <code>assets/icons/adwaita/</code> — UI icon list, the NBICO1 bundle and the Adwaita symbolic SVGs</li>
  601. <li><code>include/cursor_abi.h</code>, <code>tools/mkcursors.c</code>, <code>tools/xcursor_trim.py</code>, <code>tools/cursor_test.c</code>, <code>assets/cursors/adwaita/</code> — cursor shapes, the NBCUR1 bundle and the Adwaita source images</li>
  602. </ul>
  603. </section>
  604. </main>
  605. <footer class="site-footer">
  606. <div class="inner">
  607. <p><strong>NebOS 0.2.0</strong> · Architecture documentation · <a href="index.html">overview</a></p>
  608. <p>Maintain alongside <code>AGENTS.md</code> and the source files listed on each page.</p>
  609. </div>
  610. </footer>
  611. </body>
  612. </html>