docs: 重构 API 文档结构并修正源码准确性
- 重组文档目录结构: 每个模块的概述页移动到模块子目录
- 重命名 index.md 为 main.md
- 修正所有模块文档中的错误:
- math: FromEuler→FromEulerAngles, TransformDirection 包含缩放, Box 是 OBB, Color::ToRGBA 格式
- containers: 新增 operator==/!= 文档, 补充 std::hash DJB 算法细节
- core: 修复 types 链接错误
- debug: LogLevelToString 返回大写, timestamp 是秒, Profiler 空实现标注, Windows API vs ANSI
- memory: 修复头文件路径, malloc vs operator new, 新增方法文档
- resources: 修复 Shader/Texture 链接错误
- threading: TaskSystem::Wait 空实现标注, ReadWriteLock 重入描述, LambdaTask 链接
- 验证: fix_links.py 确认 0 个断裂引用
2026-03-19 00:22:30 +08:00
|
|
|
# OpenGLCommandList
|
|
|
|
|
|
|
|
|
|
**命名空间**: `XCEngine::RHI`
|
|
|
|
|
|
|
|
|
|
**描述**: OpenGL 命令列表实现，继承自 `RHICommandList`。
|
|
|
|
|
|
|
|
|
|
## 方法列表
|
|
|
|
|
|
|
|
|
|
| 方法 | 文档 |
|
|
|
|
|
|------|------|
|
|
|
|
|
| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) |
|
Fix RHI documentation discrepancies and add missing doc files
Fixed incorrect links in OpenGL documentation:
- Fixed wrong links to threading/task-system docs for Initialize/Shutdown methods
- Fixed wrong links to buffer docs for GetNativeHandle methods
- Fixed wrong links to shader docs for Bind/Unbind methods
- Fixed wrong links to command-list docs for Clear/Reset/Close methods
- Fixed wrong links to buffer/get-size.md for width/height methods
Added missing documentation files:
- OpenGL buffer: bind.md, unbind.md, get-type.md, initialize.md
- OpenGL fence: initialize.md, reset.md
- OpenGL swap-chain: get-size.md, initialize.md
- OpenGL render-target-view: initialize.md, shutdown.md, bind.md, unbind.md, clear.md, get-size.md
- OpenGL depth-stencil-view: initialize.md, shutdown.md, bind.md, unbind.md, get-size.md
- OpenGL command-list: clear.md
All links validated with fix_links.py - no broken references.
2026-03-19 00:54:54 +08:00
|
|
|
| `Reset` | [详细文档](../../command-list/reset.md) |
|
|
|
|
|
| `Close` | [详细文档](../../command-list/close.md) |
|
|
|
|
|
| `Clear` | [详细文档](clear.md) |
|
docs: 重构 API 文档结构并修正源码准确性
- 重组文档目录结构: 每个模块的概述页移动到模块子目录
- 重命名 index.md 为 main.md
- 修正所有模块文档中的错误:
- math: FromEuler→FromEulerAngles, TransformDirection 包含缩放, Box 是 OBB, Color::ToRGBA 格式
- containers: 新增 operator==/!= 文档, 补充 std::hash DJB 算法细节
- core: 修复 types 链接错误
- debug: LogLevelToString 返回大写, timestamp 是秒, Profiler 空实现标注, Windows API vs ANSI
- memory: 修复头文件路径, malloc vs operator new, 新增方法文档
- resources: 修复 Shader/Texture 链接错误
- threading: TaskSystem::Wait 空实现标注, ReadWriteLock 重入描述, LambdaTask 链接
- 验证: fix_links.py 确认 0 个断裂引用
2026-03-19 00:22:30 +08:00
|
|
|
| `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) |
|
|
|
|
|
| `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) |
|
|
|
|
|
| `ClearDepthStencil` | [详细文档](clear-depth-stencil.md) |
|
|
|
|
|
| `Draw` | [详细文档](draw.md) |
|
|
|
|
|
| `DrawIndexed` | [详细文档](draw-indexed.md) |
|
|
|
|
|
| `Dispatch` | [详细文档](dispatch.md) |
|
|
|
|
|
| `CopyResource` | [详细文档](copy-resource.md) |
|
|
|
|
|
| **OpenGL 特有方法** | [详细文档](opengl-methods.md) |
|
|
|
|
|
|
|
|
|
|
## 相关文档
|
|
|
|
|
|
|
|
|
|
- [OpenGL 后端总览](../overview.md)
|
|
|
|
|
- [RHICommandList](../../command-list/command-list.md) - 抽象命令列表接口
|
