62 lines
2.4 KiB
Markdown
62 lines
2.4 KiB
Markdown
# XCEngine
|
|
|
|
**命名空间**: `XCEngine`
|
|
|
|
**类型**: `module-root`
|
|
|
|
**描述**: `XCEngine` runtime public API 与旧编辑器应用层文档根，对齐 `engine/include/XCEngine` 与 `editor/src` 的现有 canonical 结构。
|
|
|
|
## 概览
|
|
|
|
`docs/api/XCEngine` 不再是唯一的 canonical API 根树。它当前负责：
|
|
|
|
- `engine/include/XCEngine/**` 这组 runtime public headers
|
|
- `editor/src/**` 这组旧编辑器应用层文档入口
|
|
|
|
新编辑器基础层 public headers 已转到 [XCEditor](../XCEditor/XCEditor.md)。
|
|
|
|
这棵树和 `engine/include/XCEngine` 保持平行目录结构，用来回答两类问题：
|
|
|
|
- 这个模块在引擎里负责什么，边界在哪里。
|
|
- 这个 public header 在当前版本里到底做到了什么程度。
|
|
|
|
同时，这里继续收纳旧编辑器应用层入口 [Editor](Editor/Editor.md)，用于描述与引擎并行协作的工具应用接口。
|
|
|
|
本轮收口之后，`Core/Asset`、`Rendering`、`Resources` 和 `Scene` 这几个模块已经把基础 helper / 协议层 header 也纳入了 canonical 文档，而不只覆盖高层类和模块页。
|
|
|
|
## 设计原则
|
|
|
|
- 目录结构与源码平行，避免“文档是一套世界，源码又是一套世界”。
|
|
- 类型页聚焦契约、生命周期和当前真实行为。
|
|
- `_guides` 负责教程、设计理念和工作流解释，不再维护第二套 API 树。
|
|
|
|
## 子目录
|
|
|
|
- [Audio](Audio/Audio.md)
|
|
- [Components](Components/Components.md)
|
|
- [Core](Core/Core.md)
|
|
- [Debug](Debug/Debug.md)
|
|
- [Editor](Editor/Editor.md)
|
|
- [Input](Input/Input.md)
|
|
- [Memory](Memory/Memory.md)
|
|
- [Platform](Platform/Platform.md)
|
|
- [RHI](RHI/RHI.md)
|
|
- [Rendering](Rendering/Rendering.md)
|
|
- [Resources](Resources/Resources.md)
|
|
- [Scene](Scene/Scene.md)
|
|
- [Scripting](Scripting/Scripting.md)
|
|
- [Threading](Threading/Threading.md)
|
|
|
|
## 重点入口
|
|
|
|
- [Core / Asset](Core/Asset/Asset.md) - 项目资产身份、artifact 缓存与运行时资源加载基础设施。
|
|
- [Rendering](Rendering/Rendering.md) - 相机请求规划、场景提取、主管线、object-id 与显式 `RenderPassSequence` 主链路。
|
|
- [Resources](Resources/Resources.md) - 具体资源类型以及 `builtin://` 内置资源入口。
|
|
- [Scene](Scene/Scene.md) - 场景容器、运行态执行器与时间推进控制。
|
|
|
|
## 相关文档
|
|
|
|
- [API 总索引](../main.md)
|
|
- [XCEditor API 根](../XCEditor/XCEditor.md)
|
|
- [API 文档重构状态](../_meta/rebuild-status.md)
|