docs: Fix SKILL.md规范 violations - Remove ## 方法列表 and flatten ### sub-headers in ## 公共方法

This commit is contained in:
2026-03-19 02:01:18 +08:00
parent 8e85fd98b8
commit 5257f3d75c
68 changed files with 718 additions and 1289 deletions

View File

@@ -1,36 +0,0 @@
# D3D12 后端组件
D3D12 后端已创建以下组件文件夹和文档:
- `device/` - D3D12Device
- `buffer/` - D3D12Buffer
- `texture/` - D3D12Texture
- `command-list/` - D3D12CommandList
- `command-queue/` - D3D12CommandQueue
- `swap-chain/` - D3D12SwapChain
- `fence/` - D3D12Fence
- `shader/` - D3D12Shader
- `pipeline-state/` - D3D12PipelineState
- `sampler/` - D3D12Sampler
- `root-signature/` - D3D12RootSignature
- `descriptor-heap/` - D3D12DescriptorHeap
- `render-target-view/` - D3D12RenderTargetView
- `depth-stencil-view/` - D3D12DepthStencilView
- `shader-resource-view/` - D3D12ShaderResourceView
- `unordered-access-view/` - D3D12UnorderedAccessView
- `constant-buffer-view/` - D3D12ConstantBufferView
- `command-allocator/` - D3D12CommandAllocator
- `query-heap/` - D3D12QueryHeap
- `screenshot/` - D3D12Screenshot
- `types/` - D3D12 类型转换
- `enums/` - D3D12 枚举转换
- `common/` - D3D12 公共工具
每个组件文件夹包含:
- `{component}.md` - 类总览
- `methods.md` - 方法详细文档
## 相关文档
- [D3D12 后端总览](overview.md)
- [RHI 抽象层](overview.md)

View File

@@ -4,30 +4,34 @@
**描述**: DirectX 12 缓冲区的 D3D12 实现,继承自 `RHIBuffer`
## 方法列表
## 公共方法
| 方法 | 文档 |
| 方法 | 描述 |
|------|------|
| `Initialize` | [详细文档](initialize.md) |
| `InitializeFromExisting` | [详细文档](initialize-from-existing.md) |
| `InitializeWithData` | [详细文档](initialize-with-data.md) |
| `Shutdown` | [详细文档](shutdown.md) |
| `UpdateData` | [详细文档](update-data.md) |
| `Map` | [详细文档](map.md) |
| `Unmap` | [详细文档](unmap.md) |
| `SetData` | [详细文档](set-data.md) |
| `GetResource` | [详细文档](get-resource.md) |
| `GetDesc` | [详细文档](get-desc.md) |
| `GetGPUVirtualAddress` | [详细文档](get-gpu-virtual-address.md) |
| `GetGPUAddress` | [详细文档](get-gpu-address.md) |
| `GetSize` | [详细文档](get-size.md) |
| `GetState` / `SetState` | [详细文档](get-state.md) |
| `GetName` / `SetName` | [详细文档](get-name.md) |
| `GetStride` / `SetStride` | [详细文档](get-stride.md) |
| `GetBufferType` / `SetBufferType` | [详细文档](get-buffer-type.md) |
| `GetNativeHandle` | [详细文档](get-native-handle.md) |
| [`Initialize`](initialize.md) | 初始化缓冲区 |
| [`InitializeFromExisting`](initialize-from-existing.md) | 从现有资源初始化 |
| [`InitializeWithData`](initialize-with-data.md) | 初始化并写入数据 |
| [`Shutdown`](shutdown.md) | 关闭缓冲区 |
| [`UpdateData`](update-data.md) | 更新数据 |
| [`Map`](map.md) | 映射缓冲区 |
| [`Unmap`](unmap.md) | 取消映射 |
| [`SetData`](set-data.md) | 设置数据 |
| [`GetResource`](get-resource.md) | 获取 D3D12 资源 |
| [`GetDesc`](get-desc.md) | 获取描述符 |
| [`GetGPUVirtualAddress`](get-gpu-virtual-address.md) | 获取 GPU 虚拟地址 |
| [`GetGPUAddress`](get-gpu-address.md) | 获取 GPU 地址 |
| [`GetSize`](get-size.md) | 获取缓冲区大小 |
| [`GetState`](get-state.md) | 获取资源状态 |
| [`SetState`](../../buffer/set-state.md) | 设置资源状态 |
| [`GetName`](get-name.md) | 获取资源名称 |
| [`SetName`](../../buffer/set-name.md) | 设置资源名称 |
| [`GetStride`](get-stride.md) | 获取步长 |
| [`SetStride`](../../buffer/set-stride.md) | 设置步长 |
| [`GetBufferType`](get-buffer-type.md) | 获取缓冲区类型 |
| [`SetBufferType`](../../buffer/set-buffer-type.md) | 设置缓冲区类型 |
| [`GetNativeHandle`](get-native-handle.md) | 获取原生句柄 |
## 相关文档
- [D3D12 后端总览](../overview.md)
- [D3D12 后端总览](../../opengl/overview.md)
- [RHIBuffer](../../buffer/buffer.md) - 抽象缓冲区接口

