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:
17
docs/api/rhi/opengl/buffer/bind.md
Normal file
17
docs/api/rhi/opengl/buffer/bind.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# OpenGLBuffer::Bind
|
||||
|
||||
```cpp
|
||||
void Bind() const;
|
||||
```
|
||||
|
||||
绑定缓冲区到 OpenGL 目标。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
buffer.Bind();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLBuffer 总览](buffer.md) - 返回类总览
|
||||
@@ -8,19 +8,19 @@
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) |
|
||||
| `Initialize` | [详细文档](initialize.md) |
|
||||
| `InitializeVertexBuffer` | [详细文档](initialize-vertex-buffer.md) |
|
||||
| `InitializeIndexBuffer` | [详细文档](initialize-index-buffer.md) |
|
||||
| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) |
|
||||
| `Bind` | [详细文档](../../shader/bind.md) |
|
||||
| `Unbind` | [详细文档](../../shader/unbind.md) |
|
||||
| `Shutdown` | [详细文档](../../buffer/shutdown.md) |
|
||||
| `Bind` | [详细文档](bind.md) |
|
||||
| `Unbind` | [详细文档](unbind.md) |
|
||||
| `BindBase` | [详细文档](bind-base.md) |
|
||||
| `Map` | [详细文档](../../buffer/map.md) |
|
||||
| `Unmap` | [详细文档](../../buffer/unmap.md) |
|
||||
| `SetData` | [详细文档](../../buffer/set-data.md) |
|
||||
| `GetID` | [详细文档](get-id.md) |
|
||||
| `GetSize` | [详细文档](../../buffer/get-size.md) |
|
||||
| `GetType` | [详细文档](../../shader/get-type.md) |
|
||||
| `GetType` | [详细文档](../../command-queue/get-type.md) |
|
||||
| `IsDynamic` | [详细文档](is-dynamic.md) |
|
||||
| `GetBufferType` / `SetBufferType` | [详细文档](../../buffer/get-buffer-type.md) |
|
||||
| `GetStride` / `SetStride` | [详细文档](../../buffer/get-stride.md) |
|
||||
|
||||
19
docs/api/rhi/opengl/buffer/get-type.md
Normal file
19
docs/api/rhi/opengl/buffer/get-type.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# OpenGLBuffer::GetType
|
||||
|
||||
```cpp
|
||||
OpenGLBufferType GetType() const;
|
||||
```
|
||||
|
||||
获取缓冲区类型。
|
||||
|
||||
**返回:** OpenGL 缓冲区类型
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
OpenGLBufferType type = buffer.GetType();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLBuffer 总览](buffer.md) - 返回类总览
|
||||
26
docs/api/rhi/opengl/buffer/initialize.md
Normal file
26
docs/api/rhi/opengl/buffer/initialize.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# OpenGLBuffer::Initialize
|
||||
|
||||
```cpp
|
||||
bool Initialize(OpenGLBufferType type, size_t size, const void* data = nullptr, bool dynamic = false);
|
||||
```
|
||||
|
||||
初始化 OpenGL 缓冲区。
|
||||
|
||||
**参数:**
|
||||
- `type` - 缓冲区类型
|
||||
- `size` - 缓冲区大小(字节)
|
||||
- `data` - 初始数据指针(可选)
|
||||
- `dynamic` - 是否为动态缓冲区
|
||||
|
||||
**返回:** 成功返回 true
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
OpenGLBuffer buffer;
|
||||
buffer.Initialize(OpenGLBufferType::Vertex, sizeof(vertices), vertices);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLBuffer 总览](buffer.md) - 返回类总览
|
||||
17
docs/api/rhi/opengl/buffer/unbind.md
Normal file
17
docs/api/rhi/opengl/buffer/unbind.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# OpenGLBuffer::Unbind
|
||||
|
||||
```cpp
|
||||
void Unbind() const;
|
||||
```
|
||||
|
||||
解除绑定缓冲区。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
buffer.Unbind();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLBuffer 总览](buffer.md) - 返回类总览
|
||||
Reference in New Issue
Block a user