@weasel-js/text 1.9.3 → 1.10.0

package/README.md

@@ -17,23 +17,25 @@ npm install @weasel-js/text
 
 ## Usage
 
-`layoutRuns` is the glyph walk: it takes fully-resolved runs and returns
-positioned geometry, grouped so that one group is one draw call.
+`layoutRuns` is the glyph walk: it takes fully-resolved runs and returns the
+lines they wrap into, with every glyph placed. `paintRuns` turns that into what
+to draw: the glyphs gathered into groups that share a face and a paint, and the
+decoration rules. Paint is read only there, so recoloring text reuses its layout.
 
 ```ts
-import { toRuns, resolveTextStyle, resolveRuns, layoutRuns } from '@weasel-js/text';
+import { toRuns, resolveTextStyle, resolveRuns, layoutRuns, paintRuns } from '@weasel-js/text';
 
 const style = resolveTextStyle({ fontFamily: 'inter', fontSize: 64 });
-const { groups, lines, bounds } = layoutRuns(resolveRuns(toRuns('Hello'), style), {
-  maxWidth: 900,
-  lineHeight: 1.2,
-  align: 'center',
-});
+const runs = resolveRuns(toRuns('Hello'), style);
+const laid = layoutRuns(runs, { maxWidth: 900, lineHeight: 1.2, align: 'center' });
+const { lines, bounds } = laid;
+const { groups, decorations } = paintRuns(laid, runs);
 ```
 
 A group carries either textured quads (from a baked MSDF atlas) or outline
 glyphs — em-space SVG path data plus the pen position, baseline and scale to
-place it — for a consumer that tessellates its own geometry.
+place it — for a consumer that tessellates its own geometry. `cachedLayoutRuns`
+and `cachedPaintRuns` are the same two calls, memoized.
 
 Metrics come from whichever tier resolved the family: a baked MSDF atlas, or —
 for a family registered with `registerFontOutlines` and no atlas — the parsed