docs: update resources API docs
This commit is contained in:
45
docs/api/resources/resource-package/getsize.md
Normal file
45
docs/api/resources/resource-package/getsize.md
Normal file
@@ -0,0 +1,45 @@
|
||||
# GetSize
|
||||
|
||||
获取资源包中指定文件的原始大小。
|
||||
|
||||
## 方法签名
|
||||
|
||||
```cpp
|
||||
size_t GetSize(const Containers::String& relativePath) const;
|
||||
```
|
||||
|
||||
## 详细描述
|
||||
|
||||
返回指定文件压缩前的大小(字节数)。如果文件不存在于包中,返回 0。
|
||||
|
||||
## 参数
|
||||
|
||||
| 参数名 | 类型 | 描述 |
|
||||
|--------|------|------|
|
||||
| `relativePath` | `const Containers::String&` | 文件的相对路径 |
|
||||
|
||||
## 返回值
|
||||
|
||||
| 类型 | 描述 |
|
||||
|------|------|
|
||||
| `size_t` | 文件大小(字节),文件不存在时返回 0 |
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
ResourcePackage package;
|
||||
package.Open("assets/resources.xcp");
|
||||
|
||||
size_t size = package.GetSize("textures/player.png");
|
||||
if (size > 0) {
|
||||
printf("Player texture size: %zu bytes\n", size);
|
||||
|
||||
// 可以用来预分配缓冲区
|
||||
Array<uint8> buffer(size);
|
||||
}
|
||||
```
|
||||
|
||||
## 相关方法
|
||||
|
||||
- [Read](read.md) - 读取文件内容
|
||||
- [Exists](exists.md) - 检查文件存在
|
||||
Reference in New Issue
Block a user