docs: rebuild Memory API content
This commit is contained in:
@@ -1,30 +1,31 @@
|
||||
# PoolAllocator::GetTotalAllocated
|
||||
|
||||
获取相关状态或对象。
|
||||
查询当前已用字节数。
|
||||
|
||||
```cpp
|
||||
size_t GetTotalAllocated() const override;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Memory/PoolAllocator.h`,当前页面用于固定 `PoolAllocator` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `size_t` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
当前头文件内联实现返回:
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Memory/PoolAllocator.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Memory::PoolAllocator object;
|
||||
// 根据上下文补齐参数后调用 PoolAllocator::GetTotalAllocated(...)。
|
||||
(void)object;
|
||||
}
|
||||
(m_totalBlocks - m_freeBlocks) * m_blockSize
|
||||
```
|
||||
|
||||
因此它表示的是“当前正在使用的逻辑字节数”,而不是累计分配过多少字节。
|
||||
|
||||
## 返回值
|
||||
|
||||
- `size_t` - 当前已用逻辑字节数。
|
||||
|
||||
## 注意事项
|
||||
|
||||
- 这里按 `m_blockSize` 计费,不按对齐后的实际 stride 计费。
|
||||
- 如果 `m_freeBlocks` 因错误释放被破坏,这个值也会失真。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](PoolAllocator.md)
|
||||
- [返回模块目录](../Memory.md)
|
||||
- [返回类型总览](PoolAllocator.md)
|
||||
- [GetTotalFreed](GetTotalFreed.md)
|
||||
|
||||
Reference in New Issue
Block a user