docs: rebuild Memory API content
This commit is contained in:
@@ -1,30 +1,31 @@
|
||||
# MemoryManager::Shutdown
|
||||
|
||||
关闭并清理内部状态。
|
||||
关闭内存管理器并销毁内部系统分配器。
|
||||
|
||||
```cpp
|
||||
void Shutdown();
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Memory/MemoryManager.h`,当前页面用于固定 `MemoryManager` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:** 无。
|
||||
当前实现也是幂等的:
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
1. 如果 `m_initialized` 为 `false`,直接返回。
|
||||
2. 否则执行 `delete static_cast<SystemAllocator*>(m_systemAllocator);`
|
||||
3. 把 `m_systemAllocator` 置空,并把 `m_initialized` 设为 `false`。
|
||||
|
||||
**示例:**
|
||||
## 返回值
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Memory/MemoryManager.h>
|
||||
- 无。
|
||||
|
||||
void Example() {
|
||||
XCEngine::Memory::MemoryManager object;
|
||||
// 根据上下文补齐参数后调用 MemoryManager::Shutdown(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
## 当前实现限制
|
||||
|
||||
- 不会自动销毁通过工厂方法创建的其它分配器对象。
|
||||
- 不会检查是否还有未释放对象或未完成的泄漏跟踪。
|
||||
- 如果仍有依赖系统分配器的 `LinearAllocator` 或 `ProxyAllocator` 存活,后续使用或析构都可能访问悬空指针。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](MemoryManager.md)
|
||||
- [返回模块目录](../Memory.md)
|
||||
- [返回类型总览](MemoryManager.md)
|
||||
- [Initialize](Initialize.md)
|
||||
- [GetSystemAllocator](GetSystemAllocator.md)
|
||||
|
||||
Reference in New Issue
Block a user