docs: update memory and threading API docs
This commit is contained in:
@@ -4,6 +4,8 @@
|
||||
|
||||
**类型**: `class`
|
||||
|
||||
**头文件**: `XCEngine/Memory/PoolAllocator.h`
|
||||
|
||||
**描述**: 内存池分配器,预分配固定大小的内存块池。
|
||||
|
||||
## 概述
|
||||
@@ -14,15 +16,20 @@
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| `PoolAllocator` | 构造内存池分配器 |
|
||||
| `~PoolAllocator` | 析构函数,释放整个内存池 |
|
||||
| `Allocate` | 分配一个内存块 |
|
||||
| `Free` | 释放内存块回空闲链表 |
|
||||
| `Reallocate` | 不支持(始终返回 nullptr) |
|
||||
| `Contains` | 检查指针是否属于此池 |
|
||||
| `GetBlockSize` | 获取块大小 |
|
||||
| `GetFreeBlockCount` | 获取空闲块数量 |
|
||||
| `GetTotalBlockCount` | 获取总块数 |
|
||||
| [`PoolAllocator`](constructor.md) | 构造内存池分配器 |
|
||||
| [`~PoolAllocator`](~pool-allocator.md) | 析构函数,释放整个内存池 |
|
||||
| [`Allocate`](allocate.md) | 分配一个内存块 |
|
||||
| [`Free`](free.md) | 释放内存块回空闲链表 |
|
||||
| [`Reallocate`](reallocate.md) | 不支持(始终返回 nullptr) |
|
||||
| [`Contains`](contains.md) | 检查指针是否属于此池 |
|
||||
| [`GetBlockSize`](get-block-size.md) | 获取块大小 |
|
||||
| [`GetFreeBlockCount`](get-free-block-count.md) | 获取空闲块数量 |
|
||||
| [`GetTotalBlockCount`](get-total-block-count.md) | 获取总块数 |
|
||||
| [`GetName`](get-name.md) | 获取分配器名称 |
|
||||
| [`GetTotalAllocated`](get-total-allocated.md) | 获取当前已分配内存 |
|
||||
| [`GetTotalFreed`](get-total-freed.md) | 获取当前空闲内存 |
|
||||
| [`GetPeakAllocated`](get-peak-allocated.md) | 获取峰值分配内存 |
|
||||
| [`GetAllocationCount`](get-allocation-count.md) | 获取当前分配块数量 |
|
||||
|
||||
## 构造函数
|
||||
|
||||
|
||||
Reference in New Issue
Block a user