XCEngine/docs/api/XCEngine/XCEngine.md

XCEngine

命名空间: XCEngine

类型: module-root

描述: XCEngine public API 的根目录入口，对齐 engine/include/XCEngine 的源码模块结构。

概览

docs/api/XCEngine 是当前唯一的 canonical API 文档树。它和 engine/include/XCEngine 保持平行目录结构，用来回答两类问题：

• 这个模块在引擎里负责什么，边界在哪里。
• 这个 public header 在当前版本里到底做到了什么程度。

同时，这里也统一收纳编辑器侧 API 文档入口 Editor，用于描述与引擎并行协作的编辑器应用层接口。

本轮收口之后，Core/Asset、Rendering、Resources 和 Scene 这几个模块已经把基础 helper / 协议层 header 也纳入了 canonical 文档，而不只覆盖高层类和模块页。

设计原则

• 目录结构与源码平行，避免“文档是一套世界，源码又是一套世界”。
• 类型页聚焦契约、生命周期和当前真实行为。
• _guides 负责教程、设计理念和工作流解释，不再维护第二套 API 树。

子目录

• Audio
• Components
• Core
• Debug
• Editor
• Input
• Memory
• Platform
• RHI
• Rendering
• Resources
• Scene
• Scripting
• Threading

重点入口

• Core / Asset - 项目资产身份、artifact 缓存与运行时资源加载基础设施。
• Rendering - 相机请求规划、场景提取、主管线、object-id 与显式 RenderPassSequence 主链路。
• Resources - 具体资源类型以及 builtin:// 内置资源入口。
• Scene - 场景容器、运行态执行器与时间推进控制。

相关文档

• API 总索引
• API 文档重构状态