View File

@@ -4,16 +4,16 @@
**描述**: DirectX 12 命令分配器的 D3D12 实现。
## 方法列表
## 公共方法
| 方法 | 文档 |
| 方法 | 描述 |
|------|------|
| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) |
| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) |
| `Reset` | [详细文档](../../../resources/resourcehandle/reset.md) |
| `IsReady` | [详细文档](is-ready.md) |
| `GetCommandAllocator` | [详细文档](get-command-allocator.md) |
| [`Initialize`](../../../threading/task-system/initialize.md) | 初始化命令分配器 |
| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭命令分配器 |
| [`Reset`](../../command-list/reset.md) | 重置命令分配器 |
| [`IsReady`](is-ready.md) | 检查是否就绪 |
| [`GetCommandAllocator`](get-command-allocator.md) | 获取 D3D12 命令分配器 |
## 相关文档
- [D3D12 后端总览](../overview.md)
- [D3D12 后端总览](../../opengl/overview.md)

View File

@@ -4,139 +4,62 @@
**描述**: DirectX 12 命令列表的 D3D12 实现,继承自 `RHICommandList`
## 方法列表
## 公共方法
### 生命周期
| 方法 | 文档 |
| 方法 | 描述 |
|------|------|
| `Shutdown` | [详细文档](../../command-list/shutdown.md) |
| `Reset` | [详细文档](../../command-list/reset.md) |
| `Close` | [详细文档](../../command-list/close.md) |
| `GetCommandList` | [详细文档](get-command-list.md) |
### 资源屏障
| 方法 | 文档 |
|------|------|
| `TransitionBarrier` | [详细文档](transition-barrier.md) |
| `TransitionBarrierInternal` | [详细文档](transition-barrier-internal.md) |
| `UAVBarrier` | [详细文档](uav-barrier.md) |
| `AliasBarrier` | [详细文档](alias-barrier.md) |
### 管线状态
| 方法 | 文档 |
|------|------|
| `SetPipelineState` | [详细文档](set-pipeline-state.md) |
| `SetRootSignature` | [详细文档](set-root-signature.md) |
| `SetPrimitiveTopology` | [详细文档](set-primitive-topology.md) |
### 视口与裁剪
| 方法 | 文档 |
|------|------|
| `SetViewport` | [详细文档](set-viewport.md) |
| `SetViewports` | [详细文档](set-viewports.md) |
| `SetScissorRect` | [详细文档](set-scissor-rect.md) |
| `SetScissorRects` | [详细文档](set-scissor-rects.md) |
### 渲染目标
| 方法 | 文档 |
|------|------|
| `SetRenderTargets` | [详细文档](set-render-targets.md) |
| `SetRenderTargetsInternal` | [详细文档](set-render-targets-internal.md) |
| `SetRenderTargetsHandle` | [详细文档](set-render-targets-handle.md) |
### 顶点/索引缓冲区
| 方法 | 文档 |
|------|------|
| `SetVertexBuffer` | [详细文档](set-vertex-buffer.md) |
| `SetVertexBuffers` | [详细文档](set-vertex-buffers.md) |
| `SetIndexBuffer` | [详细文档](set-index-buffer.md) |
### 描述符
| 方法 | 文档 |
|------|------|
| `SetDescriptorHeap` | [详细文档](set-descriptor-heap.md) |
| `SetDescriptorHeaps` | [详细文档](set-descriptor-heaps.md) |
| `SetGraphicsDescriptorTable` | [详细文档](set-graphics-descriptor-table.md) |
| `SetComputeDescriptorTable` | [详细文档](set-compute-descriptor-table.md) |
### 根参数绑定
| 方法 | 文档 |
|------|------|
| `SetGraphicsRootConstantBufferView` | [详细文档](set-graphics-root-constant-buffer-view.md) |
| `SetGraphicsRoot32BitConstants` | [详细文档](set-graphics-root-32bit-constants.md) |
| `SetGraphicsRootDescriptorTable` | [详细文档](set-graphics-root-descriptor-table.md) |
| `SetGraphicsRootShaderResourceView` | [详细文档](set-graphics-root-shader-resource-view.md) |
### 渲染状态
| 方法 | 文档 |
|------|------|
| `SetStencilRef` | [详细文档](set-stencil-ref.md) |
| `SetBlendFactor` | [详细文档](set-blend-factor.md) |
| `SetDepthBias` | [详细文档](set-depth-bias.md) |
### 绘制
| 方法 | 文档 |
|------|------|
| `Draw` | [详细文档](draw.md) |
| `DrawIndexed` | [详细文档](draw-indexed.md) |
| `DrawInstancedIndirect` | [详细文档](draw-instanced-indirect.md) |
| `DrawIndexedInstancedIndirect` | [详细文档](draw-indexed-instanced-indirect.md) |
### 清除
| 方法 | 文档 |
|------|------|
| `Clear` | [详细文档](../../command-list/clear.md) |
| `ClearRenderTarget` | [详细文档](clear-render-target.md) |
| `ClearDepthStencil` | [详细文档](clear-depth-stencil.md) |
### 复制
| 方法 | 文档 |
|------|------|
| `CopyResource` | [详细文档](copy-resource.md) |
| `CopyBuffer` | [详细文档](copy-buffer.md) |
| `CopyTexture` | [详细文档](copy-texture.md) |
### 查询
| 方法 | 文档 |
|------|------|
| `BeginQuery` | [详细文档](begin-query.md) |
| `EndQuery` | [详细文档](end-query.md) |
| `ResolveQueryData` | [详细文档](resolve-query-data.md) |
### 计算
| 方法 | 文档 |
|------|------|
| `Dispatch` | [详细文档](dispatch.md) |
| `DispatchIndirect` | [详细文档](dispatch-indirect.md) |
### Bundle
| 方法 | 文档 |
|------|------|
| `ExecuteBundle` | [详细文档](execute-bundle.md) |
### 状态管理
| 方法 | 文档 |
|------|------|
| `GetResourceState` | [详细文档](get-resource-state.md) |
| `TrackResource` | [详细文档](track-resource.md) |
| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭命令列表 |
| [`Reset`](../../command-list/reset.md) | 重置命令列表 |
| [`Close`](../../command-list/close.md) | 关闭命令列表 |
| [`GetCommandList`](get-command-list.md) | 获取 D3D12 命令列表 |
| [`TransitionBarrier`](transition-barrier.md) | 资源状态转换 |
| [`TransitionBarrierInternal`](transition-barrier-internal.md) | 内部资源状态转换 |
| [`UAVBarrier`](uav-barrier.md) | UAV 屏障 |
| [`AliasBarrier`](alias-barrier.md) | 别名屏障 |
| [`SetPipelineState`](set-pipeline-state.md) | 设置管线状态 |
| [`SetRootSignature`](set-root-signature.md) | 设置根签名 |
| [`SetPrimitiveTopology`](set-primitive-topology.md) | 设置图元拓扑 |
| [`SetViewport`](set-viewport.md) | 设置视口 |
| [`SetViewports`](set-viewports.md) | 设置多个视口 |
| [`SetScissorRect`](set-scissor-rect.md) | 设置裁剪矩形 |
| [`SetScissorRects`](set-scissor-rects.md) | 设置多个裁剪矩形 |
| [`SetRenderTargets`](set-render-targets.md) | 设置渲染目标 |
| [`SetRenderTargetsInternal`](set-render-targets-internal.md) | 内部渲染目标设置 |
| [`SetRenderTargetsHandle`](set-render-targets-handle.md) | 句柄渲染目标设置 |
| [`SetVertexBuffer`](set-vertex-buffer.md) | 设置顶点缓冲 |
| [`SetVertexBuffers`](set-vertex-buffers.md) | 设置多个顶点缓冲 |
| [`SetIndexBuffer`](set-index-buffer.md) | 设置索引缓冲 |
| [`SetDescriptorHeap`](set-descriptor-heap.md) | 设置描述符堆 |
| [`SetDescriptorHeaps`](set-descriptor-heaps.md) | 设置多个描述符堆 |
| [`SetGraphicsDescriptorTable`](set-graphics-descriptor-table.md) | 设置图形描述符表 |
| [`SetComputeDescriptorTable`](set-compute-descriptor-table.md) | 设置计算描述符表 |
| [`SetGraphicsRootConstantBufferView`](set-graphics-root-constant-buffer-view.md) | 设置图形根常量缓冲视图 |
| [`SetGraphicsRoot32BitConstants`](set-graphics-root-32bit-constants.md) | 设置图形根 32 位常量 |
| [`SetGraphicsRootDescriptorTable`](set-graphics-root-descriptor-table.md) | 设置图形根描述符表 |
| [`SetGraphicsRootShaderResourceView`](set-graphics-root-shader-resource-view.md) | 设置图形根着色器资源视图 |
| [`SetStencilRef`](set-stencil-ref.md) | 设置模板引用值 |
| [`SetBlendFactor`](set-blend-factor.md) | 设置混合因子 |
| [`SetDepthBias`](set-depth-bias.md) | 设置深度偏移 |
| [`Draw`](draw.md) | 绘制 |
| [`DrawIndexed`](draw-indexed.md) | 索引绘制 |
| [`DrawInstancedIndirect`](draw-instanced-indirect.md) | 实例化间接绘制 |
| [`DrawIndexedInstancedIndirect`](draw-indexed-instanced-indirect.md) | 索引实例化间接绘制 |
| [`Clear`](../../command-list/clear.md) | 清除 |
| [`ClearRenderTarget`](clear-render-target.md) | 清除渲染目标 |
| [`ClearDepthStencil`](clear-depth-stencil.md) | 清除深度模板 |
| [`CopyResource`](copy-resource.md) | 复制资源 |
| [`CopyBuffer`](copy-buffer.md) | 复制缓冲区 |
| [`CopyTexture`](copy-texture.md) | 复制纹理 |
| [`BeginQuery`](begin-query.md) | 开始查询 |
| [`EndQuery`](end-query.md) | 结束查询 |
| [`ResolveQueryData`](resolve-query-data.md) | 解析查询数据 |
| [`Dispatch`](dispatch.md) | 分发计算任务 |
| [`DispatchIndirect`](dispatch-indirect.md) | 间接分发计算任务 |
| [`ExecuteBundle`](execute-bundle.md) | 执行 Bundle |
| [`GetResourceState`](get-resource-state.md) | 获取资源状态 |
| [`TrackResource`](track-resource.md) | 跟踪资源 |
## 相关文档
- [D3D12 后端总览](../overview.md)
- [D3D12 后端总览](../../opengl/overview.md)
- [RHICommandList](../../command-list/command-list.md) - 抽象命令列表接口

