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:
36
docs/api/rhi/d3d12/render-target-view/create-desc.md
Normal file
36
docs/api/rhi/d3d12/render-target-view/create-desc.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# D3D12RenderTargetView::CreateDesc
|
||||
|
||||
## 函数签名
|
||||
|
||||
```cpp
|
||||
static D3D12_RENDER_TARGET_VIEW_DESC CreateDesc(Format format, D3D12_RTV_DIMENSION dimension = D3D12_RTV_DIMENSION_TEXTURE2D)
|
||||
```
|
||||
|
||||
## 中文描述
|
||||
|
||||
创建渲染目标视图描述符。
|
||||
|
||||
## 参数
|
||||
|
||||
| 参数 | 类型 | 描述 |
|
||||
|------|------|------|
|
||||
| `format` | `Format` | 资源格式 |
|
||||
| `dimension` | `D3D12_RTV_DIMENSION` | 视图维度(默认 TEXTURE2D) |
|
||||
|
||||
## 返回值
|
||||
|
||||
`D3D12_RENDER_TARGET_VIEW_DESC` - 渲染目标视图描述符
|
||||
|
||||
## 复杂度
|
||||
|
||||
O(1)
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
D3D12_RENDER_TARGET_VIEW_DESC desc = D3D12RenderTargetView::CreateDesc(Format::R8G8B8A8_UNorm);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12RenderTargetView](render-target-view.md) - 类总览
|
||||
@@ -0,0 +1,29 @@
|
||||
# D3D12RenderTargetView::GetCPUDescriptorHandle
|
||||
|
||||
## 函数签名
|
||||
|
||||
```cpp
|
||||
D3D12_CPU_DESCRIPTOR_HANDLE GetCPUDescriptorHandle() const
|
||||
```
|
||||
|
||||
## 中文描述
|
||||
|
||||
获取渲染目标视图的 CPU 描述符句柄。
|
||||
|
||||
## 返回值
|
||||
|
||||
`D3D12_CPU_DESCRIPTOR_HANDLE` - CPU 描述符句柄
|
||||
|
||||
## 复杂度
|
||||
|
||||
O(1)
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
D3D12_CPU_DESCRIPTOR_HANDLE handle = rtv->GetCPUDescriptorHandle();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12RenderTargetView](render-target-view.md) - 类总览
|
||||
40
docs/api/rhi/d3d12/render-target-view/initialize-at.md
Normal file
40
docs/api/rhi/d3d12/render-target-view/initialize-at.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# D3D12RenderTargetView::InitializeAt
|
||||
|
||||
## 函数签名
|
||||
|
||||
```cpp
|
||||
void InitializeAt(ID3D12Device* device, ID3D12Resource* resource, D3D12_CPU_DESCRIPTOR_HANDLE handle, const D3D12_RENDER_TARGET_VIEW_DESC* desc = nullptr)
|
||||
```
|
||||
|
||||
## 中文描述
|
||||
|
||||
在指定描述符句柄位置初始化渲染目标视图,用于外部描述符堆管理场景。
|
||||
|
||||
## 参数
|
||||
|
||||
| 参数 | 类型 | 描述 |
|
||||
|------|------|------|
|
||||
| `device` | `ID3D12Device*` | D3D12 设备指针 |
|
||||
| `resource` | `ID3D12Resource*` | 资源指针 |
|
||||
| `handle` | `D3D12_CPU_DESCRIPTOR_HANDLE` | 预分配的描述符句柄 |
|
||||
| `desc` | `D3D12_RENDER_TARGET_VIEW_DESC*` | 视图描述符(可选) |
|
||||
|
||||
## 返回值
|
||||
|
||||
无
|
||||
|
||||
## 复杂度
|
||||
|
||||
O(1)
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
D3D12_CPU_DESCRIPTOR_HANDLE handle = descriptorHeap->GetCPUDescriptorHandleForHeapStart();
|
||||
rtv->InitializeAt(device, resource, handle);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12RenderTargetView](render-target-view.md) - 类总览
|
||||
- [D3D12RenderTargetView::Initialize](../../../threading/task-system/initialize.md) - 标准初始化
|
||||
19
docs/api/rhi/d3d12/render-target-view/render-target-view.md
Normal file
19
docs/api/rhi/d3d12/render-target-view/render-target-view.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# D3D12RenderTargetView
|
||||
|
||||
**命名空间**: `XCEngine::RHI`
|
||||
|
||||
**描述**: DirectX 12 渲染目标视图的 D3D12 实现。
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`Initialize`](../../../threading/task-system/initialize.md) | 初始化渲染目标视图 |
|
||||
| [`InitializeAt`](initialize-at.md) | 在指定位置初始化 |
|
||||
| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭渲染目标视图 |
|
||||
| [`GetCPUDescriptorHandle`](get-cpu-descriptor-handle.md) | 获取 CPU 描述符句柄 |
|
||||
| [`CreateDesc`](create-desc.md) | 创建描述符(静态) |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12 后端总览](../../opengl/overview.md)
|
||||
Reference in New Issue
Block a user