docs: update RHI API docs
This commit is contained in:
@@ -2,18 +2,33 @@
|
||||
|
||||
**命名空间**: `XCEngine::RHI`
|
||||
|
||||
**描述**: OpenGL 交换链实现,继承自 `RHISwapChain`。
|
||||
**类型**: `class`
|
||||
|
||||
**描述**: OpenGL 交换链实现,继承自 `RHISwapChain`。基于 GLFW 窗口管理,用于 OpenGL 渲染的帧缓冲交换。
|
||||
|
||||
## 概述
|
||||
|
||||
`OpenGLSwapChain` 是 OpenGL 后端的交换链实现,负责管理渲染目标帧缓冲的呈现。它继承自 `RHISwapChain` 抽象接口,通过 GLFW 窗口系统进行帧缓冲交换。
|
||||
|
||||
### 枚举类型
|
||||
|
||||
| 枚举 | 描述 |
|
||||
|------|------|
|
||||
| [`PresentMode`](present-mode.md) | 呈现模式(Immediate/VSync/Mailbox/Fifo) |
|
||||
| [`SurfaceFormat`](surface-format.md) | 表面格式(RGBA8/RGBA16F/RGBA32F/BGRA8) |
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`OpenGLSwapChain`](constructor.md) | 构造函数 |
|
||||
| [`~OpenGLSwapChain`](destructor.md) | 析构函数 |
|
||||
| [`Initialize`](initialize.md) | 初始化交换链 |
|
||||
| [`InitializeMode`](initialize-mode.md) | 使用模式初始化 |
|
||||
| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭交换链 |
|
||||
| [`Initialize(mode)`](initialize-mode.md) | 使用模式初始化 |
|
||||
| [`Shutdown`](shutdown.md) | 关闭交换链 |
|
||||
| [`Present`](present.md) | 呈现画面 |
|
||||
| [`SwapBuffers`](swap-buffers.md) | 交换缓冲 |
|
||||
| [`Resize`](../../swap-chain/resize.md) | 调整交换链大小 |
|
||||
| [`Resize`](resize.md) | 调整交换链大小 |
|
||||
| [`SetVSync`](set-vsync.md) | 设置垂直同步 |
|
||||
| [`IsVSync`](is-vsync.md) | 检查是否垂直同步 |
|
||||
| [`SetFullscreen`](set-fullscreen.md) | 设置全屏模式 |
|
||||
@@ -21,14 +36,39 @@
|
||||
| [`ShouldClose`](should-close.md) | 检查是否应关闭 |
|
||||
| [`SetShouldClose`](set-should-close.md) | 设置关闭标志 |
|
||||
| [`PollEvents`](poll-events.md) | 处理窗口事件 |
|
||||
| [`GetCurrentBackBufferIndex`](../../swap-chain/get-current-back-buffer-index.md) | 获取当前后台缓冲区索引 |
|
||||
| [`GetCurrentBackBuffer`](../../swap-chain/get-current-back-buffer.md) | 获取当前后台缓冲区 |
|
||||
| [`GetWidth`](get-size.md) | 获取宽度 |
|
||||
| [`GetHeight`](get-size.md) | 获取高度 |
|
||||
| [`GetFramebufferWidth`](get-framebuffer-size.md) | 获取帧缓冲宽度 |
|
||||
| [`GetFramebufferHeight`](get-framebuffer-size.md) | 获取帧缓冲高度 |
|
||||
| [`GetCurrentBackBufferIndex`](get-current-back-buffer-index.md) | 获取当前后台缓冲区索引 |
|
||||
| [`GetCurrentBackBuffer`](get-current-back-buffer.md) | 获取当前后台缓冲区 |
|
||||
| [`GetWidth`](get-width.md) | 获取宽度 |
|
||||
| [`GetHeight`](get-height.md) | 获取高度 |
|
||||
| [`GetFramebufferWidth`](get-framebuffer-width.md) | 获取帧缓冲宽度 |
|
||||
| [`GetFramebufferHeight`](get-framebuffer-height.md) | 获取帧缓冲高度 |
|
||||
| [`SetFramebufferSize`](set-framebuffer-size.md) | 设置帧缓冲大小 |
|
||||
| [`GetWindow`](get-window.md) | 获取窗口 |
|
||||
| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 |
|
||||
| [`GetNativeHandle`](get-native-handle.md) | 获取原生句柄 |
|
||||
|
||||
## 使用示例
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/RHI/OpenGL/OpenGLSwapChain.h>
|
||||
|
||||
// 创建并初始化
|
||||
XCEngine::RHI::OpenGLSwapChain swapChain;
|
||||
GLFWwindow* window = /* 获取 GLFW 窗口 */;
|
||||
swapChain.Initialize(window, true);
|
||||
|
||||
// 游戏循环
|
||||
while (!swapChain.ShouldClose()) {
|
||||
swapChain.PollEvents();
|
||||
|
||||
// 渲染逻辑
|
||||
Render();
|
||||
|
||||
swapChain.Present(1, 0);
|
||||
}
|
||||
|
||||
// 关闭
|
||||
swapChain.Shutdown();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
|
||||
Reference in New Issue
Block a user