docs: rebuild Memory API content
This commit is contained in:
@@ -1,30 +1,34 @@
|
||||
# ProxyAllocator::GetStats
|
||||
|
||||
获取相关状态或对象。
|
||||
读取完整统计结构。
|
||||
|
||||
```cpp
|
||||
const Stats& GetStats() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Memory/ProxyAllocator.h`,当前页面用于固定 `ProxyAllocator` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:** 无。
|
||||
当前实现直接返回内部成员 `m_stats` 的常量引用,不会复制数据,也不会在读取时加锁。
|
||||
|
||||
**返回:** `const Stats&` - 返回值语义详见头文件声明。
|
||||
`Stats` 结构当前包含这些字段:
|
||||
|
||||
**示例:**
|
||||
- `totalAllocated`
|
||||
- `totalFreed`
|
||||
- `peakAllocated`
|
||||
- `allocationCount`
|
||||
- `memoryOverhead`
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Memory/ProxyAllocator.h>
|
||||
## 返回值
|
||||
|
||||
void Example() {
|
||||
XCEngine::Memory::ProxyAllocator object;
|
||||
// 根据上下文补齐参数后调用 ProxyAllocator::GetStats(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- `const Stats&` - 指向内部统计结构的只读引用。
|
||||
|
||||
## 注意事项
|
||||
|
||||
- 这是对内部状态的直接暴露,不适合在并发写入期间无保护读取。
|
||||
- `memoryOverhead` 字段当前始终保持默认值 `0`。
|
||||
- `totalFreed` 和由它推导出的字段目前不完全准确。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](ProxyAllocator.md)
|
||||
- [返回模块目录](../Memory.md)
|
||||
- [返回类型总览](ProxyAllocator.md)
|
||||
- [GetAllocationCount](GetAllocationCount.md)
|
||||
|
||||
Reference in New Issue
Block a user