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

docs(api): deepen D3D12 and OpenGL backend docs

Browse Source
This commit is contained in:
ssdfasd
2026-03-27 22:09:58 +08:00
parent 37a90b39e2
commit c7ef9191e4
67 changed files with 1347 additions and 1841 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
docs/api/_meta/rebuild-status.md
View File

@@ -1,16 +1,16 @@
# API 文档重构状态
**生成时间**: `2026-03-27 19:11:24`
**生成时间**: `2026-03-27 22:08:19`
**来源**: `docs/api/_tools/audit_api_docs.py`
## 摘要
- Markdown 页面数（全部）: `2629`
- Markdown 页面数（canonical）: `2610`
- Markdown 页面数（全部）: `2756`
- Markdown 页面数（canonical）: `2736`
- Public headers 数: `227`
- 有效头文件引用数（全部）: `197`
- 有效头文件引用数（canonical）: `197`
- 有效头文件引用数（全部）: `216`
- 有效头文件引用数（canonical）: `216`
- 无效头文件引用数: `0`
- 失效 `.md` 链接数: `0`
- 非 `.md` 相对链接数: `0`
@@ -21,8 +21,8 @@
- Canonical 根目录: `XCEngine`
- 源码目录节点数: `29`
- 已生成目录总览页节点数: `26`
- 缺失目录总览页节点数: `3`
- 已生成目录总览页节点数: `27`
- 缺失目录总览页节点数: `2`
- 支撑目录: `_meta, _tools`
## 模块覆盖
@@ -36,7 +36,7 @@
| `Input` | `5` | `5` | `0` |
| `Memory` | `5` | `5` | `0` |
| `Platform` | `11` | `11` | `0` |
| `RHI` | `87` | `68` | `19` |
| `RHI` | `87` | `87` | `0` |
| `Rendering` | `13` | `10` | `3` |
| `Resources` | `13` | `13` | `0` |
| `Scene` | `3` | `2` | `1` |
@@ -47,38 +47,18 @@
| 字段 | 页面数 |
|------|--------|
| `命名空间` | `305` |
| `类型` | `305` |
| `描述` | `305` |
| `头文件` | `197` |
| `命名空间` | `325` |
| `类型` | `325` |
| `描述` | `325` |
| `头文件` | `216` |
## 缺失的平行目录总览页
- `XCEngine/RHI/Vulkan`
- `XCEngine/Scripting`
- `XCEngine/Scripting/Mono`
## 未覆盖的 public headers
- `XCEngine/RHI/Vulkan/VulkanBuffer.h`
- `XCEngine/RHI/Vulkan/VulkanCommandList.h`
- `XCEngine/RHI/Vulkan/VulkanCommandQueue.h`
- `XCEngine/RHI/Vulkan/VulkanCommon.h`
- `XCEngine/RHI/Vulkan/VulkanDescriptorPool.h`
- `XCEngine/RHI/Vulkan/VulkanDescriptorSet.h`
- `XCEngine/RHI/Vulkan/VulkanDevice.h`
- `XCEngine/RHI/Vulkan/VulkanFence.h`
- `XCEngine/RHI/Vulkan/VulkanFramebuffer.h`
- `XCEngine/RHI/Vulkan/VulkanPipelineLayout.h`
- `XCEngine/RHI/Vulkan/VulkanPipelineState.h`
- `XCEngine/RHI/Vulkan/VulkanRenderPass.h`
- `XCEngine/RHI/Vulkan/VulkanResourceView.h`
- `XCEngine/RHI/Vulkan/VulkanSampler.h`
- `XCEngine/RHI/Vulkan/VulkanScreenshot.h`
- `XCEngine/RHI/Vulkan/VulkanShader.h`
- `XCEngine/RHI/Vulkan/VulkanShaderCompiler.h`
- `XCEngine/RHI/Vulkan/VulkanSwapChain.h`
- `XCEngine/RHI/Vulkan/VulkanTexture.h`
- `XCEngine/Rendering/CameraRenderRequest.h`
- `XCEngine/Rendering/CameraRenderer.h`
- `XCEngine/Rendering/RenderMaterialUtility.h`