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

@@ -0,0 +1,23 @@
# IResourceLoader::GetResourceType
```cpp
virtual ResourceType GetResourceType() const = 0
```
获取此加载器所支持的资源类型。纯虚方法,子类必须实现。
**参数:**
**返回:** `ResourceType` 枚举值,标识资源类型(如 `ResourceType::Texture``ResourceType::Mesh` 等)
**示例:**
```cpp
ResourceType TextureLoader::GetResourceType() const {
return ResourceType::Texture;
}
```
## 相关文档
- [IResourceLoader 总览](iloader.md) - 返回类总览

View File

@@ -4,6 +4,8 @@
**类型**: `class` (abstract)
**头文件**: `XCEngine/Resources/ILoader.h`
**描述**: 资源加载器抽象接口,定义了资源加载的标准协议。每个资源类型需要提供对应的加载器实现。
## 概述
@@ -34,22 +36,22 @@ struct LoadResult {
| 方法 | 描述 |
|------|------|
| `ResourceType GetResourceType() const` | 获取此加载器支持的资源类型 |
| `Containers::Array<Containers::String> GetSupportedExtensions() const` | 获取支持的文件扩展名列表 |
| `bool CanLoad(const Containers::String& path) const` | 检查此加载器是否能加载指定路径 |
| `ImportSettings* GetDefaultSettings() const` | 获取默认导入设置 |
| [`GetResourceType`](getresourcetype.md) | 获取此加载器支持的资源类型 |
| [`GetSupportedExtensions`](getsupportedextensions.md) | 获取支持的文件扩展名列表 |
| [`CanLoad`](canload.md) | 检查此加载器是否能加载指定路径 |
| [`GetDefaultSettings`](getdefaultsettings.md) | 获取默认导入设置 |
### 同步加载
| 方法 | 描述 |
|------|------|
| `LoadResult Load(const Containers::String& path, const ImportSettings* settings = nullptr)` | 同步加载资源 |
| [`Load`](load.md) | 同步加载资源 |
### 异步加载
| 方法 | 描述 |
|------|------|
| `void LoadAsync(const Containers::String& path, const ImportSettings* settings, std::function<void(LoadResult)> callback)` | 异步加载资源(内部默认实现调用同步 Load |
| [`LoadAsync`](loadasync.md) | 异步加载资源(默认实现,子类可重写 |
### 辅助方法(受保护)