docs: 重构 API 文档结构并修正源码准确性

- 重组文档目录结构: 每个模块的概述页移动到模块子目录
- 重命名 index.md 为 main.md
- 修正所有模块文档中的错误:
  - math: FromEuler→FromEulerAngles, TransformDirection 包含缩放, Box 是 OBB, Color::ToRGBA 格式
  - containers: 新增 operator==/!= 文档, 补充 std::hash DJB 算法细节
  - core: 修复 types 链接错误
  - debug: LogLevelToString 返回大写, timestamp 是秒, Profiler 空实现标注, Windows API vs ANSI
  - memory: 修复头文件路径, malloc vs operator new, 新增方法文档
  - resources: 修复 Shader/Texture 链接错误
  - threading: TaskSystem::Wait 空实现标注, ReadWriteLock 重入描述, LambdaTask 链接
- 验证: fix_links.py 确认 0 个断裂引用
This commit is contained in:
2026-03-19 00:22:30 +08:00
parent d0e16962c8
commit dc850d7739
1012 changed files with 26673 additions and 9222 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,34 @@
# OpenGLBuffer
**命名空间**: `XCEngine::RHI`
**描述**: OpenGL 缓冲区的实现,继承自 `RHIBuffer`
## 方法列表
| 方法 | 文档 |
|------|------|
| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) |
| `InitializeVertexBuffer` | [详细文档](initialize-vertex-buffer.md) |
| `InitializeIndexBuffer` | [详细文档](initialize-index-buffer.md) |
| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) |
| `Bind` | [详细文档](../../shader/bind.md) |
| `Unbind` | [详细文档](../../shader/unbind.md) |
| `BindBase` | [详细文档](bind-base.md) |
| `Map` | [详细文档](../../buffer/map.md) |
| `Unmap` | [详细文档](../../buffer/unmap.md) |
| `SetData` | [详细文档](../../buffer/set-data.md) |
| `GetID` | [详细文档](get-id.md) |
| `GetSize` | [详细文档](../../buffer/get-size.md) |
| `GetType` | [详细文档](../../shader/get-type.md) |
| `IsDynamic` | [详细文档](is-dynamic.md) |
| `GetBufferType` / `SetBufferType` | [详细文档](../../buffer/get-buffer-type.md) |
| `GetStride` / `SetStride` | [详细文档](../../buffer/get-stride.md) |
| `GetNativeHandle` | [详细文档](../../buffer/get-native-handle.md) |
| `GetState` / `SetState` | [详细文档](../../buffer/get-state.md) |
| `GetName` / `SetName` | [详细文档](../../buffer/get-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,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,24 @@
# OpenGLBuffer::IsDynamic
```cpp
bool IsDynamic() const
```
判断缓冲区是否为动态缓冲区。
**返回:** 如果是动态缓冲区返回 true
**示例:**
```cpp
if (buffer.IsDynamic()) {
// 动态缓冲区可以直接 Map/Unmap
void* data = buffer.Map();
// ...
buffer.Unmap();
}
```
## 相关文档
- [OpenGLBuffer](buffer.md) - 返回类总览