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 个断裂引用
2026-03-19 00:22:30 +08:00
|
|
|
# Viewport
|
|
|
|
|
|
|
|
|
|
渲染视口结构体,用于屏幕到归一化坐标的映射。
|
|
|
|
|
|
|
|
|
|
**头文件:** `#include <XCEngine/Math/Rect.h>`
|
|
|
|
|
|
|
|
|
|
**命名空间:** `XCEngine::Math`
|
|
|
|
|
|
|
|
|
|
## 结构体定义
|
|
|
|
|
|
|
|
|
|
```cpp
|
|
|
|
|
struct Viewport {
|
|
|
|
|
float x = 0.0f;
|
|
|
|
|
float y = 0.0f;
|
|
|
|
|
float width = 0.0f;
|
|
|
|
|
float height = 0.0f;
|
|
|
|
|
float minDepth = 0.0f;
|
|
|
|
|
float maxDepth = 1.0f;
|
|
|
|
|
|
|
|
|
|
Viewport() = default;
|
|
|
|
|
Viewport(float x, float y, float w, float h);
|
|
|
|
|
Viewport(float x, float y, float w, float h, float minD, float maxD);
|
|
|
|
|
};
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## 构造函数
|
|
|
|
|
|
|
|
|
|
| 方法 | 描述 |
|
|
|
|
|
|------|------|
|
|
|
|
|
| `Viewport()` | 默认构造 |
|
|
|
|
|
| `Viewport(x, y, w, h)` | 2D 视口 |
|
|
|
|
|
| `Viewport(x, y, w, h, minD, maxD)` | 带深度范围的 3D 视口 |
|
|
|
|
|
|
|
|
|
|
## 方法
|
|
|
|
|
|
|
|
|
|
| 方法 | 返回值 | 描述 |
|
|
|
|
|
|------|--------|------|
|
|
|
|
|
| [GetAspectRatio()](viewport-getaspectratio.md) | `float` | 宽高比 (width / height) |
|
|
|
|
|
| [GetRect()](viewport-getrect.md) | `Rect` | 转换为 Rect |
|
|
|
|
|
|
|
|
|
|
## 相关文档
|
|
|
|
|
|
2026-03-20 02:35:15 +08:00
|
|
|
- [Math 模块总览](../math.md) - 返回 Math 模块总览
|
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 个断裂引用
2026-03-19 00:22:30 +08:00
|
|
|
- [Rect](rect-overview.md) - 浮点矩形
|
|
|
|
|
- [RectInt](rectint.md) - 整数矩形
|