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

@@ -4,6 +4,8 @@
**类型**: `class`
**头文件**: `XCEngine/Resources/Shader.h`
**描述**: 着色器资源类,管理着色器源码、编译后的二进制和 uniform/attribute 信息。
## 概述
@@ -71,17 +73,27 @@ Uniform 变量描述。
| 方法 | 描述 |
|------|------|
| `Shader()` | 默认构造函数 |
| `virtual ~Shader()` | 析构函数 |
| `ResourceType GetType() const` | 返回 `ResourceType::Shader` |
| `const Containers::String& GetName() const` | 获取着色器名称 |
| `const Containers::String& GetPath() const` | 获取着色器路径 |
| `ResourceGUID GetGUID() const` | 获取全局唯一标识符 |
| `bool IsValid() const` | 检查着色器是否有效 |
| `size_t GetMemorySize() const` | 获取内存大小 |
| `void Release()` | 释放着色器引用 |
| `void Release()` | 释放着色器资源 |
## 实现说明
### Release 详细说明
**注意**: `ShaderLoader::DetectShaderType()` 对于非标准扩展名始终返回 `ShaderType::Fragment``ShaderLoader::ParseShaderSource()` 为 stub始终返回 true。
`Release()` 方法释放 Shader 实例持有的所有资源,包括:
- 清空源码字符串 (`m_sourceCode`)
- 清空编译后的二进制数据 (`m_compiledBinary`)
- 清空 Uniform 列表 (`m_uniforms`)
- 清空 Attribute 列表 (`m_attributes`)
- 释放 RHI 着色器资源指针 (`m_rhiResource`)
-`m_isValid` 标记为 `false`
调用此方法后Shader 对象回到无效状态,可被 ResourceManager 回收。
### 类型与语言