docs: update resources API docs
This commit is contained in:
36
docs/api/resources/shader-loader/methods/can-load.md
Normal file
36
docs/api/resources/shader-loader/methods/can-load.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# ShaderLoader::CanLoad
|
||||
|
||||
## 方法签名
|
||||
|
||||
```cpp
|
||||
bool CanLoad(const Containers::String& path) const override;
|
||||
```
|
||||
|
||||
## 详细描述
|
||||
|
||||
检查此加载器是否能加载指定路径的着色器文件。该方法通过获取文件扩展名并与支持列表进行匹配来判断。
|
||||
|
||||
## 参数
|
||||
|
||||
| 参数 | 类型 | 描述 |
|
||||
|------|------|------|
|
||||
| path | `const Containers::String&` | 文件路径 |
|
||||
|
||||
## 返回值
|
||||
|
||||
`bool` - 如果扩展名在支持列表中则返回 `true`,否则返回 `false`
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
#include "Resources/ShaderLoader.h"
|
||||
|
||||
using namespace XCEngine::Resources;
|
||||
|
||||
ShaderLoader loader;
|
||||
|
||||
bool canLoad1 = loader.CanLoad("shaders/pbr.vert"); // true
|
||||
bool canLoad2 = loader.CanLoad("shaders/pbr.frag"); // true
|
||||
bool canLoad3 = loader.CanLoad("shaders/pbr.hlsl"); // true
|
||||
bool canLoad4 = loader.CanLoad("textures/wood.png"); // false
|
||||
```
|
||||
Reference in New Issue
Block a user