54 lines
3.0 KiB
Markdown
54 lines
3.0 KiB
Markdown
# XCEngine API Documentation
|
|
|
|
**命名空间**: `XCEngine`
|
|
|
|
**类型**: `index`
|
|
|
|
**描述**: 指向 `docs/api/XCEngine` 平行目录树的唯一 canonical API 文档入口。
|
|
|
|
## 概览
|
|
|
|
`docs/api/XCEngine/**` 是唯一正式 API 文档树，其层级与 `engine/include/XCEngine/**` 保持平行。
|
|
模块总览页、子模块总览页、类型总览页和方法页都应从这棵目录树进入，不再保留第二套正式入口。
|
|
|
|
## Canonical 入口
|
|
|
|
- [XCEngine/XCEngine.md](XCEngine/XCEngine.md) - 与 `engine/include/XCEngine` 平行的文档根目录
|
|
- [_meta/rebuild-status.md](_meta/rebuild-status.md) - 当前覆盖率与审计状态
|
|
|
|
## 模块导航
|
|
|
|
| 模块 | Canonical 文档 | 对应源码目录 |
|
|
|------|----------------|--------------|
|
|
| `Audio` | [XCEngine/Audio/Audio.md](XCEngine/Audio/Audio.md) | `XCEngine/Audio/` |
|
|
| `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/` |
|
|
| `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/` |
|
|
| `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/` |
|
|
| `Threading` | [XCEngine/Threading/Threading.md](XCEngine/Threading/Threading.md) | `XCEngine/Threading/` |
|
|
|
|
## 关键子模块
|
|
|
|
| 子模块 | Canonical 文档 | 对应源码目录 |
|
|
|--------|----------------|--------------|
|
|
| `Core/Asset` | [XCEngine/Core/Asset/Asset.md](XCEngine/Core/Asset/Asset.md) | `XCEngine/Core/Asset/` |
|
|
| `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/` |
|
|
| `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/` |
|
|
| `RHI/D3D12` | [XCEngine/RHI/D3D12/D3D12.md](XCEngine/RHI/D3D12/D3D12.md) | `XCEngine/RHI/D3D12/` |
|
|
| `RHI/OpenGL` | [XCEngine/RHI/OpenGL/OpenGL.md](XCEngine/RHI/OpenGL/OpenGL.md) | `XCEngine/RHI/OpenGL/` |
|
|
|
|
## 相关文档
|
|
|
|
- [XCEngine 平行目录根](XCEngine/XCEngine.md)
|
|
- [API 文档重构状态](_meta/rebuild-status.md)
|
|
- [XCEngine 架构设计](../plan/XCEngine渲染引擎架构设计.md)
|