View File

@@ -4,23 +4,23 @@
**描述**: DirectX 12 命令队列的 D3D12 实现,继承自 `RHICommandQueue`
## 方法列表
## 公共方法
| 方法 | 文档 |
| 方法 | 描述 |
|------|------|
| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) |
| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) |
| `ExecuteCommandLists` | [详细文档](execute-command-lists.md) |
| `Signal` | [详细文档](signal.md) |
| `Wait` | [详细文档](../../../threading/task-group/wait.md) |
| `GetCompletedValue` | [详细文档](get-completed-value.md) |
| `WaitForIdle` | [详细文档](wait-for-idle.md) |
| `GetType` | [详细文档](../../shader/get-type.md) |
| `GetTimestampFrequency` | [详细文档](get-timestamp-frequency.md) |
| `GetCommandQueue` | [详细文档](get-command-queue.md) |
| `GetNativeHandle` | [详细文档](../../buffer/get-native-handle.md) |
| [`Initialize`](../../../threading/task-system/initialize.md) | 初始化命令队列 |
| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭命令队列 |
| [`ExecuteCommandLists`](execute-command-lists.md) | 执行命令列表 |
| [`Signal`](signal.md) | 信号栅栏 |
| [`Wait`](../../../threading/task-group/wait.md) | 等待栅栏 |
| [`GetCompletedValue`](get-completed-value.md) | 获取完成值 |
| [`WaitForIdle`](wait-for-idle.md) | 等待空闲 |
| [`GetType`](../../command-queue/get-type.md) | 获取队列类型 |
| [`GetTimestampFrequency`](get-timestamp-frequency.md) | 获取时间戳频率 |
| [`GetCommandQueue`](get-command-queue.md) | 获取 D3D12 命令队列 |
| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 |
## 相关文档
- [D3D12 后端总览](../overview.md)
- [D3D12 后端总览](../../opengl/overview.md)
- [RHICommandQueue](../../command-queue/command-queue.md) - 抽象命令队列接口

