docs: rebuild Memory API content
This commit is contained in:
@@ -1,30 +1,25 @@
|
||||
# ProxyAllocator::GetAllocationCount
|
||||
|
||||
获取相关状态或对象。
|
||||
查询当前统计中的分配计数。
|
||||
|
||||
```cpp
|
||||
size_t GetAllocationCount() const override;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Memory/ProxyAllocator.h`,当前页面用于固定 `ProxyAllocator` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:** 无。
|
||||
当前头文件内联实现直接返回 `m_stats.allocationCount`。
|
||||
|
||||
**返回:** `size_t` - 返回值语义详见头文件声明。
|
||||
## 返回值
|
||||
|
||||
**示例:**
|
||||
- `size_t` - 代理内部记录的分配计数。
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Memory/ProxyAllocator.h>
|
||||
## 注意事项
|
||||
|
||||
void Example() {
|
||||
XCEngine::Memory::ProxyAllocator object;
|
||||
// 根据上下文补齐参数后调用 ProxyAllocator::GetAllocationCount(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 这不是底层分配器的权威状态,而是代理层自己的统计字段。
|
||||
- 由于 [Free](Free.md) 可能发生下溢、[Reallocate](Reallocate.md) 又不调整统计,这个值不应被当作严格可信的实时分配数。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](ProxyAllocator.md)
|
||||
- [返回模块目录](../Memory.md)
|
||||
- [返回类型总览](ProxyAllocator.md)
|
||||
- [GetStats](GetStats.md)
|
||||
|
||||
Reference in New Issue
Block a user