xuanchi/XCEngine
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
b46d450429af1713d70b36d5d94f5bf94913c700
XCEngine/docs/api/rhi/opengl/buffer/buffer.md

35 lines
1.4 KiB
Markdown
Raw Normal View History

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
# OpenGLBuffer
**命名空间**: `XCEngine::RHI`
**描述**: OpenGL 缓冲区的实现，继承自 `RHIBuffer`。
## 方法列表
| 方法 | 文档 |
|------|------|
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` | [详细文档](initialize.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
| `InitializeVertexBuffer` | [详细文档](initialize-vertex-buffer.md) |
| `InitializeIndexBuffer` | [详细文档](initialize-index-buffer.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
| `Shutdown` | [详细文档](../../buffer/shutdown.md) |
| `Bind` | [详细文档](bind.md) |
| `Unbind` | [详细文档](unbind.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
| `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) |
Fix RHI documentation discrepancies Fixed the following issues: - command-list.md: Shutdown linked to threading/task-system instead of local shutdown.md - fence.md: Wait linked to threading/task-group instead of local wait.md - factory/create-rhi-device-string.md: Claimed Vulkan/Metal support but source doesn't support them - opengl/buffer/buffer.md: GetType linked to command-queue/get-type (wrong type) - d3d12/device/device.md: Initialize/Shutdown linked to threading/task-system - d3d12/command-list/command-list.md: Initialize/Shutdown/Reset/Close/Clear linked to wrong docs - d3d12/texture/texture.md: Initialize/Shutdown linked to threading/task-system - opengl/command-list/command-list.md: Shutdown linked to threading/task-system - opengl/device/device.md: GetNativeHandle incorrectly linked to get-window.md All links validated with fix_links.py - no broken references remaining.
2026-03-19 01:23:10 +08:00
| `GetType` | [详细文档](get-type.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
| `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) - 抽象缓冲区接口
Reference in New Issue Copy Permalink