View File

@@ -64,4 +64,4 @@
## 相关文档
- [D3D12 后端总览](../overview.md)
- [D3D12 后端总览](../../opengl/overview.md)

View File

@@ -4,14 +4,14 @@
**描述**: DirectX 12 常量缓冲区视图的 D3D12 实现。
## 方法列表
## 公共方法
| 方法 | 文档 |
| 方法 | 描述 |
|------|------|
| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) |
| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) |
| `GetCPUDescriptorHandle` | [详细文档](get-cpu-descriptor-handle.md) |
| [`Initialize`](../../../threading/task-system/initialize.md) | 初始化常量缓冲区视图 |
| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭常量缓冲区视图 |
| [`GetCPUDescriptorHandle`](get-cpu-descriptor-handle.md) | 获取 CPU 描述符句柄 |
## 相关文档
- [D3D12 后端总览](../overview.md)
- [D3D12 后端总览](../../opengl/overview.md)

View File

@@ -4,16 +4,16 @@
**描述**: 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) |
| `CreateDesc` (static) | [详细文档](create-desc.md) |
| [`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 后端总览](../overview.md)
- [D3D12 后端总览](../../opengl/overview.md)

View File

@@ -4,25 +4,24 @@
**描述**: DirectX 12 描述符堆的 D3D12 实现,继承自 `RHIDescriptorPool`
## 方法列表
## 公共方法
| 方法 | 文档 |
| 方法 | 描述 |
|------|------|
| `Initialize` (params) | [详细文档](../../../threading/task-system/initialize.md) |
| `Initialize` (desc) | [详细文档](initialize-from-desc.md) |
| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) |
| `GetDescriptorHeap` | [详细文档](get-descriptor-heap.md) |
| `GetCPUDescriptorHandle` | [详细文档](get-cpu-descriptor-handle.md) |
| `GetGPUDescriptorHandle` | [详细文档](get-gpu-descriptor-handle.md) |
| `GetDescriptorCount` | [详细文档](get-descriptor-count.md) |
| `GetType` | [详细文档](../../shader/get-type.md) |
| `GetDescriptorSize` | [详细文档](get-descriptor-size.md) |
| `GetCPUDescriptorHandleForHeapStart` | [详细文档](get-cpu-descriptor-handle-for-heap-start.md) |
| `GetGPUDescriptorHandleForHeapStart` | [详细文档](get-gpu-descriptor-handle-for-heap-start.md) |
| `GetNativeHandle` | [详细文档](../../buffer/get-native-handle.md) |
| `CreateDesc` (static) | [详细文档](create-desc.md) |
| [`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 后端总览](../overview.md)
- [D3D12 后端总览](../../opengl/overview.md)
- [RHIDescriptorPool](../../descriptor-pool/descriptor-pool.md) - 抽象描述符池接口

