docs: update RHI API docs
This commit is contained in:
@@ -2,19 +2,37 @@
|
||||
|
||||
**命名空间**: `XCEngine::RHI`
|
||||
|
||||
**描述**: DirectX 12 查询堆的 D3D12 实现。
|
||||
**类型**: `class`
|
||||
|
||||
**描述**: DirectX 12 查询堆的 D3D12 实现,用于管理 GPU 查询操作。
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`Initialize`](../../../threading/task-system/initialize.md) | 初始化查询堆 |
|
||||
| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭查询堆 |
|
||||
| [`Initialize`](initialize.md) | 初始化查询堆 |
|
||||
| [`Shutdown`](shutdown.md) | 关闭查询堆 |
|
||||
| [`GetQueryHeap`](get-query-heap.md) | 获取 D3D12 查询堆 |
|
||||
| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 |
|
||||
| [`GetType`](../../command-queue/get-type.md) | 获取查询类型 |
|
||||
| [`GetNativeHandle`](get-native-handle.md) | 获取原生句柄 |
|
||||
| [`GetType`](get-type.md) | 获取查询类型 |
|
||||
| [`GetCount`](get-count.md) | 获取查询数量 |
|
||||
|
||||
## 使用示例
|
||||
|
||||
```cpp
|
||||
#include "XCEngine/RHI/D3D12/D3D12QueryHeap.h"
|
||||
|
||||
D3D12QueryHeap queryHeap;
|
||||
if (queryHeap.Initialize(device, QueryType::Timestamp, 1024)) {
|
||||
// 使用查询堆
|
||||
ID3D12QueryHeap* heap = queryHeap.GetQueryHeap();
|
||||
QueryType type = queryHeap.GetType();
|
||||
uint32_t count = queryHeap.GetCount();
|
||||
|
||||
queryHeap.Shutdown();
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12 后端总览](../../opengl/overview.md)
|
||||
- [D3D12 后端总览](../d3d12.md)
|
||||
|
||||
Reference in New Issue
Block a user