docs: update resources API docs
This commit is contained in:
44
docs/api/resources/mesh/is-valid.md
Normal file
44
docs/api/resources/mesh/is-valid.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# Mesh::IsValid
|
||||
|
||||
```cpp
|
||||
bool IsValid() const override;
|
||||
```
|
||||
|
||||
检查网格资源是否有效。资源在调用 `Initialize` 后变为有效,调用 `SetInvalid` 或 `Release` 后变为无效。
|
||||
|
||||
**参数:** 无
|
||||
|
||||
**返回:** `bool` - 资源是否有效
|
||||
|
||||
**异常:** 无
|
||||
|
||||
**线程安全:** ✅
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include "XCEngine/Resources/Mesh.h"
|
||||
|
||||
using namespace XCEngine::Resources;
|
||||
|
||||
Mesh mesh;
|
||||
if (!mesh.IsValid()) {
|
||||
// 资源尚未初始化
|
||||
}
|
||||
|
||||
IResource::ConstructParams params;
|
||||
params.name = "Cube";
|
||||
params.path = "assets/meshes/cube.mesh";
|
||||
params.guid = ResourceGUID::Generate(params.path);
|
||||
mesh.Initialize(params);
|
||||
|
||||
if (mesh.IsValid()) {
|
||||
// 资源已初始化
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [类总览](mesh.md) - 返回类总览
|
||||
Reference in New Issue
Block a user