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:
45
docs/api/math/frustum/frustum.md
Normal file
45
docs/api/math/frustum/frustum.md
Normal file
@@ -0,0 +1,45 @@
|
||||
# Frustum
|
||||
|
||||
视锥体,用于视锥剔除。
|
||||
|
||||
**头文件:** `#include <XCEngine/Math/Frustum.h>`
|
||||
|
||||
**命名空间:** `XCEngine::Math`
|
||||
|
||||
## 类定义
|
||||
|
||||
```cpp
|
||||
class Frustum {
|
||||
public:
|
||||
Plane planes[6];
|
||||
|
||||
enum class PlaneIndex {
|
||||
Left = 0,
|
||||
Right = 1,
|
||||
Bottom = 2,
|
||||
Top = 3,
|
||||
Near = 4,
|
||||
Far = 5
|
||||
};
|
||||
|
||||
bool Contains(const Vector3& point) const;
|
||||
bool Contains(const Sphere& sphere) const;
|
||||
bool Contains(const Bounds& bounds) const;
|
||||
bool Intersects(const Bounds& bounds) const;
|
||||
bool Intersects(const Sphere& sphere) const;
|
||||
};
|
||||
```
|
||||
|
||||
## 实例方法
|
||||
|
||||
| 方法 | 返回值 | 描述 |
|
||||
|------|--------|------|
|
||||
| [Contains(point)](contains-point.md) | `bool` | 点是否在视锥内 |
|
||||
| [Contains(sphere)](contains-sphere.md) | `bool` | 球体是否完全在视锥内 |
|
||||
| [Contains(bounds)](contains-bounds.md) | `bool` | Bounds 是否完全在视锥内 |
|
||||
| [Intersects(bounds)](intersects-bounds.md) | `bool` | Bounds 是否与视锥相交 |
|
||||
| [Intersects(sphere)](intersects-sphere.md) | `bool` | 球体是否与视锥相交 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Math 模块总览](../math.md) - 返回 Math 模块总览
|
||||
Reference in New Issue
Block a user