docs: rebuild Memory API content

This commit is contained in:
2026-03-26 18:02:29 +08:00
parent ce2eee32e3
commit dc252502ac
66 changed files with 1182 additions and 1066 deletions

View File

@@ -1,30 +1,31 @@
# ProxyAllocator::GetPeakAllocated
获取相关状态或对象
查询峰值净分配量
```cpp
size_t GetPeakAllocated() const override;
```
该方法声明于 `XCEngine/Memory/ProxyAllocator.h`,当前页面用于固定 `ProxyAllocator` 类目录下的方法级 canonical 路径。
## 行为说明
**参数:**
当前头文件内联实现直接返回 `m_stats.peakAllocated`
**返回:** `size_t` - 返回值语义详见头文件声明。
**示例:**
这个字段只会在 [Allocate](Allocate.md) 成功时更新,更新依据是:
```cpp
#include <XCEngine/Memory/ProxyAllocator.h>
void Example() {
XCEngine::Memory::ProxyAllocator object;
// 根据上下文补齐参数后调用 ProxyAllocator::GetPeakAllocated(...)。
(void)object;
}
m_stats.totalAllocated - m_stats.totalFreed
```
## 返回值
- `size_t` - 代理层记录的峰值净分配量。
## 注意事项
- 由于 `totalFreed` 的统计当前有缺陷,这里的峰值也可能失真。
- [Reallocate](Reallocate.md) 不更新统计,因此大缓冲重分配不会反映到峰值里。
## 相关文档
- [返回类总览](ProxyAllocator.md)
- [返回模块目录](../Memory.md)
- [返回类总览](ProxyAllocator.md)
- [GetTotalAllocated](GetTotalAllocated.md)