dymokomi/luce-browser-render
Source of release 0.6.1
0.6.1 / README.md
# luce-browser-render
Geometry, color, fonts, the CPU rasterizer and the display list of the luce-browser port of Ladybird, in luce-base.
Part of the luce-browser family, a faithful port of Ladybird's LibWeb to luce-base; the design every
porter follows is [DESIGN.md](../luce-browser-engine/docs/DESIGN.md).
| Module | Contents |
| --- | --- |
| `gfx` | LibGfx geometry, color, paths; CSS pixels; color spaces (Gfx::ColorSpace over luce-color's `icc`, its port of skcms and SkColorSpace) |
| `web_fonts` | fonts and text layout: LibGfx's Font, Typeface, FontDatabase, FontCascadeList and TextLayout over luce-fonts' portable engine (its `opentype` reader and `shaping`, which replace Skia's FreeType backend and HarfBuzz) |
| `raster` | the CPU rasterizer: tiny-skia ported and changed to paint exactly as Skia m144 (see its module.lucb), with Skia's color space conversion of image patterns (`color_xform`) |
| `display_list` | the display list |
Depends on: luce-std, luce-browser-foundation, luce-browser-css, luce-color, luce-fonts (and
through it luce-compress).
## Status
Skeleton: every type of the phase-1 closure is declared and every function has its generated
signature and a `trap("unported: ...")` body, grouped by region (`docs/regions.tsv`). Regions
replace their stub fragments with ported code (DESIGN.md ยง4.5). `docs/namemap.tsv` maps every C++
name to its Luce name; `docs/gc_fields.tsv` lists the GC pointer fields each cell must visit.
The skeleton is generated from Ladybird at `47c82b38d0` (see `PIN`) by a local tool that is not part
of this repository.
## Testing
`./test.sh` checks the formatting, type-checks every module with warnings as errors and runs
every module's tests (the CPU display-list player is compared with Skia's pixels, the fonts
and paths with the reference build's LibGfx, the rasterizer with tiny-skia's reference
images). The font oracle's face, metrics, path and shaping cases test the engine and run in
luce-fonts; its text-blob bounds and glyph intercepts, which test GlyphRun, run here.
## License
BSD-2-Clause, as Ladybird; see `LICENSE`. The raster module ports Skia (`LICENSE-skia`), tiny-skia
(`LICENSE-tiny-skia`) and FreeType's gray rasterizer (`LICENSE-freetype`, the FreeType License).