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.
This commit is contained in:
24
docs/api/rhi/opengl/command-list/clear.md
Normal file
24
docs/api/rhi/opengl/command-list/clear.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# OpenGLCommandList::Clear
|
||||
|
||||
```cpp
|
||||
void Clear(float r, float g, float b, float a, unsigned int buffers);
|
||||
```
|
||||
|
||||
清除缓冲区。
|
||||
|
||||
**参数:**
|
||||
- `r` - 红色分量
|
||||
- `g` - 绿色分量
|
||||
- `b` - 蓝色分量
|
||||
- `a` - Alpha 分量
|
||||
- `buffers` - 要清除的缓冲区标志
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
commandList->Clear(0.0f, 0.0f, 0.0f, 1.0f, Color | Depth);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLCommandList 总览](command-list.md) - 返回类总览
|
||||
@@ -9,9 +9,9 @@
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) |
|
||||
| `Reset` | [详细文档](../../../resources/resourcehandle/reset.md) |
|
||||
| `Close` | [详细文档](../../../core/filewriter/close.md) |
|
||||
| `Clear` | [详细文档](../../../memory/linear-allocator/clear.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) |
|
||||
|
||||
Reference in New Issue
Block a user