docs: 重构 API 文档结构并修正源码准确性

- 重组文档目录结构: 每个模块的概述页移动到模块子目录
- 重命名 index.md 为 main.md
- 修正所有模块文档中的错误:
  - math: FromEuler→FromEulerAngles, TransformDirection 包含缩放, Box 是 OBB, Color::ToRGBA 格式
  - containers: 新增 operator==/!= 文档, 补充 std::hash DJB 算法细节
  - core: 修复 types 链接错误
  - debug: LogLevelToString 返回大写, timestamp 是秒, Profiler 空实现标注, Windows API vs ANSI
  - memory: 修复头文件路径, malloc vs operator new, 新增方法文档
  - resources: 修复 Shader/Texture 链接错误
  - threading: TaskSystem::Wait 空实现标注, ReadWriteLock 重入描述, LambdaTask 链接
- 验证: fix_links.py 确认 0 个断裂引用
This commit is contained in:
2026-03-19 00:22:30 +08:00
parent d0e16962c8
commit dc850d7739
1012 changed files with 26673 additions and 9222 deletions

View File

@@ -0,0 +1,37 @@
# LinearAllocator::Clear
```cpp
void Clear();
```
清空分配器,将内部偏移量重置为 0所有已分配的内存被视为已释放。下一次 `Allocate` 将从缓冲区起始位置开始。此方法不实际释放或修改底层内存,适合作为帧分配器使用,每帧开始时调用 Clear 重置。
**参数:**
**返回:**
**复杂度:** O(1)
**示例:**
```cpp
#include <XCEngine/Memory/LinearAllocator.h>
LinearAllocator allocator(1024 * 1024);
// 第一帧
void* frame1_ptr = allocator.Allocate(256);
void* frame1_ptr2 = allocator.Allocate(128);
// ... 第一帧渲染逻辑
// 帧结束时清空
allocator.Clear();
// 第二帧重新开始
void* frame2_ptr = allocator.Allocate(256);
// 此时 frame1_ptr 已无效,但内存已被回收复用
```
## 相关文档
- [LinearAllocator 总览](linear-allocator.md) - 返回类总览