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:
32
docs/api/rhi/device/create-buffer.md
Normal file
32
docs/api/rhi/device/create-buffer.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# RHIDevice::CreateBuffer
|
||||
|
||||
```cpp
|
||||
virtual RHIBuffer* CreateBuffer(const BufferDesc& desc) = 0;
|
||||
```
|
||||
|
||||
创建 GPU 缓冲区资源。
|
||||
|
||||
**参数:**
|
||||
- `desc` - 缓冲区描述符,包含大小、类型、标志等
|
||||
|
||||
**返回:** 新创建的缓冲区指针,失败返回 `nullptr`
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
BufferDesc bufferDesc;
|
||||
bufferDesc.size = sizeof(Vertex) * vertexCount;
|
||||
bufferDesc.stride = sizeof(Vertex);
|
||||
bufferDesc.bufferType = (uint32_t)BufferType::Vertex;
|
||||
bufferDesc.flags = 0;
|
||||
|
||||
RHIBuffer* vertexBuffer = device->CreateBuffer(bufferDesc);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIDevice 总览](device.md) - 返回类总览
|
||||
- [RHIBuffer](../buffer/buffer.md) - 缓冲区类
|
||||
- [BufferDesc](../types/types.md) - 缓冲区描述结构体
|
||||
Reference in New Issue
Block a user