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:
20
docs/api/rhi/d3d12/descriptor-heap/create-desc.md
Normal file
20
docs/api/rhi/d3d12/descriptor-heap/create-desc.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# D3D12DescriptorHeap::CreateDesc
|
||||
|
||||
```cpp
|
||||
static D3D12_DESCRIPTOR_HEAP_DESC CreateDesc(DescriptorHeapType type, uint32_t numDescriptors, bool shaderVisible = false);
|
||||
```
|
||||
|
||||
创建描述符堆描述(静态方法)。
|
||||
|
||||
**参数:**
|
||||
- `type` - 描述符堆类型
|
||||
- `numDescriptors` - 描述符数量
|
||||
- `shaderVisible` - 是否对 Shader 可见
|
||||
|
||||
**返回:** D3D12 描述符堆描述
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12DescriptorHeap 总览](descriptor-heap.md) - 返回类总览
|
||||
27
docs/api/rhi/d3d12/descriptor-heap/descriptor-heap.md
Normal file
27
docs/api/rhi/d3d12/descriptor-heap/descriptor-heap.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# D3D12DescriptorHeap
|
||||
|
||||
**命名空间**: `XCEngine::RHI`
|
||||
|
||||
**描述**: DirectX 12 描述符堆的 D3D12 实现,继承自 `RHIDescriptorPool`。
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`Initialize`](initialize-from-desc.md) | 从描述符初始化 |
|
||||
| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭描述符堆 |
|
||||
| [`GetDescriptorHeap`](get-descriptor-heap.md) | 获取 D3D12 描述符堆 |
|
||||
| [`GetCPUDescriptorHandle`](get-cpu-descriptor-handle.md) | 获取 CPU 描述符句柄 |
|
||||
| [`GetGPUDescriptorHandle`](get-gpu-descriptor-handle.md) | 获取 GPU 描述符句柄 |
|
||||
| [`GetDescriptorCount`](get-descriptor-count.md) | 获取描述符数量 |
|
||||
| [`GetType`](../../command-queue/get-type.md) | 获取描述符类型 |
|
||||
| [`GetDescriptorSize`](get-descriptor-size.md) | 获取描述符大小 |
|
||||
| [`GetCPUDescriptorHandleForHeapStart`](get-cpu-descriptor-handle-for-heap-start.md) | 获取堆起始 CPU 句柄 |
|
||||
| [`GetGPUDescriptorHandleForHeapStart`](get-gpu-descriptor-handle-for-heap-start.md) | 获取堆起始 GPU 句柄 |
|
||||
| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 |
|
||||
| [`CreateDesc`](create-desc.md) | 创建描述符(静态) |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12 后端总览](../../opengl/overview.md)
|
||||
- [RHIDescriptorPool](../../descriptor-pool/descriptor-pool.md) - 抽象描述符池接口
|
||||
@@ -0,0 +1,15 @@
|
||||
# D3D12DescriptorHeap::GetCPUDescriptorHandleForHeapStart
|
||||
|
||||
```cpp
|
||||
D3D12_CPU_DESCRIPTOR_HANDLE GetCPUDescriptorHandleForHeapStart() const;
|
||||
```
|
||||
|
||||
获取堆起始处的 CPU 描述符句柄。
|
||||
|
||||
**返回:** CPU 描述符句柄
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12DescriptorHeap 总览](descriptor-heap.md) - 返回类总览
|
||||
@@ -0,0 +1,18 @@
|
||||
# D3D12DescriptorHeap::GetCPUDescriptorHandle
|
||||
|
||||
```cpp
|
||||
CPUDescriptorHandle GetCPUDescriptorHandle(uint32_t index);
|
||||
```
|
||||
|
||||
获取 CPU 描述符句柄。
|
||||
|
||||
**参数:**
|
||||
- `index` - 描述符索引
|
||||
|
||||
**返回:** CPU 描述符句柄
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12DescriptorHeap 总览](descriptor-heap.md) - 返回类总览
|
||||
15
docs/api/rhi/d3d12/descriptor-heap/get-descriptor-count.md
Normal file
15
docs/api/rhi/d3d12/descriptor-heap/get-descriptor-count.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# D3D12DescriptorHeap::GetDescriptorCount
|
||||
|
||||
```cpp
|
||||
uint32_t GetDescriptorCount() const override;
|
||||
```
|
||||
|
||||
获取描述符数量。
|
||||
|
||||
**返回:** 描述符数量
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12DescriptorHeap 总览](descriptor-heap.md) - 返回类总览
|
||||
15
docs/api/rhi/d3d12/descriptor-heap/get-descriptor-heap.md
Normal file
15
docs/api/rhi/d3d12/descriptor-heap/get-descriptor-heap.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# D3D12DescriptorHeap::GetDescriptorHeap
|
||||
|
||||
```cpp
|
||||
ID3D12DescriptorHeap* GetDescriptorHeap() const { return m_descriptorHeap.Get(); }
|
||||
```
|
||||
|
||||
获取底层 D3D12 描述符堆接口。
|
||||
|
||||
**返回:** `ID3D12DescriptorHeap*`
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12DescriptorHeap 总览](descriptor-heap.md) - 返回类总览
|
||||
15
docs/api/rhi/d3d12/descriptor-heap/get-descriptor-size.md
Normal file
15
docs/api/rhi/d3d12/descriptor-heap/get-descriptor-size.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# D3D12DescriptorHeap::GetDescriptorSize
|
||||
|
||||
```cpp
|
||||
uint32_t GetDescriptorSize() const { return m_descriptorSize; }
|
||||
```
|
||||
|
||||
获取描述符大小。
|
||||
|
||||
**返回:** 描述符大小(字节)
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12DescriptorHeap 总览](descriptor-heap.md) - 返回类总览
|
||||
@@ -0,0 +1,15 @@
|
||||
# D3D12DescriptorHeap::GetGPUDescriptorHandleForHeapStart
|
||||
|
||||
```cpp
|
||||
D3D12_GPU_DESCRIPTOR_HANDLE GetGPUDescriptorHandleForHeapStart() const;
|
||||
```
|
||||
|
||||
获取堆起始处的 GPU 描述符句柄。
|
||||
|
||||
**返回:** GPU 描述符句柄
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12DescriptorHeap 总览](descriptor-heap.md) - 返回类总览
|
||||
@@ -0,0 +1,18 @@
|
||||
# D3D12DescriptorHeap::GetGPUDescriptorHandle
|
||||
|
||||
```cpp
|
||||
GPUDescriptorHandle GetGPUDescriptorHandle(uint32_t index);
|
||||
```
|
||||
|
||||
获取 GPU 描述符句柄。
|
||||
|
||||
**参数:**
|
||||
- `index` - 描述符索引
|
||||
|
||||
**返回:** GPU 描述符句柄
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12DescriptorHeap 总览](descriptor-heap.md) - 返回类总览
|
||||
18
docs/api/rhi/d3d12/descriptor-heap/initialize-from-desc.md
Normal file
18
docs/api/rhi/d3d12/descriptor-heap/initialize-from-desc.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# D3D12DescriptorHeap::InitializeFromDesc
|
||||
|
||||
```cpp
|
||||
bool Initialize(const DescriptorPoolDesc& desc) override;
|
||||
```
|
||||
|
||||
从描述符初始化。
|
||||
|
||||
**参数:**
|
||||
- `desc` - 描述符池描述
|
||||
|
||||
**返回:** 是否初始化成功
|
||||
|
||||
**复杂度:** O(n)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12DescriptorHeap 总览](descriptor-heap.md) - 返回类总览
|
||||
Reference in New Issue
Block a user