API Reference¶
接口签名、构造参数、配置 schema、调用示例和开发命令统一放在本目录。 算法、模块边界、数据流及资源所有权的解释集中在 doc/。 引用按当前源码整理;历史性能/客户端验收记录会标明当时的环境,文档迁移不表示本次重新验证。
模型、骨骼与动画¶
| 文档 | 内容 |
|---|---|
| 通用模型姿态与动画 | Model 片段库、格式接入、ModelPosing、静态 Pose、IK 通道和接口迁移 |
| Model 组装与穿搭缓存 | 组件 Builder、共享骨架、隐藏区域、引用重映射、LRU 缓存和扩展接口 |
| Minecraft 穿搭资源与切换 | 资源包 JSON、程序注册、句柄换装、资源重载和实例状态迁移 |
| Anchor 与 MC 装备 | 通用锚点、相机相对坐标、手持/头戴物品、自定义装备 renderer 和生命周期 |
| 真实素材换装示例 | RibbonDress 换纹理/换模型、MC 手持物品、客户端截图和性能对照 |
| Skeleton Dynamics | 通用刚体/关节、Reader/Builder、IK 限位与反向映射、菱形闭环、实例控制和诊断 |
| Physics 与 tick loop | 原生 world、复合形状、关节、力/冲量、环境、拖拽、主动布娃娃、锚点和方块物理 |
| MMD/glTF 配置与部署 | model manifest、profile 字段、角色限位、运行时部署和命令 |
| 模型加载与渲染 | 资源格式、model_proxy、实例创建、Blockbench 与运行入口 |
| 摄像机与动画 | 直接控制、关键帧、JSON、共享时间轴与模型片段绑定 |
| FSM | 状态变量、层/状态/转移、姿态 schema 与宿主绑定 |
| Multiplexer | 变体选择 DSL、Builder、实例状态及 FSM 组合 |
渲染与输出¶
| 文档 | 内容 |
|---|---|
| 自定义渲染、Effects 与 Shader DSL / Shader DSL / 效果与后处理 | 注册/作用域、管线描述、shader、参数、DSL、效果和后处理图 |
| UML framework | backend/context/factory、调度与 buffer 的公共接口和生命周期契约 |
| 后端扩展 | 独立后端模块、宿主帧上下文、上传与输出适配 |
| 调度与模型句柄 | McModelHandle、可见性、Entity/BlockEntity renderer 接入 |
| 世界 UI 与自由光标 | 透明输入层、屏幕反投影、世界面板、拖拽捕获与键盘焦点 |
| 最终画面输出 | 订阅、共享帧、MIRROR/OFFSCREEN_ONLY、异常与关闭 |
| Player / Free / Fixed Camera | 相机分类、创建、通用跟随目标、实体绑定、投影和运行时渲染配置 |
| 多机位输出契约 / 启动与验证实操 | 相机生命周期、资源包、独立窗口、启动、FBO 消费和录制 |
| PBR | 玩家 JSON、Java 转换规则、上下文、优先级和诊断命令 |
| Alpha/OIT | 材质 pass、调试场景、命令、快捷键和验收指标 |
| 体积云 | 多层天空配置、单云实例、质量、预览与验证入口 |
数据与工具¶
| 文档 | 内容 |
|---|---|
| 数据驱动注册 | 内容 schema、工厂与属性扩展、诊断与 reload;入门与教程在 data-driven/(四篇参考 + 三篇指南) |
| Formula | 表达式、Namespace、函数/变量、运算符和错误 |
| 构建与验证入口 | Gradle 任务、独立 GL、客户端验收与证据边界 |
文档维护¶
新增可调用接口时在本目录补全包名、签名、单位、默认值、错误条件与生命周期,并链接到对应原理。 修改接口时同步调用示例与配置表。迁移或改名时更新本索引、根 README、相对链接与锚点。 原理文档可以使用类型名、数学表达式和流程图解释机制;方法参考、配置表和操作步骤在本目录维护。