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 个断裂引用
2026-03-19 00:22:30 +08:00
|
|
|
# OpenGLDevice
|
|
|
|
|
|
|
|
|
|
**命名空间**: `XCEngine::RHI`
|
|
|
|
|
|
|
|
|
|
**描述**: OpenGL 设备的实现，继承自 `RHIDevice`。
|
|
|
|
|
|
|
|
|
|
## 方法列表
|
|
|
|
|
|
|
|
|
|
| 方法 | 文档 |
|
|
|
|
|
|------|------|
|
Fix RHI documentation discrepancies and add missing doc files
Fixed incorrect links in OpenGL documentation:
- Fixed wrong links to threading/task-system docs for Initialize/Shutdown methods
- Fixed wrong links to buffer docs for GetNativeHandle methods
- Fixed wrong links to shader docs for Bind/Unbind methods
- Fixed wrong links to command-list docs for Clear/Reset/Close methods
- Fixed wrong links to buffer/get-size.md for width/height methods
Added missing documentation files:
- OpenGL buffer: bind.md, unbind.md, get-type.md, initialize.md
- OpenGL fence: initialize.md, reset.md
- OpenGL swap-chain: get-size.md, initialize.md
- OpenGL render-target-view: initialize.md, shutdown.md, bind.md, unbind.md, clear.md, get-size.md
- OpenGL depth-stencil-view: initialize.md, shutdown.md, bind.md, unbind.md, get-size.md
- OpenGL command-list: clear.md
All links validated with fix_links.py - no broken references.
2026-03-19 00:54:54 +08:00
|
|
|
| `Initialize` | [详细文档](../../device/initialize.md) |
|
|
|
|
|
| `Shutdown` | [详细文档](../../device/shutdown.md) |
|
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 个断裂引用
2026-03-19 00:22:30 +08:00
|
|
|
| `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) |
|
Fix RHI documentation discrepancies and add missing doc files
Fixed incorrect links in OpenGL documentation:
- Fixed wrong links to threading/task-system docs for Initialize/Shutdown methods
- Fixed wrong links to buffer docs for GetNativeHandle methods
- Fixed wrong links to shader docs for Bind/Unbind methods
- Fixed wrong links to command-list docs for Clear/Reset/Close methods
- Fixed wrong links to buffer/get-size.md for width/height methods
Added missing documentation files:
- OpenGL buffer: bind.md, unbind.md, get-type.md, initialize.md
- OpenGL fence: initialize.md, reset.md
- OpenGL swap-chain: get-size.md, initialize.md
- OpenGL render-target-view: initialize.md, shutdown.md, bind.md, unbind.md, clear.md, get-size.md
- OpenGL depth-stencil-view: initialize.md, shutdown.md, bind.md, unbind.md, get-size.md
- OpenGL command-list: clear.md
All links validated with fix_links.py - no broken references.
2026-03-19 00:54:54 +08:00
|
|
|
| `GetNativeHandle` | [详细文档](../../swap-chain/get-native-handle.md) |
|
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 个断裂引用
2026-03-19 00:22:30 +08:00
|
|
|
|
|
|
|
|
## 相关文档
|
|
|
|
|
|
|
|
|
|
- [OpenGL 后端总览](../overview.md)
|
|
|
|
|
- [RHIDevice](../../device/device.md) - 抽象设备接口
|
