xuanchi/XCEngine
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix RHI documentation discrepancies and add missing doc files

Browse Source 
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:
ssdfasd
2026-03-19 00:54:54 +08:00
parent 086eb877b5
commit a669ec819d
31 changed files with 376 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/api/rhi/opengl/shader/shader.md
View File

@@ -10,13 +10,10 @@
|------|------|
| `CompileFromFile` | [详细文档](../../shader/compile-from-file.md) |
| `Compile` | [详细文档](../../shader/compile.md) |
| `CompileFromFile` (VS+FS) | [详细文档](compile-from-file-vs-fs.md) |
| `CompileFromFile` (VS+GS+FS) | [详细文档](compile-from-file-vs-gs-fs.md) |
| `Compile` (VS+FS) | [详细文档](compile-vs-fs.md) |
| `CompileCompute` | [详细文档](compile-compute.md) |
| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) |
| `Shutdown` | [详细文档](../../shader/shutdown.md) |
| `Use` | [详细文档](use.md) |
| `Bind` / `Unbind` | [详细文档](../../shader/bind.md) |
| `Bind` | [详细文档](../../shader/bind.md) |
| `Unbind` | [详细文档](../../shader/unbind.md) |
| `SetInt` | [详细文档](../../shader/set-int.md) |
| `SetIntArray` | [详细文档](set-int-array.md) |
| `SetFloat` | [详细文档](../../shader/set-float.md) |
@@ -26,7 +23,7 @@
| `SetMat4` | [详细文档](../../shader/set-mat4.md) |
| `GetUniformLocation` | [详细文档](get-uniform-location.md) |
| `GetID` | [详细文档](get-id.md) |
| `GetNativeHandle` | [详细文档](../../buffer/get-native-handle.md) |
| `GetNativeHandle` | [详细文档](../../shader/get-native-handle.md) |
| `IsValid` | [详细文档](../../shader/is-valid.md) |
| `GetType` | [详细文档](../../shader/get-type.md) |