docs: 更新 API 文档 - 多模块修复和完善
- audio: 更新 audio-system 方法文档 - components: 新增 audio-listener/audio-source 组件方法文档,新增 remove-component 方法 - core: 更新 filewriter, types 文档 - math: 更新 box 方法文档 - memory: 更新 proxy-allocator 文档 - resources: 更新 loader 和 texture 文档 - rhi: 更新 opengl 设备、shader、swap-chain 文档 - threading: 更新 mutex 和 task-system 文档
This commit is contained in:
37
docs/api/memory/proxy-allocator/~proxy-allocator.md
Normal file
37
docs/api/memory/proxy-allocator/~proxy-allocator.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# ProxyAllocator::~ProxyAllocator
|
||||
|
||||
```cpp
|
||||
~ProxyAllocator() override;
|
||||
```
|
||||
|
||||
销毁代理分配器。不会释放底层分配器的内存,只是停止统计并转发请求。
|
||||
|
||||
**参数:** 无
|
||||
|
||||
**返回:** 无
|
||||
|
||||
**注意:** 析构函数仅销毁代理对象本身,底层分配器需要由用户单独管理。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Memory/MemoryManager.h>
|
||||
#include <XCEngine/Memory/ProxyAllocator.h>
|
||||
|
||||
IAllocator* sysAlloc = MemoryManager::Get().GetSystemAllocator();
|
||||
|
||||
{
|
||||
ProxyAllocator proxy(sysAlloc, "ScopedAlloc");
|
||||
proxy.Allocate(1024);
|
||||
// 超出作用域时代理被销毁,但底层分配器仍在
|
||||
}
|
||||
|
||||
// 底层分配器仍可继续使用
|
||||
void* ptr = sysAlloc->Allocate(256);
|
||||
sysAlloc->Free(ptr);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [ProxyAllocator 总览](proxy-allocator.md) - 返回类总览
|
||||
- [`ProxyAllocator`](constructor.md) - 构造函数
|
||||
Reference in New Issue
Block a user