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:
105
docs/api/rhi/buffer/buffer.md
Normal file
105
docs/api/rhi/buffer/buffer.md
Normal file
@@ -0,0 +1,105 @@
|
||||
# RHIBuffer
|
||||
|
||||
**命名空间**: `XCEngine::RHI`
|
||||
|
||||
**类型**: `class` (abstract)
|
||||
|
||||
**描述**: GPU 缓冲区资源抽象接口,用于管理顶点缓冲、索引缓冲、常量缓冲等 GPU 内存资源。
|
||||
|
||||
## 概述
|
||||
|
||||
`RHIBuffer` 封装了 GPU 缓冲区的创建、数据上传、状态管理等操作。支持多种缓冲区类型,包括顶点缓冲、索引缓冲、常量缓冲等。
|
||||
|
||||
## 公共方法
|
||||
|
||||
### 数据操作
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `Map` | [详细文档](map.md) |
|
||||
| `Unmap` | [详细文档](unmap.md) |
|
||||
| `SetData` | [详细文档](set-data.md) |
|
||||
|
||||
### 属性访问
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `GetSize` | [详细文档](get-size.md) |
|
||||
| `GetBufferType` | [详细文档](get-buffer-type.md) |
|
||||
| `SetBufferType` | [详细文档](set-buffer-type.md) |
|
||||
| `GetStride` | [详细文档](get-stride.md) |
|
||||
| `SetStride` | [详细文档](set-stride.md) |
|
||||
|
||||
### 状态管理
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `GetState` | [详细文档](get-state.md) |
|
||||
| `SetState` | [详细文档](set-state.md) |
|
||||
|
||||
### 生命周期
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `Shutdown` | [详细文档](../../threading/task-system/shutdown.md) |
|
||||
|
||||
### 其他
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `GetNativeHandle` | [详细文档](get-native-handle.md) |
|
||||
| `GetName` | [详细文档](get-name.md) |
|
||||
| `SetName` | [详细文档](set-name.md) |
|
||||
|
||||
## 缓冲区类型 (BufferType)
|
||||
|
||||
| 枚举值 | 描述 |
|
||||
|--------|------|
|
||||
| `BufferType::Vertex` | 顶点缓冲 |
|
||||
| `BufferType::Index` | 索引缓冲 |
|
||||
| `BufferType::Constant` | 常量缓冲 (Constant Buffer) |
|
||||
| `BufferType::ReadBack` | 回读缓冲(用于 CPU 读取 GPU 数据) |
|
||||
| `BufferType::Indirect` | 间接执行缓冲 |
|
||||
| `BufferType::RaytracingAccelerationStructure` | 光线追踪加速结构 |
|
||||
| `BufferType::ShaderBindingTable` | 光线追踪着色器绑定表 |
|
||||
|
||||
## 资源状态 (ResourceStates)
|
||||
|
||||
| 状态 | 描述 |
|
||||
|------|------|
|
||||
| `Common` | 默认状态 |
|
||||
| `VertexAndConstantBuffer` | 顶点/常量缓冲 |
|
||||
| `IndexBuffer` | 索引缓冲 |
|
||||
| `RenderTarget` | 渲染目标 |
|
||||
| `UnorderedAccess` | 无序访问 |
|
||||
| `DepthWrite` | 深度写入 |
|
||||
| `DepthRead` | 深度读取 |
|
||||
| `CopySrc` | 复制源 |
|
||||
| `CopyDst` | 复制目标 |
|
||||
| `Present` | 呈现状态 |
|
||||
|
||||
## 使用示例
|
||||
|
||||
```cpp
|
||||
BufferDesc desc;
|
||||
desc.size = sizeof(Vertex) * vertexCount;
|
||||
desc.stride = sizeof(Vertex);
|
||||
desc.bufferType = (uint32_t)BufferType::Vertex;
|
||||
desc.flags = 0;
|
||||
|
||||
RHIBuffer* vertexBuffer = device->CreateBuffer(desc);
|
||||
|
||||
void* mapped = vertexBuffer->Map();
|
||||
memcpy(mapped, vertexData, desc.size);
|
||||
vertexBuffer->Unmap();
|
||||
|
||||
vertexBuffer->SetState(ResourceStates::VertexAndConstantBuffer);
|
||||
vertexBuffer->Shutdown();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [../rhi/rhi.md](../rhi.md) - RHI 模块总览
|
||||
- [RHIDevice](../device/device.md) - 创建设备
|
||||
- [RHITexture](../texture/texture.md) - 纹理资源
|
||||
- [RHICommandList](../command-list/command-list.md) - 命令列表
|
||||
15
docs/api/rhi/buffer/get-buffer-type.md
Normal file
15
docs/api/rhi/buffer/get-buffer-type.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# RHIBuffer::GetBufferType
|
||||
|
||||
```cpp
|
||||
virtual BufferType GetBufferType() const = 0;
|
||||
```
|
||||
|
||||
获取缓冲区类型。
|
||||
|
||||
**返回:** 缓冲区类型枚举值
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIBuffer 总览](buffer.md) - 返回类总览
|
||||
15
docs/api/rhi/buffer/get-name.md
Normal file
15
docs/api/rhi/buffer/get-name.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# RHIBuffer::GetName
|
||||
|
||||
```cpp
|
||||
virtual const std::string& GetName() const = 0;
|
||||
```
|
||||
|
||||
获取缓冲区名称(用于调试)。
|
||||
|
||||
**返回:** 缓冲区名称
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIBuffer 总览](buffer.md) - 返回类总览
|
||||
17
docs/api/rhi/buffer/get-native-handle.md
Normal file
17
docs/api/rhi/buffer/get-native-handle.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# RHIBuffer::GetNativeHandle
|
||||
|
||||
```cpp
|
||||
virtual void* GetNativeHandle() = 0;
|
||||
```
|
||||
|
||||
获取原生 API 句柄。
|
||||
|
||||
**返回:**
|
||||
- D3D12: `ID3D12Resource*`
|
||||
- OpenGL: `GLuint` 指针
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIBuffer 总览](buffer.md) - 返回类总览
|
||||
15
docs/api/rhi/buffer/get-size.md
Normal file
15
docs/api/rhi/buffer/get-size.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# RHIBuffer::GetSize
|
||||
|
||||
```cpp
|
||||
virtual uint64_t GetSize() const = 0;
|
||||
```
|
||||
|
||||
获取缓冲区大小(字节)。
|
||||
|
||||
**返回:** 缓冲区大小
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIBuffer 总览](buffer.md) - 返回类总览
|
||||
15
docs/api/rhi/buffer/get-state.md
Normal file
15
docs/api/rhi/buffer/get-state.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# RHIBuffer::GetState
|
||||
|
||||
```cpp
|
||||
virtual ResourceStates GetState() const = 0;
|
||||
```
|
||||
|
||||
获取当前资源状态。
|
||||
|
||||
**返回:** 资源状态枚举值
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIBuffer 总览](buffer.md) - 返回类总览
|
||||
15
docs/api/rhi/buffer/get-stride.md
Normal file
15
docs/api/rhi/buffer/get-stride.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# RHIBuffer::GetStride
|
||||
|
||||
```cpp
|
||||
virtual uint32_t GetStride() const = 0;
|
||||
```
|
||||
|
||||
获取单个元素的字节大小。
|
||||
|
||||
**返回:** 元素步长(字节)
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIBuffer 总览](buffer.md) - 返回类总览
|
||||
25
docs/api/rhi/buffer/map.md
Normal file
25
docs/api/rhi/buffer/map.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# RHIBuffer::Map
|
||||
|
||||
```cpp
|
||||
virtual void* Map() = 0;
|
||||
```
|
||||
|
||||
映射缓冲区内存到 CPU 可访问空间。
|
||||
|
||||
**返回:** 指向缓冲区数据的指针
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
void* data = buffer->Map();
|
||||
if (data) {
|
||||
memcpy(data, vertexData, bufferSize);
|
||||
buffer->Unmap();
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIBuffer 总览](buffer.md) - 返回类总览
|
||||
16
docs/api/rhi/buffer/set-buffer-type.md
Normal file
16
docs/api/rhi/buffer/set-buffer-type.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# RHIBuffer::SetBufferType
|
||||
|
||||
```cpp
|
||||
virtual void SetBufferType(BufferType type) = 0;
|
||||
```
|
||||
|
||||
设置缓冲区类型。
|
||||
|
||||
**参数:**
|
||||
- `type` - 新的缓冲区类型
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIBuffer 总览](buffer.md) - 返回类总览
|
||||
29
docs/api/rhi/buffer/set-data.md
Normal file
29
docs/api/rhi/buffer/set-data.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# RHIBuffer::SetData
|
||||
|
||||
```cpp
|
||||
virtual void SetData(const void* data, size_t size, size_t offset = 0) = 0;
|
||||
```
|
||||
|
||||
设置缓冲区数据。
|
||||
|
||||
**参数:**
|
||||
- `data` - 源数据指针
|
||||
- `size` - 数据大小(字节)
|
||||
- `offset` - 缓冲区内的偏移量
|
||||
|
||||
**复杂度:** O(n)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
Vertex vertices[] = {
|
||||
{0.0f, 0.5f, 0.0f},
|
||||
{0.5f, -0.5f, 0.0f},
|
||||
{-0.5f, -0.5f, 0.0f}
|
||||
};
|
||||
buffer->SetData(vertices, sizeof(vertices), 0);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIBuffer 总览](buffer.md) - 返回类总览
|
||||
22
docs/api/rhi/buffer/set-name.md
Normal file
22
docs/api/rhi/buffer/set-name.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# RHIBuffer::SetName
|
||||
|
||||
```cpp
|
||||
virtual void SetName(const std::string& name) = 0;
|
||||
```
|
||||
|
||||
设置缓冲区名称(用于调试)。
|
||||
|
||||
**参数:**
|
||||
- `name` - 新名称
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
buffer->SetName("VertexBuffer_Main");
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIBuffer 总览](buffer.md) - 返回类总览
|
||||
22
docs/api/rhi/buffer/set-state.md
Normal file
22
docs/api/rhi/buffer/set-state.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# RHIBuffer::SetState
|
||||
|
||||
```cpp
|
||||
virtual void SetState(ResourceStates state) = 0;
|
||||
```
|
||||
|
||||
设置资源状态。
|
||||
|
||||
**参数:**
|
||||
- `state` - 新的资源状态
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
buffer->SetState(ResourceStates::VertexAndConstantBuffer);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIBuffer 总览](buffer.md) - 返回类总览
|
||||
16
docs/api/rhi/buffer/set-stride.md
Normal file
16
docs/api/rhi/buffer/set-stride.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# RHIBuffer::SetStride
|
||||
|
||||
```cpp
|
||||
virtual void SetStride(uint32_t stride) = 0;
|
||||
```
|
||||
|
||||
设置元素字节大小。
|
||||
|
||||
**参数:**
|
||||
- `stride` - 新的步长值
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIBuffer 总览](buffer.md) - 返回类总览
|
||||
13
docs/api/rhi/buffer/shutdown.md
Normal file
13
docs/api/rhi/buffer/shutdown.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# RHIBuffer::Shutdown
|
||||
|
||||
```cpp
|
||||
virtual void Shutdown() = 0;
|
||||
```
|
||||
|
||||
释放缓冲区资源。
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIBuffer 总览](buffer.md) - 返回类总览
|
||||
21
docs/api/rhi/buffer/unmap.md
Normal file
21
docs/api/rhi/buffer/unmap.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# RHIBuffer::Unmap
|
||||
|
||||
```cpp
|
||||
virtual void Unmap() = 0;
|
||||
```
|
||||
|
||||
取消内存映射。
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
buffer->Map();
|
||||
memcpy(mappedData, sourceData, size);
|
||||
buffer->Unmap();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIBuffer 总览](buffer.md) - 返回类总览
|
||||
Reference in New Issue
Block a user