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:
@@ -8,16 +8,16 @@
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) |
|
||||
| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) |
|
||||
| `Initialize` | [详细文档](initialize.md) |
|
||||
| `Shutdown` | [详细文档](../../fence/shutdown.md) |
|
||||
| `Signal` | [详细文档](signal.md) |
|
||||
| `Wait` | [详细文档](../../../threading/task-group/wait.md) |
|
||||
| `Reset` | [详细文档](../../../resources/resourcehandle/reset.md) |
|
||||
| `Reset` | [详细文档](reset.md) |
|
||||
| `IsSignaled` | [详细文档](is-signaled.md) |
|
||||
| `GetStatus` | [详细文档](get-status.md) |
|
||||
| `GetCompletedValue` | [详细文档](get-completed-value.md) |
|
||||
| `GetCurrentValue` | [详细文档](get-current-value.md) |
|
||||
| `GetNativeHandle` | [详细文档](../../buffer/get-native-handle.md) |
|
||||
| `GetNativeHandle` | [详细文档](../../fence/get-native-handle.md) |
|
||||
|
||||
## 相关文档
|
||||
|
||||
|
||||
23
docs/api/rhi/opengl/fence/initialize.md
Normal file
23
docs/api/rhi/opengl/fence/initialize.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# OpenGLFence::Initialize
|
||||
|
||||
```cpp
|
||||
bool Initialize(bool signaled = false);
|
||||
```
|
||||
|
||||
初始化 OpenGL 栅栏。
|
||||
|
||||
**参数:**
|
||||
- `signaled` - 初始是否为 signaled 状态
|
||||
|
||||
**返回:** 成功返回 true
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
OpenGLFence fence;
|
||||
fence.Initialize(true);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLFence 总览](fence.md) - 返回类总览
|
||||
17
docs/api/rhi/opengl/fence/reset.md
Normal file
17
docs/api/rhi/opengl/fence/reset.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# OpenGLFence::Reset
|
||||
|
||||
```cpp
|
||||
void Reset();
|
||||
```
|
||||
|
||||
重置栅栏。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
fence->Reset();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLFence 总览](fence.md) - 返回类总览
|
||||
Reference in New Issue
Block a user