docs: rebuild Memory API content
This commit is contained in:
@@ -1,30 +1,27 @@
|
||||
# ProxyAllocator::GetTotalAllocated
|
||||
|
||||
获取相关状态或对象。
|
||||
查询累计分配字节数。
|
||||
|
||||
```cpp
|
||||
size_t GetTotalAllocated() const override;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Memory/ProxyAllocator.h`,当前页面用于固定 `ProxyAllocator` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:** 无。
|
||||
当前头文件内联实现直接返回 `m_stats.totalAllocated`。
|
||||
|
||||
**返回:** `size_t` - 返回值语义详见头文件声明。
|
||||
这个字段在 [Allocate](Allocate.md) 成功时按“请求大小”累加,不会向底层分配器反查真实消耗。
|
||||
|
||||
**示例:**
|
||||
## 返回值
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Memory/ProxyAllocator.h>
|
||||
- `size_t` - 代理层记录的累计请求字节数。
|
||||
|
||||
void Example() {
|
||||
XCEngine::Memory::ProxyAllocator object;
|
||||
// 根据上下文补齐参数后调用 ProxyAllocator::GetTotalAllocated(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
## 注意事项
|
||||
|
||||
- 这不是底层分配器的精确字节记账。
|
||||
- 当前读取路径没有加锁,更适合在受控快照点使用。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](ProxyAllocator.md)
|
||||
- [返回模块目录](../Memory.md)
|
||||
- [返回类型总览](ProxyAllocator.md)
|
||||
- [GetTotalFreed](GetTotalFreed.md)
|
||||
|
||||
Reference in New Issue
Block a user