ssdfasd
2141534995
Fixed incorrect links in RHI documentation: - Fixed OpenGL swap-chain docs with wrong references to threading/containers - Fixed OpenGL texture docs with incorrect buffer/ texture links - Fixed OpenGL vertex-array docs with wrong threading links - Fixed OpenGL sampler docs with wrong threading links - Fixed OpenGL device docs with incorrect swap-chain links - Fixed fence docs with incorrect command-queue links - Fixed command-list docs with missing shutdown link - Fixed get-framebuffer-size.md title mismatch Added missing documentation: - Created fence/wait.md - Created command-list/shutdown.md - Created swap-chain/resize.md - Created OpenGL sampler initialize.md, bind.md, unbind.md
103 lines
2.7 KiB
Markdown
103 lines
2.7 KiB
Markdown
# RHICommandList
|
|
|
|
**命名空间**: `XCEngine::RHI`
|
|
|
|
**类型**: `class` (abstract)
|
|
|
|
**描述**: GPU 命令列表抽象接口，用于录制和执行 GPU 命令。
|
|
|
|
## 公共方法
|
|
|
|
### 命令录制控制
|
|
|
|
| 方法 | 文档 |
|
|
|------|------|
|
|
| `Reset` | [详细文档](reset.md) |
|
|
| `Close` | [详细文档](close.md) |
|
|
|
|
### 资源状态转换
|
|
|
|
| 方法 | 文档 |
|
|
|------|------|
|
|
| `TransitionBarrier` | [详细文档](transition-barrier.md) |
|
|
|
|
### 渲染状态设置
|
|
|
|
| 方法 | 文档 |
|
|
|------|------|
|
|
| `SetPipelineState` | [详细文档](set-pipeline-state.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) |
|
|
|
|
### 深度/混合状态
|
|
|
|
| 方法 | 文档 |
|
|
|------|------|
|
|
| `SetDepthStencilState` | [详细文档](set-depth-stencil-state.md) |
|
|
| `SetStencilRef` | [详细文档](set-stencil-ref.md) |
|
|
| `SetBlendState` | [详细文档](set-blend-state.md) |
|
|
| `SetBlendFactor` | [详细文档](set-blend-factor.md) |
|
|
|
|
### 顶点/索引缓冲
|
|
|
|
| 方法 | 文档 |
|
|
|------|------|
|
|
| `SetVertexBuffer` | [详细文档](set-vertex-buffer.md) |
|
|
| `SetVertexBuffers` | [详细文档](set-vertex-buffers.md) |
|
|
| `SetIndexBuffer` | [详细文档](set-index-buffer.md) |
|
|
|
|
### 绘制命令
|
|
|
|
| 方法 | 文档 |
|
|
|------|------|
|
|
| `Draw` | [详细文档](draw.md) |
|
|
| `DrawIndexed` | [详细文档](draw-indexed.md) |
|
|
|
|
### 清除命令
|
|
|
|
| 方法 | 文档 |
|
|
|------|------|
|
|
| `Clear` | [详细文档](clear.md) |
|
|
| `ClearRenderTarget` | [详细文档](clear-render-target.md) |
|
|
| `ClearDepthStencil` | [详细文档](clear-depth-stencil.md) |
|
|
|
|
### 资源复制
|
|
|
|
| 方法 | 文档 |
|
|
|------|------|
|
|
| `CopyResource` | [详细文档](copy-resource.md) |
|
|
|
|
### 计算着色器
|
|
|
|
| 方法 | 文档 |
|
|
|------|------|
|
|
| `Dispatch` | [详细文档](dispatch.md) |
|
|
|
|
### 生命周期
|
|
|
|
| 方法 | 文档 |
|
|
|------|------|
|
|
| `Shutdown` | [详细文档](../../threading/task-system/shutdown.md) |
|
|
|
|
## 使用示例
|
|
|
|
```cpp
|
|
commandList->Reset();
|
|
commandList->SetPipelineState(pipelineState);
|
|
commandList->SetPrimitiveTopology(PrimitiveTopology::TriangleList);
|
|
commandList->SetViewport(viewport);
|
|
commandList->SetRenderTargets(1, &renderTarget, depthStencil);
|
|
commandList->DrawIndexed(indexCount, 1, 0, 0, 0);
|
|
commandList->Close();
|
|
commandQueue->ExecuteCommandLists(1, (void**)&commandList);
|
|
```
|
|
|
|
## 相关文档
|
|
|
|
- [../rhi/rhi.md](../rhi.md) - RHI 模块总览
|
|
- [RHICommandQueue](../command-queue/command-queue.md) - 命令队列
|