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,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,37 @@
# OpenGLTexture
**命名空间**: `XCEngine::RHI`
**描述**: OpenGL 纹理的实现,继承自 `RHITexture`
## 方法列表
| 方法 | 文档 |
|------|------|
| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) |
| `Initialize2D` | [详细文档](initialize-2d.md) |
| `InitializeCubeMap` | [详细文档](initialize-cube-map.md) |
| `LoadFromFile` | [详细文档](load-from-file.md) |
| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) |
| `Bind` | [详细文档](../../shader/bind.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) |
| `GetOpenGLType` | [详细文档](get-opengl-type.md) |
| `GetWidth` | [详细文档](../../texture/get-width.md) |
| `GetHeight` | [详细文档](../../texture/get-height.md) |
| `GetDepth` | [详细文档](../../texture/get-depth.md) |
| `GetMipLevels` | [详细文档](../../texture/get-mip-levels.md) |
| `GetTextureType` | [详细文档](../../texture/get-texture-type.md) |
| `GetNativeHandle` | [详细文档](../../buffer/get-native-handle.md) |
| `GetState` / `SetState` | [详细文档](../../buffer/get-state.md) |
| `GetName` / `SetName` | [详细文档](../../buffer/get-name.md) |
| `GetFormat` / `SetFormat` | [详细文档](../../texture/get-format.md) |
## 相关文档
- [OpenGL 后端总览](../overview.md)
- [RHITexture](../../texture/texture.md) - 抽象纹理接口