fix: improve doc link navigation and tree display
- Fix link resolution with proper relative/absolute path handling - Improve link styling with underline decoration - Hide leaf nodes from tree, only show directories - Fix log file path for packaged app
This commit is contained in:
20
docs/api/rhi/opengl/depth-stencil-view/bind-framebuffer.md
Normal file
20
docs/api/rhi/opengl/depth-stencil-view/bind-framebuffer.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# OpenGLDepthStencilView::BindFramebuffer
|
||||
|
||||
```cpp
|
||||
static void BindFramebuffer(unsigned int framebuffer)
|
||||
```
|
||||
|
||||
静态方法,将指定帧缓冲区绑定为当前深度模板帧缓冲区。
|
||||
|
||||
**参数:**
|
||||
- `framebuffer` - 帧缓冲区 ID(0 表示解除绑定)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
OpenGLDepthStencilView::BindFramebuffer(dsv.GetFramebuffer());
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLDepthStencilView](depth-stencil-view.md) - 返回类总览
|
||||
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) - 返回类总览
|
||||
@@ -0,0 +1,21 @@
|
||||
# OpenGLDepthStencilView::ClearDepthStencil
|
||||
|
||||
```cpp
|
||||
void ClearDepthStencil(float depth, uint8_t stencil)
|
||||
```
|
||||
|
||||
同时清除深度和模板缓冲区。
|
||||
|
||||
**参数:**
|
||||
- `depth` - 深度值(通常为 0.0 到 1.0)
|
||||
- `stencil` - 模板值(0-255)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
dsv.ClearDepthStencil(1.0f, 0);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLDepthStencilView](depth-stencil-view.md) - 返回类总览
|
||||
20
docs/api/rhi/opengl/depth-stencil-view/clear-depth.md
Normal file
20
docs/api/rhi/opengl/depth-stencil-view/clear-depth.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# OpenGLDepthStencilView::ClearDepth
|
||||
|
||||
```cpp
|
||||
void ClearDepth(float depth)
|
||||
```
|
||||
|
||||
清除深度缓冲区的深度值。
|
||||
|
||||
**参数:**
|
||||
- `depth` - 深度值(通常为 0.0 到 1.0)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
dsv.ClearDepth(1.0f);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLDepthStencilView](depth-stencil-view.md) - 返回类总览
|
||||
20
docs/api/rhi/opengl/depth-stencil-view/clear-stencil.md
Normal file
20
docs/api/rhi/opengl/depth-stencil-view/clear-stencil.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# OpenGLDepthStencilView::ClearStencil
|
||||
|
||||
```cpp
|
||||
void ClearStencil(uint8_t stencil)
|
||||
```
|
||||
|
||||
清除模板缓冲区的模板值。
|
||||
|
||||
**参数:**
|
||||
- `stencil` - 模板值(0-255)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
dsv.ClearStencil(0);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLDepthStencilView](depth-stencil-view.md) - 返回类总览
|
||||
29
docs/api/rhi/opengl/depth-stencil-view/depth-stencil-view.md
Normal file
29
docs/api/rhi/opengl/depth-stencil-view/depth-stencil-view.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# OpenGLDepthStencilView
|
||||
|
||||
**命名空间**: `XCEngine::RHI`
|
||||
|
||||
**描述**: OpenGL 深度模板视图实现。
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`Initialize`](initialize.md) | 初始化深度模板视图 |
|
||||
| [`InitializeCubemap`](initialize-cubemap.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) | 获取 Mip 级别 |
|
||||
| [`GetWidth`](get-size.md) | 获取宽度 |
|
||||
| [`GetHeight`](get-size.md) | 获取高度 |
|
||||
| [`BindFramebuffer`](bind-framebuffer.md) | 绑定帧缓冲 |
|
||||
| [`UnbindFramebuffer`](unbind-framebuffer.md) | 解绑帧缓冲 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGL 后端总览](../overview.md)
|
||||
19
docs/api/rhi/opengl/depth-stencil-view/get-framebuffer.md
Normal file
19
docs/api/rhi/opengl/depth-stencil-view/get-framebuffer.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# OpenGLDepthStencilView::GetFramebuffer
|
||||
|
||||
```cpp
|
||||
unsigned int GetFramebuffer() const
|
||||
```
|
||||
|
||||
获取帧缓冲区对象 ID。
|
||||
|
||||
**返回:** `unsigned int` - 帧缓冲区 ID
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
unsigned int fbo = dsv.GetFramebuffer();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLDepthStencilView](depth-stencil-view.md) - 返回类总览
|
||||
19
docs/api/rhi/opengl/depth-stencil-view/get-mip-level.md
Normal file
19
docs/api/rhi/opengl/depth-stencil-view/get-mip-level.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# OpenGLDepthStencilView::GetMipLevel
|
||||
|
||||
```cpp
|
||||
int GetMipLevel() const
|
||||
```
|
||||
|
||||
获取 mipmap 级别。
|
||||
|
||||
**返回:** `int` - mip 级别
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
int mipLevel = dsv.GetMipLevel();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLDepthStencilView](depth-stencil-view.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) - 返回类总览
|
||||
19
docs/api/rhi/opengl/depth-stencil-view/get-texture.md
Normal file
19
docs/api/rhi/opengl/depth-stencil-view/get-texture.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# OpenGLDepthStencilView::GetTexture
|
||||
|
||||
```cpp
|
||||
unsigned int GetTexture() const
|
||||
```
|
||||
|
||||
获取关联的纹理对象 ID。
|
||||
|
||||
**返回:** `unsigned int` - 纹理 ID
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
unsigned int tex = dsv.GetTexture();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLDepthStencilView](depth-stencil-view.md) - 返回类总览
|
||||
25
docs/api/rhi/opengl/depth-stencil-view/initialize-cubemap.md
Normal file
25
docs/api/rhi/opengl/depth-stencil-view/initialize-cubemap.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# OpenGLDepthStencilView::InitializeCubemap
|
||||
|
||||
```cpp
|
||||
bool InitializeCubemap(unsigned int cubemap, int face, int mipLevel = 0)
|
||||
```
|
||||
|
||||
初始化立方体贴图的深度模板视图。
|
||||
|
||||
**参数:**
|
||||
- `cubemap` - 立方体贴图对象 ID
|
||||
- `face` - 立方体贴面索引(0-5)
|
||||
- `mipLevel` - mipmap 级别(默认为 0)
|
||||
|
||||
**返回:** `bool` - 成功返回 true,失败返回 false
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
OpenGLDepthStencilView dsv;
|
||||
dsv.InitializeCubemap(cubemapTexture, 0, 0);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [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) - 返回类总览
|
||||
17
docs/api/rhi/opengl/depth-stencil-view/unbind-framebuffer.md
Normal file
17
docs/api/rhi/opengl/depth-stencil-view/unbind-framebuffer.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# OpenGLDepthStencilView::UnbindFramebuffer
|
||||
|
||||
```cpp
|
||||
static void UnbindFramebuffer()
|
||||
```
|
||||
|
||||
静态方法,解除当前深度模板帧缓冲区的绑定。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
OpenGLDepthStencilView::UnbindFramebuffer();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [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