xuanchi/XCEngine
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: expand rendering core docs

Browse Source
This commit is contained in:
ssdfasd
2026-04-03 15:30:47 +08:00
parent e8f64407ba
commit 4616e6fd1f
16 changed files with 636 additions and 241 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/api/main.md
View File

@@ -4,17 +4,21 @@
**类型**: `index`
**描述**: 指向 `docs/api/XCEngine` 平行目录树的唯一 canonical API 文档入口。
**描述**: 指向 `docs/api/XCEngine` 平行目录树与审计状态页的统一 API 文档入口。
## 概览
`docs/api/XCEngine/**` 是唯一正式 API 文档树，其层级与 `engine/include/XCEngine/**` 保持平行。
模块总览页、子模块总览页、类型总览页和方法页都应从这棵目录树进入，不再保留第二套正式入口。
`docs/api/XCEngine/**` 是当前唯一正式的 canonical API 文档树，其层级与 `engine/include/XCEngine/**` 保持平行。
根索引负责两件事：
- 给出所有主要模块的入口导航。
- 指向最新的文档审计状态，方便确认覆盖率、断链和遗留缺口。
## Canonical 入口
- [XCEngine/XCEngine.md](XCEngine/XCEngine.md) - 与 `engine/include/XCEngine` 平行的文档根目录
- [_meta/rebuild-status.md](_meta/rebuild-status.md) - 当前覆盖率与审计状态
- [_meta/rebuild-status.md](_meta/rebuild-status.md) - 当前覆盖率、链接检查和审计状态
## 模块导航
@@ -24,12 +28,15 @@
| `Components` | [XCEngine/Components/Components.md](XCEngine/Components/Components.md) | `XCEngine/Components/` |
| `Core` | [XCEngine/Core/Core.md](XCEngine/Core/Core.md) | `XCEngine/Core/` |
| `Debug` | [XCEngine/Debug/Debug.md](XCEngine/Debug/Debug.md) | `XCEngine/Debug/` |
| `Editor` | [XCEngine/Editor/Editor.md](XCEngine/Editor/Editor.md) | `editor/src/` |
| `Input` | [XCEngine/Input/Input.md](XCEngine/Input/Input.md) | `XCEngine/Input/` |
| `Memory` | [XCEngine/Memory/Memory.md](XCEngine/Memory/Memory.md) | `XCEngine/Memory/` |
| `Platform` | [XCEngine/Platform/Platform.md](XCEngine/Platform/Platform.md) | `XCEngine/Platform/` |
| `Rendering` | [XCEngine/Rendering/Rendering.md](XCEngine/Rendering/Rendering.md) | `XCEngine/Rendering/` |
| `Resources` | [XCEngine/Resources/Resources.md](XCEngine/Resources/Resources.md) | `XCEngine/Resources/` |
| `RHI` | [XCEngine/RHI/RHI.md](XCEngine/RHI/RHI.md) | `XCEngine/RHI/` |
| `Scene` | [XCEngine/Scene/Scene.md](XCEngine/Scene/Scene.md) | `XCEngine/Scene/` |
| `Scripting` | [XCEngine/Scripting/Scripting.md](XCEngine/Scripting/Scripting.md) | `XCEngine/Scripting/` |
| `Threading` | [XCEngine/Threading/Threading.md](XCEngine/Threading/Threading.md) | `XCEngine/Threading/` |
## 关键子模块
@@ -40,6 +47,8 @@
| `Core/Containers` | [XCEngine/Core/Containers/Containers.md](XCEngine/Core/Containers/Containers.md) | `XCEngine/Core/Containers/` |
| `Core/IO` | [XCEngine/Core/IO/IO.md](XCEngine/Core/IO/IO.md) | `XCEngine/Core/IO/` |
| `Core/Math` | [XCEngine/Core/Math/Math.md](XCEngine/Core/Math/Math.md) | `XCEngine/Core/Math/` |
| `Editor/Viewport` | [XCEngine/Editor/Viewport/Viewport.md](XCEngine/Editor/Viewport/Viewport.md) | `editor/src/Viewport/` |
| `Rendering/Passes` | [XCEngine/Rendering/Passes/Passes.md](XCEngine/Rendering/Passes/Passes.md) | `XCEngine/Rendering/Passes/` |
| `Platform/Windows` | [XCEngine/Platform/Windows/Windows.md](XCEngine/Platform/Windows/Windows.md) | `XCEngine/Platform/Windows/` |
| `Resources/Mesh` | [XCEngine/Resources/Mesh/Mesh.md](XCEngine/Resources/Mesh/Mesh.md) | `XCEngine/Resources/Mesh/` |
| `Resources/Texture` | [XCEngine/Resources/Texture/Texture.md](XCEngine/Resources/Texture/Texture.md) | `XCEngine/Resources/Texture/` |
@@ -50,4 +59,4 @@
- [XCEngine 平行目录根](XCEngine/XCEngine.md)
- [API 文档重构状态](_meta/rebuild-status.md)
- [XCEngine 架构设计](../plan/XCEngine渲染引擎架构设计.md)
- [XCEngine 架构设计](../used/XCEngine渲染引擎架构设计.md)