docs: update resources API docs
This commit is contained in:
36
docs/api/resources/mesh-loader/methods/can-load.md
Normal file
36
docs/api/resources/mesh-loader/methods/can-load.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# MeshLoader::CanLoad
|
||||
|
||||
## 方法签名
|
||||
|
||||
```cpp
|
||||
bool CanLoad(const Containers::String& path) const override;
|
||||
```
|
||||
|
||||
## 详细描述
|
||||
|
||||
检查给定路径的文件是否可以被该加载器加载。方法通过提取文件扩展名并转换为小写后进行匹配判断。支持的文件格式包括:fbx、obj、gltf、glb、dae、stl。
|
||||
|
||||
## 参数
|
||||
|
||||
| 参数 | 类型 | 描述 |
|
||||
|------|------|------|
|
||||
| path | `const Containers::String&` | 文件路径 |
|
||||
|
||||
## 返回值
|
||||
|
||||
`bool` - 如果文件扩展名在支持列表中返回 `true`,否则返回 `false`
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
#include "Resources/MeshLoader.h"
|
||||
|
||||
using namespace XCEngine::Resources;
|
||||
|
||||
MeshLoader loader;
|
||||
|
||||
bool canLoadFbx = loader.CanLoad("assets/models/player.fbx"); // true
|
||||
bool canLoadObj = loader.CanLoad("assets/models/cube.obj"); // true
|
||||
bool canLoadPng = loader.CanLoad("assets/textures/wood.png"); // false
|
||||
bool canLoadUnknown = loader.CanLoad("assets/data/model.xyz"); // false
|
||||
```
|
||||
Reference in New Issue
Block a user