docs: update resources API docs
This commit is contained in:
50
docs/api/resources/resource-package/getinfo.md
Normal file
50
docs/api/resources/resource-package/getinfo.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# GetInfo
|
||||
|
||||
获取资源包的元信息。
|
||||
|
||||
## 方法签名
|
||||
|
||||
```cpp
|
||||
const PackageInfo& GetInfo() const;
|
||||
```
|
||||
|
||||
## 详细描述
|
||||
|
||||
返回资源包的元信息结构体引用,包含包的路径、版本号、文件数量和总大小等基本信息。
|
||||
|
||||
## 参数
|
||||
|
||||
无
|
||||
|
||||
## 返回值
|
||||
|
||||
| 类型 | 描述 |
|
||||
|------|------|
|
||||
| `const PackageInfo&` | PackageInfo 结构体引用,包含包的元信息 |
|
||||
|
||||
## PackageInfo 结构体
|
||||
|
||||
| 成员 | 类型 | 描述 |
|
||||
|------|------|------|
|
||||
| `path` | `Containers::String` | 包文件的完整路径 |
|
||||
| `version` | `Core::uint16` | 包文件格式版本号 |
|
||||
| `fileCount` | `size_t` | 包内包含的文件数量 |
|
||||
| `totalSize` | `size_t` | 包文件的总大小(字节) |
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
ResourcePackage package;
|
||||
package.Open("assets/resources.xcp");
|
||||
|
||||
const auto& info = package.GetInfo();
|
||||
printf("Package Path: %s\n", info.path.CStr());
|
||||
printf("Package Version: %u\n", info.version);
|
||||
printf("File Count: %zu\n", info.fileCount);
|
||||
printf("Total Size: %zu bytes\n", info.totalSize);
|
||||
```
|
||||
|
||||
## 相关方法
|
||||
|
||||
- [Open](open.md) - 打开资源包
|
||||
- [IsValid](isvalid.md) - 检查包有效性
|
||||
Reference in New Issue
Block a user