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,21 @@
# OpenGLBuffer::BindBase
```cpp
void BindBase(unsigned int target, unsigned int index) const
```
将缓冲区绑定到固定的 binding point。
**参数:**
- `target` - OpenGL target (如 GL_ARRAY_BUFFER, GL_ELEMENT_ARRAY_BUFFER)
- `index` - binding point 索引
**示例:**
```cpp
buffer.BindBase(GL_UNIFORM_BUFFER, 0);
```
## 相关文档
- [OpenGLBuffer](buffer.md) - 返回类总览

View File

@@ -0,0 +1,17 @@
# OpenGLBuffer::Bind
```cpp
void Bind() const;
```
绑定缓冲区到 OpenGL 目标。
**示例:**
```cpp
buffer.Bind();
```
## 相关文档
- [OpenGLBuffer 总览](buffer.md) - 返回类总览

View File

@@ -0,0 +1,38 @@
# OpenGLBuffer
**命名空间**: `XCEngine::RHI`
**描述**: OpenGL 缓冲区的实现,继承自 `RHIBuffer`
## 公共方法
| 方法 | 描述 |
|------|------|
| [`Initialize`](initialize.md) | 初始化缓冲区 |
| [`InitializeVertexBuffer`](initialize-vertex-buffer.md) | 初始化顶点缓冲 |
| [`InitializeIndexBuffer`](initialize-index-buffer.md) | 初始化索引缓冲 |
| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭缓冲区 |
| [`Bind`](bind.md) | 绑定缓冲区 |
| [`Unbind`](unbind.md) | 解绑缓冲区 |
| [`BindBase`](bind-base.md) | 绑定到基准点 |
| [`Map`](../../buffer/map.md) | 映射缓冲区 |
| [`Unmap`](../../buffer/unmap.md) | 取消映射 |
| [`SetData`](../../buffer/set-data.md) | 设置数据 |
| [`GetID`](get-id.md) | 获取 OpenGL 缓冲 ID |
| [`GetSize`](../../buffer/get-size.md) | 获取缓冲区大小 |
| [`GetType`](get-type.md) | 获取缓冲区类型 |
| [`IsDynamic`](is-dynamic.md) | 检查是否动态 |
| [`GetBufferType`](../../buffer/get-buffer-type.md) | 获取缓冲区类型 |
| [`SetBufferType`](../../buffer/set-buffer-type.md) | 设置缓冲区类型 |
| [`GetStride`](../../buffer/get-stride.md) | 获取步长 |
| [`SetStride`](../../buffer/set-stride.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) | 设置资源名称 |
## 相关文档
- [OpenGL 后端总览](../overview.md)
- [RHIBuffer](../../buffer/buffer.md) - 抽象缓冲区接口

View File

@@ -0,0 +1,20 @@
# OpenGLBuffer::GetID
```cpp
unsigned int GetID() const
```
获取 OpenGL buffer 的 GLuint ID。
**返回:** OpenGL buffer ID
**示例:**
```cpp
unsigned int id = buffer.GetID();
glBindBuffer(GL_ARRAY_BUFFER, id);
```
## 相关文档
- [OpenGLBuffer](buffer.md) - 返回类总览

View File

@@ -0,0 +1,19 @@
# OpenGLBuffer::GetType
```cpp
OpenGLBufferType GetType() const;
```
获取缓冲区类型。
**返回:** OpenGL 缓冲区类型
**示例:**
```cpp
OpenGLBufferType type = buffer.GetType();
```
## 相关文档
- [OpenGLBuffer 总览](buffer.md) - 返回类总览

View File

@@ -0,0 +1,25 @@
# OpenGLBuffer::InitializeIndexBuffer
```cpp
bool InitializeIndexBuffer(const void* data, size_t size)
```
初始化索引缓冲区。
**参数:**
- `data` - 索引数据指针
- `size` - 数据大小(字节)
**返回:** 成功返回 true
**示例:**
```cpp
uint32_t indices[] = { 0, 1, 2 };
OpenGLBuffer buffer;
buffer.InitializeIndexBuffer(indices, sizeof(indices));
```
## 相关文档
- [OpenGLBuffer](buffer.md) - 返回类总览

View File

@@ -0,0 +1,25 @@
# OpenGLBuffer::InitializeVertexBuffer
```cpp
bool InitializeVertexBuffer(const void* data, size_t size)
```
初始化顶点缓冲区。
**参数:**
- `data` - 顶点数据指针
- `size` - 数据大小(字节)
**返回:** 成功返回 true
**示例:**
```cpp
float vertices[] = { 0.0f, 0.5f, 0.0f };
OpenGLBuffer buffer;
buffer.InitializeVertexBuffer(vertices, sizeof(vertices));
```
## 相关文档
- [OpenGLBuffer](buffer.md) - 返回类总览

View File

@@ -0,0 +1,26 @@
# OpenGLBuffer::Initialize
```cpp
bool Initialize(OpenGLBufferType type, size_t size, const void* data = nullptr, bool dynamic = false);
```
初始化 OpenGL 缓冲区。
**参数:**
- `type` - 缓冲区类型
- `size` - 缓冲区大小(字节)
- `data` - 初始数据指针(可选)
- `dynamic` - 是否为动态缓冲区
**返回:** 成功返回 true
**示例:**
```cpp
OpenGLBuffer buffer;
buffer.Initialize(OpenGLBufferType::Vertex, sizeof(vertices), vertices);
```
## 相关文档
- [OpenGLBuffer 总览](buffer.md) - 返回类总览

View File

@@ -0,0 +1,24 @@
# OpenGLBuffer::IsDynamic
```cpp
bool IsDynamic() const
```
判断缓冲区是否为动态缓冲区。
**返回:** 如果是动态缓冲区返回 true
**示例:**
```cpp
if (buffer.IsDynamic()) {
// 动态缓冲区可以直接 Map/Unmap
void* data = buffer.Map();
// ...
buffer.Unmap();
}
```
## 相关文档
- [OpenGLBuffer](buffer.md) - 返回类总览

View File

@@ -0,0 +1,17 @@
# OpenGLBuffer::Unbind
```cpp
void Unbind() const;
```
解除绑定缓冲区。
**示例:**
```cpp
buffer.Unbind();
```
## 相关文档
- [OpenGLBuffer 总览](buffer.md) - 返回类总览