docs: update RHI API docs
This commit is contained in:
@@ -2,34 +2,55 @@
|
||||
|
||||
**命名空间**: `XCEngine::RHI`
|
||||
|
||||
**描述**: DirectX 12 设备实现,继承自 `RHIDevice`。
|
||||
**继承自**: `RHIDevice`
|
||||
|
||||
**描述**: DirectX 12 设备实现,用于管理 D3D12 图形适配器、创建资源和管理命令队列。
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`Initialize`](../../../threading/task-system/initialize.md) | 初始化设备 |
|
||||
| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭设备 |
|
||||
| [`CreateBuffer`](../../device/create-buffer.md) | 创建缓冲区 |
|
||||
| [`CreateTexture`](../../device/create-texture.md) | 创建纹理 |
|
||||
| [`CreateSwapChain`](../../device/create-swap-chain.md) | 创建交换链 |
|
||||
| [`CreateCommandList`](../../device/create-command-list.md) | 创建命令列表 |
|
||||
| [`CreateCommandQueue`](../../device/create-command-queue.md) | 创建命令队列 |
|
||||
| [`CompileShader`](../../device/compile-shader.md) | 编译着色器 |
|
||||
| [`CreatePipelineState`](../../device/create-pipeline-state.md) | 创建管线状态 |
|
||||
| [`CreateFence`](../../device/create-fence.md) | 创建栅栏 |
|
||||
| [`CreateSampler`](../../device/create-sampler.md) | 创建采样器 |
|
||||
| [`GetCapabilities`](../../device/get-capabilities.md) | 获取设备能力 |
|
||||
| [`GetDeviceInfo`](../../device/get-device-info.md) | 获取设备信息 |
|
||||
| [`GetNativeDevice`](../../device/get-native-device.md) | 获取原生设备 |
|
||||
| [`Initialize`](initialize.md) | 初始化 D3D12 设备 |
|
||||
| [`Shutdown`](shutdown.md) | 关闭设备 |
|
||||
| [`CreateBuffer`](create-buffer.md) | 创建缓冲区 |
|
||||
| [`CreateTexture`](create-texture.md) | 创建纹理 |
|
||||
| [`CreateSwapChain`](create-swap-chain.md) | 创建交换链 |
|
||||
| [`CreateCommandList`](create-command-list.md) | 创建命令列表 |
|
||||
| [`CreateCommandQueue`](create-command-queue.md) | 创建命令队列 |
|
||||
| [`CompileShader`](compile-shader.md) | 编译着色器 |
|
||||
| [`CreatePipelineState`](create-pipeline-state.md) | 创建管线状态 |
|
||||
| [`CreateFence`](create-fence.md) | 创建栅栏 |
|
||||
| [`CreateSampler`](create-sampler.md) | 创建采样器 |
|
||||
| [`GetCapabilities`](get-capabilities.md) | 获取设备能力 |
|
||||
| [`GetDeviceInfo`](get-device-info.md) | 获取设备信息 |
|
||||
| [`GetNativeDevice`](get-native-device.md) | 获取原生设备 |
|
||||
| [`GetNativeHandle`](get-native-handle.md) | 获取原生句柄 |
|
||||
| [`GetDevice`](get-device.md) | 获取 D3D12 设备 |
|
||||
| [`GetFactory`](get-factory.md) | 获取 D3D12 工厂 |
|
||||
| [`GetAdapterInfo`](get-adapter-info.md) | 获取适配器信息 |
|
||||
| [`EnumerateAdapters`](enumerate-adapters.md) | 枚举适配器 |
|
||||
| [`GetDescriptorHandleIncrementSize`](get-descriptor-handle-increment-size.md) | 获取描述符增量大小 |
|
||||
| [`CheckFeatureSupport`](check-feature-support.md) | 检查特性支持 |
|
||||
| [`SetDeviceRemoved`](set-device-removed.md) | 设置设备已移除 |
|
||||
| [`IsDeviceRemoved`](is-device-removed.md) | 查询设备是否已移除 |
|
||||
|
||||
## 使用示例
|
||||
|
||||
```cpp
|
||||
RHIDeviceDesc desc;
|
||||
desc.adapterIndex = 0;
|
||||
desc.enableDebugLayer = true;
|
||||
|
||||
D3D12Device* device = new D3D12Device();
|
||||
if (device->Initialize(desc)) {
|
||||
ID3D12Device* nativeDevice = device->GetDevice();
|
||||
// 使用设备...
|
||||
device->Shutdown();
|
||||
}
|
||||
delete device;
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12 后端总览](../../opengl/overview.md)
|
||||
- [D3D12 后端总览](../d3d12.md)
|
||||
- [RHIDevice](../../device/device.md) - 抽象设备接口
|
||||
|
||||
Reference in New Issue
Block a user