docs: fill out compat, lvglh, and toolchain documentation
continuous-integration/drone/push Build is failing
continuous-integration/drone/push Build is failing
Replace placeholder content in doc/compat/, doc/lvglh/, and doc/toolchain/ with comprehensive documentation derived from the source files. - compat: document Wasuro WASM VM compatibility shims - lvglh: document LVGL v9.2.2 configuration, fonts, and patches - toolchain: document all 13 build pipeline scripts
This commit is contained in:
1 parent
d059ff1ffb
commit
466173613f
19 files changed
+888
-32
No files matched your search
+53
-1
@@ -1 +1,53 @@
|
||||
# Placeholder
|
||||
# hack_14.c
|
||||
|
||||
LVGL bitmap font source for the Hack Regular typeface at 14 px.
|
||||
|
||||
## Overview
|
||||
|
||||
This file contains a pre-rendered bitmap font generated from the Hack Regular TrueType font (`Hack-Regular.ttf`) for use with LVGL. It provides a complete monospaced programmer font covering the full Basic Multilingual Plane (Unicode range 0x0000--0xFFFF). The font is intended for use in terminal emulators, code editors, or any UI element within Asuro that benefits from a fixed-width typeface.
|
||||
|
||||
The file was generated by the LVGL font converter tool and is approximately 12,900 lines (~548 KB) of static bitmap and glyph descriptor data.
|
||||
|
||||
## Configuration Options / Defines
|
||||
|
||||
### HACK_14
|
||||
Value: `1` (default). Acts as a compile-time guard. Set to `0` to exclude this font from the build entirely.
|
||||
|
||||
## Font Properties
|
||||
|
||||
| Property | Value |
|
||||
|----------|-------|
|
||||
| Font family | Hack Regular |
|
||||
| Size | 14 px |
|
||||
| Bits per pixel | 4 (16-level anti-aliasing) |
|
||||
| Compression | None (`--no-compress`) |
|
||||
| Stride alignment | 1 byte |
|
||||
| Data alignment | 1 byte |
|
||||
| Line height | 19 px |
|
||||
| Baseline | 5 px from bottom |
|
||||
| Underline position | -2 |
|
||||
| Underline thickness | 1 |
|
||||
| Unicode range | 0x0000--0xFFFF |
|
||||
| Subpixel rendering | None |
|
||||
|
||||
## Public Symbol
|
||||
|
||||
```c
|
||||
const lv_font_t hack_14;
|
||||
```
|
||||
|
||||
This is the font descriptor exposed for use in LVGL widget styles. Reference it as `&hack_14` when assigning fonts to labels, text areas, or other text-bearing widgets.
|
||||
|
||||
## Generation Command
|
||||
|
||||
```
|
||||
--bpp 4 --size 14 --no-compress --stride 1 --align 1 \
|
||||
--font Hack-Regular.ttf --range 0-65535 --format lvgl -o hack_14.c
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
- This is a machine-generated file. Do not edit by hand; regenerate using the LVGL font converter if changes are needed.
|
||||
- The full 0--65535 Unicode range makes this a large file. If binary size is a concern, the range could be narrowed to only the code points actually used.
|
||||
- The font includes version-conditional compilation guards for compatibility across LVGL 6.x through 9.x, though Asuro targets LVGL 9.2.2.
|
||||
- The `LV_ATTRIBUTE_LARGE_CONST` annotation on the glyph bitmap array allows the linker to place it in an appropriate read-only section.
|
||||
Reference in new issue
Block a user