docs: rebuild Memory API content
This commit is contained in:
@@ -1,30 +1,36 @@
|
||||
# ProxyAllocator::ProxyAllocator()
|
||||
# ProxyAllocator::Constructor
|
||||
|
||||
构造对象。
|
||||
构造一个代理分配器。
|
||||
|
||||
```cpp
|
||||
ProxyAllocator(IAllocator* underlying, const char* name);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Memory/ProxyAllocator.h`,当前页面用于固定 `ProxyAllocator` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:**
|
||||
- `underlying` - 参数语义详见头文件声明。
|
||||
- `name` - 参数语义详见头文件声明。
|
||||
当前构造函数只做成员保存:
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
- `m_underlying = underlying`
|
||||
- `m_name = name`
|
||||
|
||||
**示例:**
|
||||
它不会复制名称字符串,也不会接管底层分配器所有权。
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Memory/ProxyAllocator.h>
|
||||
## 参数
|
||||
|
||||
void Example() {
|
||||
XCEngine::Memory::ProxyAllocator object;
|
||||
}
|
||||
```
|
||||
- `underlying` - 被代理的底层分配器。
|
||||
- `name` - 代理名称。
|
||||
|
||||
## 返回值
|
||||
|
||||
- 无。
|
||||
|
||||
## 当前实现限制
|
||||
|
||||
- 不校验 `underlying` 是否为空。
|
||||
- 不复制 `name` 内容,只保存原始指针。
|
||||
- 调用方必须保证底层分配器和名称字符串在 `ProxyAllocator` 生命周期内保持有效。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](ProxyAllocator.md)
|
||||
- [返回模块目录](../Memory.md)
|
||||
- [返回类型总览](ProxyAllocator.md)
|
||||
- [GetName](GetName.md)
|
||||
|
||||
Reference in New Issue
Block a user