View File

@@ -6,37 +6,30 @@
## 公共方法
### 继承方法
| 方法 | 文档 |
| 方法 | 描述 |
|------|------|
| `Initialize` | [详细文档](../../device/initialize.md) |
| `Shutdown` | [详细文档](../../device/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) |
### D3D12 特有方法
| 方法 | 文档 |
|------|------|
| `GetDevice` | [详细文档](get-device.md) |
| `GetFactory` | [详细文档](get-factory.md) |
| `GetAdapterInfo` | [详细文档](get-adapter-info.md) |
| `EnumerateAdapters` | [详细文档](enumerate-adapters.md) |
| `GetDescriptorHandleIncrementSize` | [详细文档](get-descriptor-handle-increment-size.md) |
| `CheckFeatureSupport` | [详细文档](check-feature-support.md) |
| [`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) | 获取原生设备 |
| [`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) | 检查特性支持 |
## 相关文档
- [D3D12 后端总览](../overview.md)
- [D3D12 后端总览](../../opengl/overview.md)
- [RHIDevice](../../device/device.md) - 抽象设备接口

View File

@@ -33,5 +33,5 @@
## 相关文档
- [D3D12 后端总览](../overview.md)
- [D3D12 后端总览](../../opengl/overview.md)
- [D3D12Types](../../types/types.md) - 类型转换

View File

@@ -4,21 +4,21 @@
**描述**: DirectX 12 栅栏同步对象的 D3D12 实现,继承自 `RHIFence`
## 方法列表
## 公共方法
| 方法 | 文档 |
| 方法 | 描述 |
|------|------|
| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) |
| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) |
| `Signal` | [详细文档](signal.md) |
| `Wait` | [详细文档](../../../threading/task-group/wait.md) |
| `GetCompletedValue` | [详细文档](get-completed-value.md) |
| `IsSignaled` | [详细文档](is-signaled.md) |
| `GetEventHandle` | [详细文档](get-event-handle.md) |
| `GetNativeHandle` | [详细文档](../../buffer/get-native-handle.md) |
| `GetFence` | [详细文档](get-fence.md) |
| [`Initialize`](../../../threading/task-system/initialize.md) | 初始化栅栏 |
| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭栅栏 |
| [`Signal`](signal.md) | 信号栅栏 |
| [`Wait`](../../../threading/task-group/wait.md) | 等待栅栏 |
| [`GetCompletedValue`](get-completed-value.md) | 获取完成值 |
| [`IsSignaled`](is-signaled.md) | 检查是否已信号 |
| [`GetEventHandle`](get-event-handle.md) | 获取事件句柄 |
| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 |
| [`GetFence`](get-fence.md) | 获取 D3D12 栅栏 |
## 相关文档
- [D3D12 后端总览](../overview.md)
- [D3D12 后端总览](../../opengl/overview.md)
- [RHIFence](../../fence/fence.md) - 抽象栅栏接口

View File

@@ -4,21 +4,21 @@
**描述**: DirectX 12 管线状态对象的 D3D12 实现,继承自 `RHIPipelineState`
## 方法列表
## 公共方法
| 方法 | 文档 |
| 方法 | 描述 |
|------|------|
| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) |
| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) |
| `GetPipelineState` | [详细文档](get-pipeline-state.md) |
| `GetNativeHandle` | [详细文档](../../buffer/get-native-handle.md) |
| `GetType` | [详细文档](../../shader/get-type.md) |
| `Bind` | [详细文档](../../shader/bind.md) |
| `Unbind` | [详细文档](../../shader/unbind.md) |
| `CreateDesc` (static) | [详细文档](create-desc.md) |
| `CreateInputElement` (static) | [详细文档](create-input-element.md) |
| [`Initialize`](../../../threading/task-system/initialize.md) | 初始化管线状态 |
| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭管线状态 |
| [`GetPipelineState`](get-pipeline-state.md) | 获取 D3D12 管线状态对象 |
| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 |
| [`GetType`](../../command-queue/get-type.md) | 获取管线类型 |
| [`Bind`](../../shader/bind.md) | 绑定管线状态 |
| [`Unbind`](../../shader/unbind.md) | 解绑管线状态 |
| [`CreateDesc`](create-desc.md) | 创建管线状态描述符(静态) |
| [`CreateInputElement`](create-input-element.md) | 创建输入元素描述符(静态) |
## 相关文档
- [D3D12 后端总览](../overview.md)
- [D3D12 后端总览](../../opengl/overview.md)
- [RHIPipelineState](../../pipeline-state/pipeline-state.md) - 抽象管线状态接口

View File

