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:
34
docs/api/rhi/opengl/buffer/buffer.md
Normal file
34
docs/api/rhi/opengl/buffer/buffer.md
Normal 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) - 抽象缓冲区接口
|
||||
Reference in New Issue
Block a user