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:
11
docs/api/rhi/opengl/depth-stencil-view/bind.md
Normal file
11
docs/api/rhi/opengl/depth-stencil-view/bind.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# OpenGLDepthStencilView::Bind
|
||||
|
||||
```cpp
|
||||
void Bind() const;
|
||||
```
|
||||
|
||||
绑定深度模板视图。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLDepthStencilView 总览](depth-stencil-view.md) - 返回类总览
|
||||
@@ -8,18 +8,18 @@
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) |
|
||||
| `Initialize` | [详细文档](initialize.md) |
|
||||
| `InitializeCubemap` | [详细文档](initialize-cubemap.md) |
|
||||
| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) |
|
||||
| `Bind` | [详细文档](../../shader/bind.md) |
|
||||
| `Unbind` | [详细文档](../../shader/unbind.md) |
|
||||
| `Shutdown` | [详细文档](shutdown.md) |
|
||||
| `Bind` | [详细文档](bind.md) |
|
||||
| `Unbind` | [详细文档](unbind.md) |
|
||||
| `ClearDepth` | [详细文档](clear-depth.md) |
|
||||
| `ClearStencil` | [详细文档](clear-stencil.md) |
|
||||
| `ClearDepthStencil` | [详细文档](clear-depth-stencil.md) |
|
||||
| `GetFramebuffer` | [详细文档](get-framebuffer.md) |
|
||||
| `GetTexture` | [详细文档](get-texture.md) |
|
||||
| `GetMipLevel` | [详细文档](get-mip-level.md) |
|
||||
| `GetWidth` / `GetHeight` | [详细文档](../../buffer/get-size.md) |
|
||||
| `GetWidth` / `GetHeight` | [详细文档](get-size.md) |
|
||||
| `BindFramebuffer` | [详细文档](bind-framebuffer.md) |
|
||||
| `UnbindFramebuffer` | [详细文档](unbind-framebuffer.md) |
|
||||
|
||||
|
||||
14
docs/api/rhi/opengl/depth-stencil-view/get-size.md
Normal file
14
docs/api/rhi/opengl/depth-stencil-view/get-size.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# OpenGLDepthStencilView::GetWidth / GetHeight
|
||||
|
||||
```cpp
|
||||
int GetWidth() const;
|
||||
int GetHeight() const;
|
||||
```
|
||||
|
||||
获取深度模板视图的宽度和高度。
|
||||
|
||||
**返回:** 宽度/高度
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLDepthStencilView 总览](depth-stencil-view.md) - 返回类总览
|
||||
18
docs/api/rhi/opengl/depth-stencil-view/initialize.md
Normal file
18
docs/api/rhi/opengl/depth-stencil-view/initialize.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# OpenGLDepthStencilView::Initialize
|
||||
|
||||
```cpp
|
||||
bool Initialize(unsigned int texture, int width, int height);
|
||||
```
|
||||
|
||||
初始化深度模板视图。
|
||||
|
||||
**参数:**
|
||||
- `texture` - OpenGL 纹理 ID
|
||||
- `width` - 宽度
|
||||
- `height` - 高度
|
||||
|
||||
**返回:** 成功返回 true
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLDepthStencilView 总览](depth-stencil-view.md) - 返回类总览
|
||||
11
docs/api/rhi/opengl/depth-stencil-view/shutdown.md
Normal file
11
docs/api/rhi/opengl/depth-stencil-view/shutdown.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# OpenGLDepthStencilView::Shutdown
|
||||
|
||||
```cpp
|
||||
void Shutdown();
|
||||
```
|
||||
|
||||
关闭深度模板视图。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLDepthStencilView 总览](depth-stencil-view.md) - 返回类总览
|
||||
11
docs/api/rhi/opengl/depth-stencil-view/unbind.md
Normal file
11
docs/api/rhi/opengl/depth-stencil-view/unbind.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# OpenGLDepthStencilView::Unbind
|
||||
|
||||
```cpp
|
||||
void Unbind() const;
|
||||
```
|
||||
|
||||
解除绑定深度模板视图。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLDepthStencilView 总览](depth-stencil-view.md) - 返回类总览
|
||||
Reference in New Issue
Block a user