87 lines
2.8 KiB
Markdown
87 lines
2.8 KiB
Markdown
# RHIBuffer
|
|
|
|
**命名空间**: `XCEngine::RHI`
|
|
|
|
**类型**: `class` (abstract)
|
|
|
|
**描述**: GPU 缓冲区资源抽象接口，用于管理顶点缓冲、索引缓冲、常量缓冲等 GPU 内存资源。
|
|
|
|
## 概述
|
|
|
|
`RHIBuffer` 封装了 GPU 缓冲区的创建、数据上传、状态管理等操作。支持多种缓冲区类型，包括顶点缓冲、索引缓冲、常量缓冲等。
|
|
|
|
## 公共方法
|
|
|
|
| 方法 | 描述 |
|
|
|------|------|
|
|
| [`Map`](map.md) | 映射缓冲区到 CPU 可访问内存 |
|
|
| [`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`](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` | 深度读取 |
|
|
| `NonPixelShaderResource` | 非像素着色器资源 |
|
|
| `PixelShaderResource` | 像素着色器资源 |
|
|
| `CopySrc` | 复制源 |
|
|
| `CopyDst` | 复制目标 |
|
|
| `Present` | 呈现状态 |
|
|
| `GenericRead` | 通用读取 |
|
|
|
|
## 使用示例
|
|
|
|
```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) - 命令列表
|