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,28 @@
# OpenGLDevice::CreateRenderWindow
```cpp
bool CreateRenderWindow(int width, int height, const char* title, bool enableDebug = false)
```
创建并初始化一个新的 GLFW 窗口,同时初始化 OpenGL 上下文。
**参数:**
- `width` - 窗口宽度(像素)
- `height` - 窗口高度(像素)
- `title` - 窗口标题
- `enableDebug` - 是否启用 OpenGL 调试上下文(可选,默认为 false
**返回:** `bool` - 成功返回 true失败返回 false
**示例:**
```cpp
OpenGLDevice device;
if (device.CreateRenderWindow(1280, 720, "XCEngine", false)) {
// 窗口创建成功,可以开始渲染循环
}
```
## 相关文档
- [OpenGLDevice](device.md) - 返回类总览

View File

@@ -0,0 +1,37 @@
# OpenGLDevice
**命名空间**: `XCEngine::RHI`
**描述**: OpenGL 设备的实现,继承自 `RHIDevice`
## 方法列表
| 方法 | 文档 |
|------|------|
| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) |
| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) |
| `CreateRenderWindow` | [详细文档](create-render-window.md) |
| `InitializeWithExistingWindow` | [详细文档](initialize-with-existing-window.md) |
| `GetWindow` | [详细文档](get-window.md) |
| `SwapBuffers` | [详细文档](swap-buffers.md) |
| `PollEvents` | [详细文档](poll-events.md) |
| `SetShouldClose` | [详细文档](set-should-close.md) |
| `ShouldClose` | [详细文档](should-close.md) |
| `CreateBuffer` | [详细文档](../../device/create-buffer.md) |
| `CreateTexture` | [详细文档](../../device/create-texture.md) |
| `CreateSwapChain` | [详细文档](../../device/create-swap-chain.md) |
| `CreateCommandList` | [详细文档](../../device/create-command-list.md) |
| `CreateCommandQueue` | [详细文档](../../device/create-command-queue.md) |
| `CompileShader` | [详细文档](../../device/compile-shader.md) |
| `CreatePipelineState` | [详细文档](../../device/create-pipeline-state.md) |
| `CreateFence` | [详细文档](../../device/create-fence.md) |
| `CreateSampler` | [详细文档](../../device/create-sampler.md) |
| `GetCapabilities` | [详细文档](../../device/get-capabilities.md) |
| `GetDeviceInfo` | [详细文档](../../device/get-device-info.md) |
| `GetNativeDevice` | [详细文档](../../device/get-native-device.md) |
| `GetNativeHandle` | [详细文档](../../buffer/get-native-handle.md) |
## 相关文档
- [OpenGL 后端总览](../overview.md)
- [RHIDevice](../../device/device.md) - 抽象设备接口

View File

@@ -0,0 +1,22 @@
# OpenGLDevice::GetWindow
```cpp
GLFWwindow* GetWindow() const
```
获取关联的 GLFW 窗口指针。
**返回:** `GLFWwindow*` - GLFW 窗口指针
**示例:**
```cpp
GLFWwindow* window = device.GetWindow();
if (window) {
glfwSetWindowTitle(window, "New Title");
}
```
## 相关文档
- [OpenGLDevice](device.md) - 返回类总览

View File

@@ -0,0 +1,26 @@
# OpenGLDevice::InitializeWithExistingWindow
```cpp
bool InitializeWithExistingWindow(GLFWwindow* window)
```
使用已有的 GLFW 窗口初始化 OpenGL 设备,不会创建新窗口或管理窗口生命周期。
**参数:**
- `window` - 已存在的 GLFWwindow 指针
**返回:** `bool` - 成功返回 true失败返回 false
**示例:**
```cpp
GLFWwindow* existingWindow = glfwCreateWindow(1280, 720, "Existing", nullptr, nullptr);
OpenGLDevice device;
if (device.InitializeWithExistingWindow(existingWindow)) {
// 使用已有窗口初始化设备
}
```
## 相关文档
- [OpenGLDevice](device.md) - 返回类总览

View File

@@ -0,0 +1,23 @@
# OpenGLDevice::PollEvents
```cpp
bool PollEvents()
```
处理所有挂起的 GLFW 事件(窗口事件、输入事件等)。
**返回:** `bool` - 如果窗口应保持打开返回 true如果窗口应关闭返回 false
**示例:**
```cpp
while (device.PollEvents()) {
// 渲染和交换缓冲区
renderScene();
device.SwapBuffers();
}
```
## 相关文档
- [OpenGLDevice](device.md) - 返回类总览

View File

@@ -0,0 +1,20 @@
# OpenGLDevice::SetShouldClose
```cpp
void SetShouldClose(bool shouldClose)
```
设置窗口是否应该关闭的标志。
**参数:**
- `shouldClose` - true 表示窗口应该关闭false 表示保持打开
**示例:**
```cpp
device.SetShouldClose(true); // 请求关闭窗口
```
## 相关文档
- [OpenGLDevice](device.md) - 返回类总览

View File

@@ -0,0 +1,23 @@
# OpenGLDevice::ShouldClose
```cpp
bool ShouldClose() const
```
检查窗口是否应该关闭。
**返回:** `bool` - 如果窗口应该关闭返回 true否则返回 false
**示例:**
```cpp
while (!device.ShouldClose()) {
device.PollEvents();
renderScene();
device.SwapBuffers();
}
```
## 相关文档
- [OpenGLDevice](device.md) - 返回类总览

View File

@@ -0,0 +1,19 @@
# OpenGLDevice::SwapBuffers
```cpp
void SwapBuffers()
```
交换前后缓冲区,将渲染内容显示到屏幕上。
**示例:**
```cpp
// 渲染完成后交换缓冲区
renderScene();
device.SwapBuffers();
```
## 相关文档
- [OpenGLDevice](device.md) - 返回类总览