docs: rebuild Memory API content
This commit is contained in:
@@ -1,29 +1,29 @@
|
||||
# MemoryManager::Get
|
||||
|
||||
获取相关状态或对象。
|
||||
获取全局 `MemoryManager` 单例。
|
||||
|
||||
```cpp
|
||||
static MemoryManager& Get();
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Memory/MemoryManager.h`,当前页面用于固定 `MemoryManager` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `MemoryManager&` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
当前实现通过函数内静态对象返回进程级唯一实例:
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Memory/MemoryManager.h>
|
||||
|
||||
void Example() {
|
||||
auto& instance = XCEngine::Memory::MemoryManager::Get();
|
||||
(void)instance;
|
||||
}
|
||||
static MemoryManager instance;
|
||||
```
|
||||
|
||||
## 返回值
|
||||
|
||||
- `MemoryManager&` - 全局 `MemoryManager` 实例引用。
|
||||
|
||||
## 设计说明
|
||||
|
||||
- 这提供了一个集中入口,但不意味着所有分配器对象都被统一托管。
|
||||
- 通过工厂方法创建出来的分配器,生命周期仍由调用方负责。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](MemoryManager.md)
|
||||
- [返回模块目录](../Memory.md)
|
||||
- [返回类型总览](MemoryManager.md)
|
||||
- [Initialize](Initialize.md)
|
||||
|
||||
Reference in New Issue
Block a user