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:
2026-03-19 12:44:08 +08:00
parent e003fe6513
commit 58a83f445a
1012 changed files with 56880 additions and 22 deletions

View File

@@ -0,0 +1,22 @@
# OpenGLTexture::BindImage
```cpp
void BindImage(int slot, bool read, bool write) const
```
将纹理绑定到图像单元,用于着色器图像访问。
**参数:**
- `slot` - 图像单元槽位
- `read` - 是否可读
- `write` - 是否可写
**示例:**
```cpp
texture.BindImage(0, true, false); // 只读访问
```
## 相关文档
- [OpenGLTexture](texture.md) - 返回类总览

View File

@@ -0,0 +1,18 @@
# OpenGLTexture::GenerateMipmap
```cpp
void GenerateMipmap()
```
生成纹理的 mipmap。
**示例:**
```cpp
texture.LoadFromFile("assets/textures/wood.jpg");
texture.GenerateMipmap();
```
## 相关文档
- [OpenGLTexture](texture.md) - 返回类总览

View File

@@ -0,0 +1,20 @@
# OpenGLTexture::GetID
```cpp
unsigned int GetID() const
```
获取 OpenGL 纹理对象 ID。
**返回:** `unsigned int` - OpenGL 纹理 ID
**示例:**
```cpp
unsigned int texID = texture.GetID();
glBindTexture(GL_TEXTURE_2D, texID);
```
## 相关文档
- [OpenGLTexture](texture.md) - 返回类总览

View File

@@ -0,0 +1,23 @@
# OpenGLTexture::GetOpenGLType
```cpp
OpenGLTextureType GetOpenGLType() const
```
获取纹理的 OpenGL 类型。
**返回:** `OpenGLTextureType` - 纹理类型枚举值:
- `OpenGLTextureType::Texture1D`
- `OpenGLTextureType::Texture2D`
- `OpenGLTextureType::TextureCube`
- 等等
**示例:**
```cpp
OpenGLTextureType type = texture.GetOpenGLType();
```
## 相关文档
- [OpenGLTexture](texture.md) - 返回类总览

View File

@@ -0,0 +1,28 @@
# OpenGLTexture::Initialize2D
```cpp
bool Initialize2D(int width, int height, int channels, const void* data, bool generateMipmap = true)
```
初始化一个 2D 纹理。
**参数:**
- `width` - 纹理宽度(像素)
- `height` - 纹理高度(像素)
- `channels` - 通道数1=R, 2=RG, 4=RGBA
- `data` - 纹理数据指针(可以为 nullptr 创建空纹理)
- `generateMipmap` - 是否自动生成 mipmap默认为 true
**返回:** `bool` - 成功返回 true失败返回 false
**示例:**
```cpp
OpenGLTexture texture;
std::vector<unsigned char> pixels(width * height * 4);
texture.Initialize2D(width, height, 4, pixels.data(), true);
```
## 相关文档
- [OpenGLTexture](texture.md) - 返回类总览

View File

