docs: Fix RHI module documentation discrepancies
Fixed incorrect links in RHI documentation: - Fixed OpenGL swap-chain docs with wrong references to threading/containers - Fixed OpenGL texture docs with incorrect buffer/ texture links - Fixed OpenGL vertex-array docs with wrong threading links - Fixed OpenGL sampler docs with wrong threading links - Fixed OpenGL device docs with incorrect swap-chain links - Fixed fence docs with incorrect command-queue links - Fixed command-list docs with missing shutdown link - Fixed get-framebuffer-size.md title mismatch Added missing documentation: - Created fence/wait.md - Created command-list/shutdown.md - Created swap-chain/resize.md - Created OpenGL sampler initialize.md, bind.md, unbind.md
This commit is contained in:
22
docs/api/rhi/opengl/sampler/bind.md
Normal file
22
docs/api/rhi/opengl/sampler/bind.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# OpenGLSampler::Bind
|
||||
|
||||
```cpp
|
||||
void Bind(unsigned int unit);
|
||||
```
|
||||
|
||||
绑定采样器到纹理单元。
|
||||
|
||||
**参数:**
|
||||
- `unit` - 纹理单元编号
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
sampler.Bind(0);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLSampler 总览](sampler.md) - 返回类总览
|
||||
29
docs/api/rhi/opengl/sampler/initialize.md
Normal file
29
docs/api/rhi/opengl/sampler/initialize.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# OpenGLSampler::Initialize
|
||||
|
||||
```cpp
|
||||
bool Initialize(const OpenGLSamplerDesc& desc);
|
||||
```
|
||||
|
||||
初始化采样器。
|
||||
|
||||
**参数:**
|
||||
- `desc` - 采样器描述符
|
||||
|
||||
**返回:** 成功返回 `true`,失败返回 `false`
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
OpenGLSamplerDesc desc;
|
||||
desc.minFilter = SamplerFilter::LinearMipmapLinear;
|
||||
desc.magFilter = SamplerFilter::Linear;
|
||||
desc.wrapS = SamplerWrapMode::Repeat;
|
||||
desc.wrapT = SamplerWrapMode::Repeat;
|
||||
sampler.Initialize(desc);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLSampler 总览](sampler.md) - 返回类总览
|
||||
@@ -8,10 +8,10 @@
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) |
|
||||
| `Initialize` | [详细文档](initialize.md) |
|
||||
| `Shutdown` | [详细文档](../../sampler/shutdown.md) |
|
||||
| `Bind` | [详细文档](../../shader/bind.md) |
|
||||
| `Unbind` | [详细文档](../../shader/unbind.md) |
|
||||
| `Bind` | [详细文档](bind.md) |
|
||||
| `Unbind` | [详细文档](unbind.md) |
|
||||
| `GetID` | [详细文档](get-id.md) |
|
||||
| `GetNativeHandle` | [详细文档](../../sampler/get-native-handle.md) |
|
||||
|
||||
|
||||
22
docs/api/rhi/opengl/sampler/unbind.md
Normal file
22
docs/api/rhi/opengl/sampler/unbind.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# OpenGLSampler::Unbind
|
||||
|
||||
```cpp
|
||||
void Unbind(unsigned int unit);
|
||||
```
|
||||
|
||||
解绑采样器。
|
||||
|
||||
**参数:**
|
||||
- `unit` - 纹理单元编号
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
sampler.Unbind(0);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLSampler 总览](sampler.md) - 返回类总览
|
||||
Reference in New Issue
Block a user