docs: update resources API docs
This commit is contained in:
@@ -4,6 +4,8 @@
|
||||
|
||||
**类型**: `class` (abstract)
|
||||
|
||||
**头文件**: `XCEngine/Resources/IResource.h`
|
||||
|
||||
**描述**: 资源基类接口,所有具体资源类型(Texture、Mesh、Material 等)都必须继承自此类。
|
||||
|
||||
## 概述
|
||||
@@ -14,25 +16,24 @@
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| `ResourceType GetType() const` | 获取资源类型 |
|
||||
| `const Containers::String& GetName() const` | 获取资源名称 |
|
||||
| `const Containers::String& GetPath() const` | 获取资源路径 |
|
||||
| `ResourceGUID GetGUID() const` | 获取全局唯一标识符 |
|
||||
| `bool IsValid() const` | 检查资源是否有效 |
|
||||
| `size_t GetMemorySize() const` | 获取资源占用的内存大小(字节) |
|
||||
| `void Release()` | 释放资源引用 |
|
||||
| `void Initialize(const ConstructParams& params)` | 使用构造参数初始化资源 |
|
||||
| `void SetInvalid()` | 将资源标记为无效 |
|
||||
| [`GetType()`](gettype.md) | 获取资源类型 |
|
||||
| [`GetName()`](getname.md) | 获取资源名称 |
|
||||
| [`GetPath()`](getpath.md) | 获取资源路径 |
|
||||
| [`GetGUID()`](getguid.md) | 获取全局唯一标识符 |
|
||||
| [`IsValid()`](isvalid.md) | 检查资源是否有效 |
|
||||
| [`GetMemorySize()`](getmemorysize.md) | 获取资源占用的内存大小(字节) |
|
||||
| [`Release()`](release.md) | 释放资源引用 |
|
||||
| [`Initialize()`](initialize.md) | 使用构造参数初始化资源 |
|
||||
| [`SetInvalid()`](setinvalid.md) | 将资源标记为无效 |
|
||||
|
||||
### 构造参数
|
||||
### 构造参数结构体 `ConstructParams`
|
||||
|
||||
| 成员 | 类型 | 描述 |
|
||||
|------|------|------|
|
||||
| `m_name` | `Containers::String` | 资源名称 |
|
||||
| `m_path` | `Containers::String` | 资源路径 |
|
||||
| `m_guid` | `ResourceGUID` | 全局唯一标识符 |
|
||||
| `m_isValid` | `bool` | 资源是否有效 |
|
||||
| `m_memorySize` | `size_t` | 内存占用大小 |
|
||||
| `name` | `Containers::String` | 资源名称 |
|
||||
| `path` | `Containers::String` | 资源路径 |
|
||||
| `guid` | `ResourceGUID` | 全局唯一标识符 |
|
||||
| `memorySize` | `size_t` | 内存占用大小(字节),默认 0 |
|
||||
|
||||
## 使用示例
|
||||
|
||||
@@ -51,7 +52,4 @@ public:
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [ResourceHandle](../resourcehandle/resourcehandle.md) - 资源句柄
|
||||
- [ResourceManager](../resourcemanager/resourcemanager.md) - 资源管理器
|
||||
- [ResourceTypes](../resourcetypes/resourcetypes.md) - 资源类型定义
|
||||
- [Resources 总览](../resources.md) - 返回模块总览
|
||||
|
||||
Reference in New Issue
Block a user