docs: update memory and threading API docs
This commit is contained in:
33
docs/api/memory/pool-allocator/get-total-allocated.md
Normal file
33
docs/api/memory/pool-allocator/get-total-allocated.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# PoolAllocator::GetTotalAllocated
|
||||
|
||||
```cpp
|
||||
size_t GetTotalAllocated() const override;
|
||||
```
|
||||
|
||||
返回当前已分配的内存总量(字节)。计算公式:`(m_totalBlocks - m_freeBlocks) * m_blockSize`。
|
||||
|
||||
**参数:** 无
|
||||
|
||||
**返回:** 当前已分配块的字节数
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Memory/PoolAllocator.h>
|
||||
|
||||
PoolAllocator pool(sizeof(int), 100);
|
||||
|
||||
size_t allocated = pool.GetTotalAllocated(); // 0
|
||||
|
||||
void* block = pool.Allocate();
|
||||
allocated = pool.GetTotalAllocated(); // sizeof(int)
|
||||
|
||||
pool.Free(block);
|
||||
allocated = pool.GetTotalAllocated(); // 0
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [PoolAllocator 总览](pool-allocator.md) - 返回类总览
|
||||
Reference in New Issue
Block a user