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
|
|
|
# RHISwapChain
|
|
|
|
|
|
|
|
|
|
**命名空间**: `XCEngine::RHI`
|
|
|
|
|
|
|
|
|
|
**类型**: `class` (abstract)
|
|
|
|
|
|
|
|
|
|
**描述**: GPU 交换链抽象接口,用于管理窗口渲染和帧缓冲区切换。
|
|
|
|
|
|
|
|
|
|
## 公共方法
|
|
|
|
|
|
|
|
|
|
### 生命周期
|
|
|
|
|
|
|
|
|
|
| 方法 | 文档 |
|
|
|
|
|
|------|------|
|
2026-03-19 00:31:14 +08:00
|
|
|
| `Shutdown` | [详细文档](shutdown.md) |
|
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
|
|
|
|
|
|
|
|
### 交换链操作
|
|
|
|
|
|
|
|
|
|
| 方法 | 文档 |
|
|
|
|
|
|------|------|
|
|
|
|
|
| `GetCurrentBackBufferIndex` | [详细文档](get-current-back-buffer-index.md) |
|
|
|
|
|
| `GetCurrentBackBuffer` | [详细文档](get-current-back-buffer.md) |
|
|
|
|
|
| `Present` | [详细文档](present.md) |
|
2026-03-19 00:31:14 +08:00
|
|
|
| `Resize` | [详细文档](methods.md) |
|
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
|
|
|
|
|
|
|
|
### 全屏模式
|
|
|
|
|
|
|
|
|
|
| 方法 | 文档 |
|
|
|
|
|
|------|------|
|
|
|
|
|
| `SetFullscreen` | [详细文档](set-fullscreen.md) |
|
|
|
|
|
| `IsFullscreen` | [详细文档](is-fullscreen.md) |
|
|
|
|
|
|
|
|
|
|
### 窗口事件
|
|
|
|
|
|
|
|
|
|
| 方法 | 文档 |
|
|
|
|
|
|------|------|
|
|
|
|
|
| `ShouldClose` | [详细文档](should-close.md) |
|
|
|
|
|
| `SetShouldClose` | [详细文档](set-should-close.md) |
|
|
|
|
|
| `PollEvents` | [详细文档](poll-events.md) |
|
|
|
|
|
|
|
|
|
|
### 其他
|
|
|
|
|
|
|
|
|
|
| 方法 | 文档 |
|
|
|
|
|
|------|------|
|
2026-03-19 00:31:14 +08:00
|
|
|
| `GetNativeHandle` | [详细文档](get-native-handle.md) |
|
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
|
|
|
|
|
|
|
|
## 使用示例
|
|
|
|
|
|
|
|
|
|
```cpp
|
|
|
|
|
while (!swapChain->ShouldClose()) {
|
|
|
|
|
swapChain->PollEvents();
|
|
|
|
|
RHITexture* backBuffer = swapChain->GetCurrentBackBuffer();
|
|
|
|
|
commandList->Reset();
|
|
|
|
|
commandList->SetRenderTargets(1, &backBuffer, nullptr);
|
|
|
|
|
commandList->ClearRenderTarget(backBuffer, clearColor);
|
|
|
|
|
commandList->Close();
|
|
|
|
|
commandQueue->ExecuteCommandLists(1, (void**)&commandList);
|
|
|
|
|
swapChain->Present(1, 0);
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## 相关文档
|
|
|
|
|
|
|
|
|
|
- [../rhi/rhi.md](../rhi.md) - RHI 模块总览
|
|
|
|
|
- [RHITexture](../texture/texture.md) - 纹理资源
|