fix: improve doc link navigation and tree display

- Fix link resolution with proper relative/absolute path handling
- Improve link styling with underline decoration
- Hide leaf nodes from tree, only show directories
- Fix log file path for packaged app
This commit is contained in:
2026-03-19 12:44:08 +08:00
parent e003fe6513
commit 58a83f445a
1012 changed files with 56880 additions and 22 deletions

View File

@@ -0,0 +1,46 @@
# D3D12Screenshot::Capture
## 函数签名
```cpp
static bool Capture(ID3D12Device* device,
ID3D12CommandQueue* commandQueue,
ID3D12Resource* renderTarget,
const char* filename,
uint32_t width,
uint32_t height)
```
## 中文描述
从渲染目标捕获截图并保存为文件。
## 参数
| 参数 | 类型 | 描述 |
|------|------|------|
| `device` | `ID3D12Device*` | D3D12 设备指针 |
| `commandQueue` | `ID3D12CommandQueue*` | 命令队列指针 |
| `renderTarget` | `ID3D12Resource*` | 渲染目标资源 |
| `filename` | `const char*` | 保存文件名 |
| `width` | `uint32_t` | 宽度 |
| `height` | `uint32_t` | 高度 |
## 返回值
`bool` - 捕获是否成功
## 复杂度
O(n) - 取决于纹理大小
## 示例
```cpp
D3D12Screenshot::Capture(device, commandQueue, renderTarget, "screenshot.png", width, height);
```
## 相关文档
- [D3D12Screenshot](screenshot.md) - 类总览
- [D3D12Screenshot::CopyToReadbackAndSave](copy-to-readback-and-save.md) - 复制到回读缓冲并保存

View File

@@ -0,0 +1,46 @@
# D3D12Screenshot::CopyToReadbackAndSave
## 函数签名
```cpp
static bool CopyToReadbackAndSave(ID3D12Device* device,
ID3D12CommandQueue* commandQueue,
ID3D12Resource* renderTarget,
const char* filename,
uint32_t width,
uint32_t height)
```
## 中文描述
复制渲染目标到回读缓冲区并保存为图片文件。
## 参数
| 参数 | 类型 | 描述 |
|------|------|------|
| `device` | `ID3D12Device*` | D3D12 设备指针 |
| `commandQueue` | `ID3D12CommandQueue*` | 命令队列指针 |
| `renderTarget` | `ID3D12Resource*` | 渲染目标资源 |
| `filename` | `const char*` | 保存文件名 |
| `width` | `uint32_t` | 宽度 |
| `height` | `uint32_t` | 高度 |
## 返回值
`bool` - 操作是否成功
## 复杂度
O(n) - 取决于纹理大小
## 示例
```cpp
D3D12Screenshot::CopyToReadbackAndSave(device, commandQueue, renderTarget, "screenshot.png", width, height);
```
## 相关文档
- [D3D12Screenshot](screenshot.md) - 类总览
- [D3D12Screenshot::Capture](capture.md) - 捕获截图

View File

@@ -0,0 +1,16 @@
# D3D12Screenshot
**命名空间**: `XCEngine::RHI`
**描述**: D3D12 截图工具类,提供屏幕截图捕获功能。**所有方法均为静态方法**。
## 公共方法
| 方法 | 描述 |
|------|------|
| [`Capture`](capture.md) | 捕获截图 |
| [`CopyToReadbackAndSave`](copy-to-readback-and-save.md) | 复制到回读缓冲并保存 |
## 相关文档
- [D3D12 后端总览](../../opengl/overview.md)