docs: update resources API docs

This commit is contained in:
2026-03-20 02:35:35 +08:00
parent fd792b7df1
commit ea756c0177
314 changed files with 9439 additions and 1360 deletions

View File

@@ -6,32 +6,39 @@ bool Create(Core::uint32 width, Core::uint32 height, Core::uint32 depth,
const void* data, size_t dataSize)
```
创建纹理资源。设置纹理的尺寸、格式和像素数据,并分配 GPU 资源
创建纹理资源。设置纹理的尺寸、格式和像素数据。
**参数:**
- `width` - 纹理宽度(像素)
- `height` - 纹理高度(像素)
- `depth` - 纹理深度3D 纹理设为 1
- `mipLevels` - Mipmap 级别数
- `type` - 纹理类型
- `format` - 纹理格式
- `data` - 像素数据指针
- `dataSize` - 像素数据大小
| 参数 | 类型 | 描述 |
|------|------|------|
| `width` | `Core::uint32` | 纹理宽度(像素) |
| `height` | `Core::uint32` | 纹理高度(像素) |
| `depth` | `Core::uint32` | 纹理深度3D 纹理设为 1 |
| `mipLevels` | `Core::uint32` | Mipmap 级别数 |
| `type` | `TextureType` | 纹理类型 |
| `format` | `TextureFormat` | 纹理格式 |
| `data` | `const void*` | 像素数据指针(可为 nullptr |
| `dataSize` | `size_t` | 像素数据大小 |
**返回:** 创建成功返回 true
**复杂度:** O(n)n 为像素数
**复杂度:** O(n)n 为像素数据大小
**示例:**
```cpp
Texture tex;
bool ok = tex.Create(
1024, 1024, 1, 0,
1024, 1024, 1, 1,
TextureType::Texture2D,
TextureFormat::RGBA8_UNORM,
pixelData, pixelDataSize
);
if (ok) {
// 纹理创建成功
}
```
## 相关文档