@@ -4,17 +4,17 @@
**描述**: DirectX 12 查询堆的 D3D12 实现。
## 方法列表
## 公共方法
| 方法 | 文档 |
| 方法 | 描述 |
|------|------|
| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) |
| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) |
| `GetQueryHeap` | [详细文档](get-query-heap.md) |
| `GetNativeHandle` | [详细文档](../../buffer/get-native-handle.md) |
| `GetType` | [详细文档](../../shader/get-type.md) |
| `GetCount` | [详细文档](get-count.md) |
| [`Initialize`](../../../threading/task-system/initialize.md) | 初始化查询堆 |
| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭查询堆 |
| [`GetQueryHeap`](get-query-heap.md) | 获取 D3D12 查询堆 |
| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 |
| [`GetType`](../../command-queue/get-type.md) | 获取查询类型 |
| [`GetCount`](get-count.md) | 获取查询数量 |
## 相关文档
- [D3D12 后端总览](../overview.md)
- [D3D12 后端总览](../../opengl/overview.md)

View File

@@ -4,16 +4,16 @@
**描述**: 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) |
| `CreateDesc` (static) | [详细文档](create-desc.md) |
| [`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 后端总览](../overview.md)
- [D3D12 后端总览](../../opengl/overview.md)

View File

@@ -4,25 +4,25 @@
**描述**: DirectX 12 根签名的 D3D12 实现。**不继承 RHI 抽象接口**,是 D3D12 特有的封装类。
## 方法列表
## 公共方法
| 方法 | 文档 |
| 方法 | 描述 |
|------|------|
| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) |
| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) |
| `GetRootSignature` | [详细文档](get-root-signature.md) |
| `GetNativeHandle` | [详细文档](../../buffer/get-native-handle.md) |
| `GetParameterCount` | [详细文档](get-parameter-count.md) |
| `CreateDesc` (static) | [详细文档](create-desc.md) |
| `CreateCBV` (static) | [详细文档](create-cbv.md) |
| `CreateSRV` (static) | [详细文档](create-srv.md) |
| `CreateUAV` (static) | [详细文档](create-uav.md) |
| `Create32BitConstants` (static) | [详细文档](create-32bit-constants.md) |
| `CreateDescriptorTable` (static) | [详细文档](create-descriptor-table.md) |
| `CreateStaticSampler` (static) | [详细文档](create-static-sampler.md) |
| `CreateSamplerDesc` (static) | [详细文档](create-sampler-desc.md) |
| `CreateDescriptorRange` (static) | [详细文档](create-descriptor-range.md) |
| [`Initialize`](../../../threading/task-system/initialize.md) | 初始化根签名 |
| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭根签名 |
| [`GetRootSignature`](get-root-signature.md) | 获取 D3D12 根签名 |
| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 |
| [`GetParameterCount`](get-parameter-count.md) | 获取参数数量 |
| [`CreateDesc`](create-desc.md) | 创建根签名描述符(静态) |
| [`CreateCBV`](create-cbv.md) | 创建常量缓冲区视图(静态) |
| [`CreateSRV`](create-srv.md) | 创建着色器资源视图(静态) |
| [`CreateUAV`](create-uav.md) | 创建无序访问视图(静态) |
| [`Create32BitConstants`](create-32bit-constants.md) | 创建 32 位常量(静态) |
| [`CreateDescriptorTable`](create-descriptor-table.md) | 创建描述符表(静态) |
| [`CreateStaticSampler`](create-static-sampler.md) | 创建静态采样器(静态) |
| [`CreateSamplerDesc`](create-sampler-desc.md) | 创建采样器描述符(静态) |
| [`CreateDescriptorRange`](create-descriptor-range.md) | 创建描述符范围(静态) |
## 相关文档
- [D3D12 后端总览](../overview.md)
- [D3D12 后端总览](../../opengl/overview.md)

View File

@@ -4,18 +4,19 @@
**描述**: DirectX 12 采样器的 D3D12 实现,继承自 `RHISampler`
## 方法列表
## 公共方法
| 方法 | 文档 |
| 方法 | 描述 |
|------|------|
| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) |
| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) |
| `GetDesc` | [详细文档](../buffer/get-desc.md) |
| `GetNativeHandle` | [详细文档](../../buffer/get-native-handle.md) |
| `GetID` | [详细文档](get-id.md) |
| `Bind` / `Unbind` | [详细文档](../../shader/bind.md) |
| [`Initialize`](../../../threading/task-system/initialize.md) | 初始化采样器 |
| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭采样器 |
| [`GetDesc`](../buffer/get-desc.md) | 获取采样器描述符 |
| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 |
| [`GetID`](get-id.md) | 获取采样器 ID |
| [`Bind`](../../shader/bind.md) | 绑定采样器 |
| [`Unbind`](../../shader/unbind.md) | 解绑采样器 |
## 相关文档
- [D3D12 后端总览](../overview.md)
- [D3D12 后端总览](../../opengl/overview.md)
- [RHISampler](../../sampler/sampler.md) - 抽象采样器接口

View File

@@ -4,13 +4,13 @@
**描述**: D3D12 截图工具类,提供屏幕截图捕获功能。**所有方法均为静态方法**。
## 方法列表
## 公共方法
| 方法 | 文档 |
| 方法 | 描述 |
|------|------|
| `Capture` | [详细文档](capture.md) |
| `CopyToReadbackAndSave` | [详细文档](copy-to-readback-and-save.md) |
| [`Capture`](capture.md) | 捕获截图 |
| [`CopyToReadbackAndSave`](copy-to-readback-and-save.md) | 复制到回读缓冲并保存 |
## 相关文档
- [D3D12 后端总览](../overview.md)
- [D3D12 后端总览](../../opengl/overview.md)

View File

@@ -4,16 +4,16 @@
**描述**: 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) |
| `CreateDesc` (static) | [详细文档](create-desc.md) |
| [`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 后端总览](../overview.md)
- [D3D12 后端总览](../../opengl/overview.md)