@@ -0,0 +1,26 @@
# OpenGLTexture::InitializeCubeMap
```cpp
bool InitializeCubeMap(int size, int mipLevels, OpenGLFormat format, const void* data = nullptr)
```
初始化一个立方体纹理。
**参数:**
- `size` - 立方体贴面的边长
- `mipLevels` - mipmap 级别数量
- `format` - 纹理格式OpenGLFormat 枚举值)
- `data` - 纹理数据指针(可以为 nullptr
**返回:** `bool` - 成功返回 true失败返回 false
**示例:**
```cpp
OpenGLTexture cubemap;
cubemap.InitializeCubeMap(512, 1, OpenGLFormat::RGBA8, nullptr);
```
## 相关文档
- [OpenGLTexture](texture.md) - 返回类总览

View File

@@ -0,0 +1,26 @@
# OpenGLTexture::LoadFromFile
```cpp
bool LoadFromFile(const char* path, bool flipVertical = true)
```
从图像文件加载纹理。
**参数:**
- `path` - 图像文件路径
- `flipVertical` - 是否垂直翻转图像(默认为 true
**返回:** `bool` - 成功返回 true失败返回 false
**示例:**
```cpp
OpenGLTexture texture;
if (texture.LoadFromFile("assets/textures/brick.jpg", true)) {
texture.GenerateMipmap();
}
```
## 相关文档
- [OpenGLTexture](texture.md) - 返回类总览

View File

@@ -0,0 +1,21 @@
# OpenGLTexture::SetFiltering
```cpp
void SetFiltering(int minFilter, int magFilter)
```
设置纹理过滤模式。
**参数:**
- `minFilter` - 缩小过滤模式GL_NEAREST, GL_LINEAR, GL_NEAREST_MIPMAP_NEAREST 等)
- `magFilter` - 放大过滤模式GL_NEAREST, GL_LINEAR
**示例:**
```cpp
texture.SetFiltering(GL_LINEAR_MIPMAP_LINEAR, GL_LINEAR);
```
## 相关文档
- [OpenGLTexture](texture.md) - 返回类总览

View File

@@ -0,0 +1,22 @@
# OpenGLTexture::SetWrapping
```cpp
void SetWrapping(int wrapS, int wrapT, int wrapR = -1)
```
设置纹理环绕模式。
**参数:**
- `wrapS` - S 轴环绕模式GL_REPEAT, GL_CLAMP_TO_EDGE 等)
- `wrapT` - T 轴环绕模式
- `wrapR` - R 轴环绕模式(默认为 -1表示与 wrapT 相同)
**示例:**
```cpp
texture.SetWrapping(GL_REPEAT, GL_REPEAT, GL_REPEAT);
```
## 相关文档
- [OpenGLTexture](texture.md) - 返回类总览

View File

@@ -0,0 +1,39 @@
# OpenGLTexture
**命名空间**: `XCEngine::RHI`
**描述**: OpenGL 纹理的实现,继承自 `RHITexture`
## 公共方法
| 方法 | 描述 |
|------|------|
| [`Initialize`](initialize-2d.md) | 初始化 2D 纹理 |
| [`Initialize2D`](initialize-2d.md) | 初始化 2D 纹理 |
| [`InitializeCubeMap`](initialize-cube-map.md) | 初始化立方体贴图 |
| [`LoadFromFile`](load-from-file.md) | 从文件加载纹理 |
| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭纹理 |
| [`Bind`](bind-image.md) | 绑定纹理 |
| [`Unbind`](../../shader/unbind.md) | 解绑纹理 |
| [`BindImage`](bind-image.md) | 绑定图像 |
| [`GenerateMipmap`](generate-mipmap.md) | 生成多级渐远纹理 |
| [`SetFiltering`](set-filtering.md) | 设置过滤模式 |
| [`SetWrapping`](set-wrapping.md) | 设置环绕模式 |
| [`GetID`](get-id.md) | 获取 OpenGL 纹理 ID |
| [`GetOpenGLType`](get-opengl-type.md) | 获取 OpenGL 纹理类型 |
| [`GetWidth`](../../texture/get-width.md) | 获取纹理宽度 |
| [`GetHeight`](../../texture/get-height.md) | 获取纹理高度 |
| [`GetDepth`](../../texture/get-depth.md) | 获取纹理深度 |
| [`GetMipLevels`](../../texture/get-mip-levels.md) | 获取 Mip 级别 |
| [`GetTextureType`](../../texture/get-texture-type.md) | 获取纹理类型 |
| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 |
| [`GetState`](../../buffer/get-state.md) | 获取资源状态 |
| [`SetState`](../../buffer/set-state.md) | 设置资源状态 |
| [`GetName`](../../buffer/get-name.md) | 获取资源名称 |
| [`SetName`](../../buffer/set-name.md) | 设置资源名称 |
| [`GetFormat`](../../texture/get-format.md) | 获取纹理格式 |
## 相关文档
- [OpenGL 后端总览](../overview.md)
- [RHITexture](../../texture/texture.md) - 抽象纹理接口