docs: update RHI API docs
This commit is contained in:
@@ -2,41 +2,112 @@
|
||||
|
||||
**命名空间**: `XCEngine::RHI`
|
||||
|
||||
**描述**: OpenGL 命令列表实现,继承自 `RHICommandList`。
|
||||
**描述**: OpenGL 命令列表实现,继承自 `RHICommandList`。提供 OpenGL 图形 API 的命令录制与执行接口,支持底层 OpenGL 状态操作以及跨平台 RHI 抽象接口。
|
||||
|
||||
## 概述
|
||||
|
||||
`OpenGLCommandList` 是 XCEngine RHI(渲染硬件接口)层在 OpenGL 后端的实现类。它封装了 OpenGL 图形命令的调用,提供了两类接口:
|
||||
|
||||
1. **RHI 抽象接口**:继承自 `RHICommandList`,提供跨后端一致性接口
|
||||
2. **OpenGL 特有方法**:底层逃逸接口,用于需要直接操作 OpenGL 状态的场景
|
||||
|
||||
## 公共方法
|
||||
|
||||
### 生命周期
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`Shutdown`](opengl-methods.md#shutdown) | 关闭命令列表(占位实现) |
|
||||
| [`Reset`](opengl-methods.md#reset) | 重置命令列表(占位实现) |
|
||||
| [`Close`](opengl-methods.md#close) | 关闭命令列表(占位实现) |
|
||||
|
||||
### 清除操作
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`Clear`](clear.md) | 清除指定缓冲区 |
|
||||
| [`ClearColor`](clear-color.md) | 清除颜色缓冲区 |
|
||||
| [`ClearDepth`](clear-depth.md) | 清除深度缓冲区 |
|
||||
| [`ClearStencil`](clear-stencil.md) | 清除模板缓冲区 |
|
||||
| [`ClearDepthStencil`](clear-depth-stencil.md) | 清除深度和模板缓冲区 |
|
||||
| [`ClearRenderTarget`](clear-render-target.md) | 清除渲染目标 |
|
||||
|
||||
### 状态设置
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭命令列表 |
|
||||
| [`Reset`](../../command-list/reset.md) | 重置命令列表 |
|
||||
| [`Close`](../../command-list/close.md) | 关闭命令列表 |
|
||||
| [`Clear`](clear.md) | 清除 |
|
||||
| [`ClearColor`](clear-color.md) | 清除颜色 |
|
||||
| [`ClearDepth`](clear-depth.md) | 清除深度 |
|
||||
| [`ClearStencil`](clear-stencil.md) | 清除模板 |
|
||||
| [`ClearDepthStencil`](clear-depth-stencil.md) | 清除深度模板 |
|
||||
| [`SetPipelineState`](set-pipeline-state.md) | 设置管线状态 |
|
||||
| [`SetVertexBuffer`](set-vertex-buffer.md) | 设置顶点缓冲 |
|
||||
| [`SetVertexBuffers`](set-vertex-buffers.md) | 设置多个顶点缓冲 |
|
||||
| [`SetIndexBuffer`](set-index-buffer.md) | 设置索引缓冲 |
|
||||
| [`TransitionBarrier`](transition-barrier.md) | 资源状态转换 |
|
||||
| [`SetPrimitiveTopology`](set-primitive-topology.md) | 设置图元拓扑 |
|
||||
| [`SetViewport`](set-viewport.md) | 设置视口 |
|
||||
| [`SetViewports`](set-viewports.md) | 设置多个视口 |
|
||||
| [`SetScissorRect`](set-scissor-rect.md) | 设置裁剪矩形 |
|
||||
| [`SetScissorRects`](set-scissor-rects.md) | 设置多个裁剪矩形 |
|
||||
| [`SetVertexBuffer`](set-vertex-buffer.md) | 设置顶点缓冲区 |
|
||||
| [`SetVertexBuffers`](set-vertex-buffers.md) | 批量设置顶点缓冲区 |
|
||||
| [`SetIndexBuffer`](set-index-buffer.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) | 设置混合因子 |
|
||||
| [`ClearRenderTarget`](clear-render-target.md) | 清除渲染目标 |
|
||||
| [`Draw`](draw.md) | 绘制 |
|
||||
| [`DrawIndexed`](draw-indexed.md) | 索引绘制 |
|
||||
| [`SetBlendFactor`](set-blend-factor.md) | 设置混合因子颜色 |
|
||||
| [`SetPrimitiveTopology`](set-primitive-topology.md) | 设置图元拓扑 |
|
||||
|
||||
### 视口与裁剪
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`SetViewport`](set-viewport.md) | 设置视口 |
|
||||
| [`SetViewports`](set-viewports.md) | 批量设置视口 |
|
||||
| [`SetScissorRect`](set-scissor-rect.md) | 设置裁剪矩形 |
|
||||
| [`SetScissorRects`](set-scissor-rects.md) | 批量设置裁剪矩形 |
|
||||
|
||||
### 绘制
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`Draw`](draw.md) | 绘制非索引图元 |
|
||||
| [`DrawIndexed`](draw-indexed.md) | 绘制索引图元 |
|
||||
|
||||
### 计算
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`Dispatch`](dispatch.md) | 分发计算任务 |
|
||||
| [`CopyResource`](copy-resource.md) | 复制资源 |
|
||||
| [`OpenGLMethods`](opengl-methods.md) | OpenGL 特有方法 |
|
||||
| [`CopyResource`](copy-resource.md) | 复制资源(占位实现) |
|
||||
| [`TransitionBarrier`](transition-barrier.md) | 资源状态转换(占位实现) |
|
||||
|
||||
### OpenGL 特有方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`OpenGLMethods`](opengl-methods.md) | 底层 OpenGL 逃逸接口 |
|
||||
|
||||
## 使用示例
|
||||
|
||||
```cpp
|
||||
#include "XCEngine/RHI/OpenGL/OpenGLCommandList.h"
|
||||
|
||||
using namespace XCEngine::RHI;
|
||||
|
||||
// 创建命令列表
|
||||
OpenGLCommandList* cmdList = new OpenGLCommandList();
|
||||
|
||||
// 清除颜色缓冲区
|
||||
cmdList->ClearColor(0.0f, 0.0f, 0.0f, 1.0f);
|
||||
|
||||
// 设置视口
|
||||
Viewport viewport;
|
||||
viewport.topLeftX = 0.0f;
|
||||
viewport.topLeftY = 0.0f;
|
||||
viewport.width = 800.0f;
|
||||
viewport.height = 600.0f;
|
||||
viewport.minDepth = 0.0f;
|
||||
viewport.maxDepth = 1.0f;
|
||||
cmdList->SetViewport(viewport);
|
||||
|
||||
// 绑定 shader program
|
||||
cmdList->UseShader(shaderProgram);
|
||||
|
||||
// 绘制
|
||||
cmdList->Draw(3, 1, 0, 0);
|
||||
|
||||
delete cmdList;
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
|
||||
Reference in New Issue
Block a user