View File

@@ -4,24 +4,25 @@
**描述**: DirectX 12 着色器的 D3D12 实现,继承自 `RHIShader`
## 方法列表
## 公共方法
| 方法 | 文档 |
| 方法 | 描述 |
|------|------|
| `CompileFromFile` | [详细文档](../../shader/compile-from-file.md) |
| `Compile` | [详细文档](../../shader/compile.md) |
| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) |
| `GetD3D12Bytecode` | [详细文档](get-d3d12-bytecode.md) |
| `GetBytecode` | [详细文档](get-bytecode.md) |
| `GetBytecodeSize` | [详细文档](get-bytecode-size.md) |
| `GetType` | [详细文档](../../shader/get-type.md) |
| `GetInputLayout` | [详细文档](get-input-layout.md) |
| `GetNativeHandle` | [详细文档](../../buffer/get-native-handle.md) |
| `IsValid` | [详细文档](../../shader/is-valid.md) |
| `Bind` / `Unbind` | [详细文档](../../shader/bind.md) |
| `SetInt` / `SetFloat` / `SetVec3` / `SetVec4` / `SetMat4` | [详细文档](set-uniforms.md) |
| [`CompileFromFile`](../../shader/compile-from-file.md) | 从文件编译着色器 |
| [`Compile`](../../shader/compile.md) | 从源码编译着色器 |
| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭着色器 |
| [`GetD3D12Bytecode`](get-d3d12-bytecode.md) | 获取 D3D12 字节码 |
| [`GetBytecode`](get-bytecode.md) | 获取字节码 |
| [`GetBytecodeSize`](get-bytecode-size.md) | 获取字节码大小 |
| [`GetType`](../../command-queue/get-type.md) | 获取着色器类型 |
| [`GetInputLayout`](get-input-layout.md) | 获取输入布局 |
| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 |
| [`IsValid`](../../shader/is-valid.md) | 检查是否有效 |
| [`Bind`](../../shader/bind.md) | 绑定着色器 |
| [`Unbind`](../../shader/unbind.md) | 解绑着色器 |
| [`SetUniforms`](set-uniforms.md) | 设置 uniform 变量 |
## 相关文档
- [D3D12 后端总览](../overview.md)
- [D3D12 后端总览](../../opengl/overview.md)
- [RHIShader](../../shader/shader.md) - 抽象着色器接口

View File

@@ -4,27 +4,26 @@
**描述**: DirectX 12 交换链的 D3D12 实现,继承自 `RHISwapChain`
## 方法列表
## 公共方法
| 方法 | 文档 |
| 方法 | 描述 |
|------|------|
| `Initialize` (from factory) | [详细文档](../../../threading/task-system/initialize.md) |
| `Initialize` (from swapchain) | [详细文档](initialize-from-swapchain.md) |
| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) |
| `GetCurrentBackBufferIndex` | [详细文档](get-current-back-buffer-index.md) |
| `GetCurrentBackBuffer` | [详细文档](get-current-back-buffer.md) |
| `GetBackBuffer` | [详细文档](get-back-buffer.md) |
| `Present` | [详细文档](present.md) |
| `Resize` | [详细文档](../../../containers/array/resize.md) |
| `SetFullscreen` | [详细文档](set-fullscreen.md) |
| `IsFullscreen` | [详细文档](is-fullscreen.md) |
| `ShouldClose` | [详细文档](should-close.md) |
| `SetShouldClose` | [详细文档](set-should-close.md) |
| `PollEvents` | [详细文档](poll-events.md) |
| `GetNativeHandle` | [详细文档](../../buffer/get-native-handle.md) |
| `GetSwapChain` | [详细文档](get-swap-chain.md) |
| [`Initialize`](initialize-from-swapchain.md) | 从交换链初始化 |
| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭交换链 |
| [`GetCurrentBackBufferIndex`](get-current-back-buffer-index.md) | 获取当前后台缓冲区索引 |
| [`GetCurrentBackBuffer`](get-current-back-buffer.md) | 获取当前后台缓冲区 |
| [`GetBackBuffer`](get-back-buffer.md) | 获取后台缓冲区 |
| [`Present`](present.md) | 呈现画面 |
| [`Resize`](../../swap-chain/resize.md) | 调整交换链大小 |
| [`SetFullscreen`](set-fullscreen.md) | 设置全屏模式 |
| [`IsFullscreen`](is-fullscreen.md) | 检查是否全屏 |
| [`ShouldClose`](should-close.md) | 检查是否应关闭 |
| [`SetShouldClose`](set-should-close.md) | 设置关闭标志 |
| [`PollEvents`](poll-events.md) | 处理窗口事件 |
| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 |
| [`GetSwapChain`](get-swap-chain.md) | 获取 D3D12 交换链 |
## 相关文档
- [D3D12 后端总览](../overview.md)
- [D3D12 后端总览](../../opengl/overview.md)
- [RHISwapChain](../../swap-chain/swap-chain.md) - 抽象交换链接口

