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:
22
docs/api/rhi/descriptor-pool/descriptor-pool.md
Normal file
22
docs/api/rhi/descriptor-pool/descriptor-pool.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# RHIDescriptorPool
|
||||
|
||||
**命名空间**: `XCEngine::RHI`
|
||||
|
||||
**类型**: `class` (abstract)
|
||||
|
||||
**描述**: GPU 描述符堆池抽象接口,用于管理 GPU 描述符的分配和回收。
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`Initialize`](../../threading/task-system/initialize.md) | 初始化描述符池 |
|
||||
| [`Shutdown`](../../threading/task-system/shutdown.md) | 关闭并释放资源 |
|
||||
| [`GetNativeHandle`](../buffer/get-native-handle.md) | 获取原生句柄 |
|
||||
| [`GetDescriptorCount`](get-descriptor-count.md) | 获取描述符数量 |
|
||||
| [`GetType`](../command-queue/get-type.md) | 获取描述符类型 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [../rhi/rhi.md](../rhi.md) - RHI 模块总览
|
||||
- [RHIDevice](../device/device.md) - 创建设备
|
||||
19
docs/api/rhi/descriptor-pool/get-descriptor-count.md
Normal file
19
docs/api/rhi/descriptor-pool/get-descriptor-count.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# RHIDescriptorPool::GetDescriptorCount
|
||||
|
||||
```cpp
|
||||
virtual uint32_t GetDescriptorCount() const = 0;
|
||||
```
|
||||
|
||||
获取描述符数量。
|
||||
|
||||
**返回:** 描述符池中的描述符数量
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
uint32_t count = descriptorPool->GetDescriptorCount();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIDescriptorPool 总览](descriptor-pool.md) - 返回类总览
|
||||
41
docs/api/rhi/descriptor-pool/methods.md
Normal file
41
docs/api/rhi/descriptor-pool/methods.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# RHIDescriptorPool 方法
|
||||
|
||||
## Initialize
|
||||
|
||||
```cpp
|
||||
virtual bool Initialize(const DescriptorPoolDesc& desc) = 0;
|
||||
```
|
||||
|
||||
初始化描述符池。
|
||||
|
||||
## Shutdown
|
||||
|
||||
```cpp
|
||||
virtual void Shutdown() = 0;
|
||||
```
|
||||
|
||||
释放描述符池资源。
|
||||
|
||||
## GetNativeHandle
|
||||
|
||||
```cpp
|
||||
virtual void* GetNativeHandle() = 0;
|
||||
```
|
||||
|
||||
获取原生 API 句柄。
|
||||
|
||||
## GetDescriptorCount
|
||||
|
||||
```cpp
|
||||
virtual uint32_t GetDescriptorCount() const = 0;
|
||||
```
|
||||
|
||||
获取描述符数量。
|
||||
|
||||
## GetType
|
||||
|
||||
```cpp
|
||||
virtual DescriptorHeapType GetType() const = 0;
|
||||
```
|
||||
|
||||
获取堆类型。
|
||||
Reference in New Issue
Block a user