docs: update resources API docs
This commit is contained in:
44
docs/api/resources/resource-file-system/shutdown.md
Normal file
44
docs/api/resources/resource-file-system/shutdown.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# ResourceFileSystem::Shutdown
|
||||
|
||||
## 方法签名
|
||||
|
||||
```cpp
|
||||
void Shutdown();
|
||||
```
|
||||
|
||||
## 所属类
|
||||
|
||||
`XCEngine::Resources::ResourceFileSystem`
|
||||
|
||||
## 描述
|
||||
|
||||
关闭资源文件系统,释放所有已分配的资源。此方法会清空所有已注册的档案和目录,清除资源信息缓存,并将根路径重置为空字符串。
|
||||
|
||||
此方法线程安全。
|
||||
|
||||
## 参数
|
||||
|
||||
无
|
||||
|
||||
## 返回值
|
||||
|
||||
无
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
#include "Resources/ResourceFileSystem.h"
|
||||
|
||||
using namespace XCEngine::Resources;
|
||||
|
||||
ResourceFileSystem& fs = ResourceFileSystem::Get();
|
||||
|
||||
// 程序结束时关闭资源系统
|
||||
fs.Shutdown();
|
||||
```
|
||||
|
||||
## 注意事项
|
||||
|
||||
- 应在程序退出前调用此方法
|
||||
- 调用后系统处于未初始化状态,需要重新调用 `Initialize()` 才能使用
|
||||
- 已打开的档案会被自动关闭
|
||||
Reference in New Issue
Block a user