Reference pages for the @awacloud/fonts modules, organised like src/. Each page documents one module descriptor: what it returns when resolved, its dependencies and a usage example. The entry point is main, which also lists every descriptor the package root exports and marks those that have no page of their own (internal sub-modules documented through their parent module).
Prerequisites: the @awacloud/fonts package and an @awacloud/fw runtime — descriptors are resolved by name (fw.runtime.resolve('<module>')) after registering the manifest arrays; see main. The sections below are grouped by area; every page is current for the published surface.
Errors
- errors —
FontError/ParseError/RenderError/ContractError
Primitives
- primitives/fixed — Fixed 16.16 + F2Dot14
- primitives/tag — Pack/unpack 4-char tags
- primitives/reader —
BinaryReaderBE - primitives/writer —
BinaryWriterBE - primitives/checksum — OT table checksum + head adjustment
- primitives/encoding — UTF-16BE, Mac Roman
Containers
- sfnt/sfnt —
parseSfnt/packSfnt - sfnt/ttc — TTC/OTC collections
- sfnt/woff — WOFF1 (zlib)
- sfnt/woff2 — WOFF2 (Brotli, no inverse transform)
- _shared/ —
fontsShared, container constants and helpers shared by the SFNT, TTC, WOFF and WOFF2 modules
OpenType tables (required)
- table/head
- table/hhea
- table/maxp
- table/hmtx
- table/cmap — formats 0 / 2 / 4 / 6 / 12 / 13 / 14
- table/name
- table/os2 — v0..v5
- table/post — v1 / v2 / v3
- table/loca
- table/glyf
OpenType tables (optional)
- table/cff — CFF Type 2 charstrings
- table/cff2 — CFF2 (variable CFF)
- table/kern — legacy kerning (MS + Apple)
- table/gasp — grid-fitting per ppem
- table/hdmx — horizontal device metrics
- table/vdmx — vertical device metrics
- table/ltsh — linear threshold
- table/vhea table/vmtx table/vorg — vertical metrics and vertical origin
- table/base
Variable fonts
- table/fvar table/avar table/stat — axes and named instances
- table/gvar table/hvar table/mvar — variation deltas
- variable/ — coordsConvert, instance — variable-font helpers
Colour and bitmap
- table/colr table/cpal table/sbix table/svg table/cbdt table/cblc
- table/ebdt table/eblc table/ebsc — embedded bitmap strikes (EBDT data, EBLC locations, EBSC scaling)
Glyph
- glyph/path —
Path+pathFromSimpleGlyph - glyph/glyph —
Glyphwrapper - glyph/compositeResolve — recursive composite resolution
Layout
- layout/classDefinitions — Coverage + ClassDef
- table/gdef table/gsub table/gpos — layout tables
Encodings
- encodings/ — winAnsi, macRoman, macExpert, standard, symbol, zapfDingbats, lookup, aglTable (encodings/aglTable)
- cmap/toUnicode — ToUnicode CMap (Adobe TN #5014)
Embed-PDF
- embed-pdf/ — subsetForPdf, fontDescriptor, cidSystemInfo, toUnicodeBuilder, index
Standard 14
- standard14/ — Helvetica × 4, Times × 4, Courier × 4, Symbol, ZapfDingbats, lookup
Orchestrator
- fonts — top-level
read+.use()
Extra
- extra/tt-hinting — RM05 hinting VM (opcode groups in
extra/tt-hinting/) - extra/woff2-write — WOFF2 encoder
- extra/dsig — Digital Signature
- extra/math extra/jstf
- extra/shaper-arabic extra/shaper-indic extra/shaper-cjk
- extra/apple-aat/ — morx, kerx, ankr, prop, lcar, feat, index