View File

@@ -4,30 +4,32 @@
**描述**: DirectX 12 纹理的 D3D12 实现,继承自 `RHITexture`
## 方法列表
## 公共方法
| 方法 | 文档 |
| 方法 | 描述 |
|------|------|
| `InitializeFromExisting` | [详细文档](../buffer/initialize-from-existing.md) |
| `InitializeFromData` | [详细文档](initialize-from-data.md) |
| `InitializeDepthStencil` | [详细文档](initialize-depth-stencil.md) |
| `Shutdown` | [详细文档](../../texture/shutdown.md) |
| `GetResource` | [详细文档](../buffer/get-resource.md) |
| `GetDesc` | [详细文档](../buffer/get-desc.md) |
| `GetWidth` | [详细文档](../../texture/get-width.md) |
| `GetHeight` | [详细文档](../../texture/get-height.md) |
| `GetDepth` | [详细文档](../../texture/get-depth.md) |
| `GetMipLevels` | [详细文档](../../texture/get-mip-levels.md) |
| `GetArraySize` | [详细文档](get-array-size.md) |
| `GetGPUAddress` | [详细文档](../buffer/get-gpu-address.md) |
| `GetSize` | [详细文档](../../buffer/get-size.md) |
| `GetName` / `SetName` | [详细文档](../../buffer/get-name.md) |
| `GetFormat` | [详细文档](../../texture/get-format.md) |
| `GetTextureType` | [详细文档](../../texture/get-texture-type.md) |
| `GetState` / `SetState` | [详细文档](../../buffer/get-state.md) |
| `GetNativeHandle` | [详细文档](../../buffer/get-native-handle.md) |
| [`InitializeFromExisting`](../buffer/initialize-from-existing.md) | 从现有资源初始化 |
| [`InitializeFromData`](initialize-from-data.md) | 从数据初始化纹理 |
| [`InitializeDepthStencil`](initialize-depth-stencil.md) | 初始化深度模板纹理 |
| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭纹理 |
| [`GetResource`](../buffer/get-resource.md) | 获取 D3D12 资源 |
| [`GetDesc`](../buffer/get-desc.md) | 获取纹理描述符 |
| [`GetWidth`](../../texture/get-width.md) | 获取纹理宽度 |
| [`GetHeight`](../../texture/get-height.md) | 获取纹理高度 |
| [`GetDepth`](../../texture/get-depth.md) | 获取纹理深度 |
| [`GetMipLevels`](../../texture/get-mip-levels.md) | 获取 Mip 级别 |
| [`GetArraySize`](get-array-size.md) | 获取数组大小 |
| [`GetGPUAddress`](../buffer/get-gpu-address.md) | 获取 GPU 地址 |
| [`GetSize`](../../buffer/get-size.md) | 获取纹理大小 |
| [`GetName`](../../buffer/get-name.md) | 获取纹理名称 |
| [`SetName`](../../buffer/set-name.md) | 设置纹理名称 |
| [`GetFormat`](../../texture/get-format.md) | 获取纹理格式 |
| [`GetTextureType`](../../texture/get-texture-type.md) | 获取纹理类型 |
| [`GetState`](../../buffer/get-state.md) | 获取资源状态 |
| [`SetState`](../../buffer/set-state.md) | 设置资源状态 |
| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 |
## 相关文档
- [D3D12 后端总览](../overview.md)
- [D3D12 后端总览](../../opengl/overview.md)
- [RHITexture](../../texture/texture.md) - 抽象纹理接口

View File

@@ -20,5 +20,5 @@
## 相关文档
- [D3D12 后端总览](../overview.md)
- [D3D12 后端总览](../../opengl/overview.md)
- [D3D12Enum](../../enums/enums.md) - 枚举值转换

View File

@@ -4,12 +4,12 @@
**描述**: DirectX 12 无序访问视图的 D3D12 实现。
## 方法列表
## 公共方法
| 方法 | 文档 |
| 方法 | 描述 |
|------|------|
| `GetCPUDescriptorHandle` | [详细文档](get-cpu-descriptor-handle.md) |
| [`GetCPUDescriptorHandle`](get-cpu-descriptor-handle.md) | 获取 CPU 描述符句柄 |
## 相关文档
- [D3D12 后端总览](../overview.md)
- [D3D12 后端总览](../../opengl/overview.md)