docs: rebuild Memory API content
This commit is contained in:
@@ -1,30 +1,31 @@
|
||||
# PoolAllocator::GetTotalFreed
|
||||
|
||||
获取相关状态或对象。
|
||||
查询当前空闲字节数。
|
||||
|
||||
```cpp
|
||||
size_t GetTotalFreed() const override;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Memory/PoolAllocator.h`,当前页面用于固定 `PoolAllocator` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `size_t` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
当前头文件内联实现返回:
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Memory/PoolAllocator.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Memory::PoolAllocator object;
|
||||
// 根据上下文补齐参数后调用 PoolAllocator::GetTotalFreed(...)。
|
||||
(void)object;
|
||||
}
|
||||
m_freeBlocks * m_blockSize
|
||||
```
|
||||
|
||||
因此这个接口在 `PoolAllocator` 中表示的是“当前还空着多少逻辑字节”,不是“累计向系统释放了多少字节”。整个池在分配器存活期间始终保留在进程内存中,直到析构时才统一释放。
|
||||
|
||||
## 返回值
|
||||
|
||||
- `size_t` - 当前空闲逻辑字节数。
|
||||
|
||||
## 注意事项
|
||||
|
||||
- 这里同样不考虑对齐放大的真实 stride。
|
||||
- 如果发生错误释放,`m_freeBlocks` 失真,这里的统计也会随之失真。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](PoolAllocator.md)
|
||||
- [返回模块目录](../Memory.md)
|
||||
- [返回类型总览](PoolAllocator.md)
|
||||
- [GetTotalAllocated](GetTotalAllocated.md)
|
||||
|
||||
Reference in New Issue
Block a user