用途:这是 pmndrs/glyph 文本引擎的一份调用契约说明,用于在新增、移动或删除已发布接口前,统一 API 的形态与命名位置。
主要规则:引擎调用是同步的,构造时要求字体,文本与 span 在构造处校验,约束由调用自身检查,因此调用要么返回答案,要么就地抛错。layout() 返回度量,glyphs() 返回检查结果,不使用 { ok } 联合、可空值或事后查阅的带外错误。对语言可表达但无意义的输入(如 { mode: 'at-most', size: NaN }),从调用处抛错并指明轴、span 或偏移。
错误策略:只由调用方能造成的失败才抛错;只由包自身造成的属于生产者缺陷,应加强生产者/ABI/属性测试,而非加运行时扫描。被拒绝的帧不得让引擎残留拒绝工作、按帧率重编译无效帧或留下需调用方清除的闩锁,应报告一次并保持场景其余部分(变换、可见性、渲染顺序)沿用最后一次被接受的发布。
命名与入口:应用可遇到的值和类型在根入口,只有集成方调用的渲染器中立辅助在 /core。ParagraphMeasurement、GlyphConfig 在根;defineGlyphConfig 在 /core。内置 bitmap、msdf、slug 格式值及公共选项/数据类型在根,其 schema、codec、格式解释辅助在 /core。内部引擎、planner、wire、projection、binding 机制无公开子路径。./three、./react、./typegpu 暴露各自应用表面;./shaders/tsl、./shaders/typegpu 提供可复用技术着色器,不含引擎或场景。集成仅在其自身签名用到时才可再导出根名称,入口边界测试会强制执行。
限制:文档未给出安装命令、代码示例外的具体 API 签名或性能数据,暂未提供相关收费、平台与效果信息。