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:
34
docs/api/rhi/device/create-swap-chain.md
Normal file
34
docs/api/rhi/device/create-swap-chain.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# RHIDevice::CreateSwapChain
|
||||
|
||||
```cpp
|
||||
virtual RHISwapChain* CreateSwapChain(const SwapChainDesc& desc) = 0;
|
||||
```
|
||||
|
||||
创建交换链,用于管理窗口渲染和帧缓冲区切换。
|
||||
|
||||
**参数:**
|
||||
- `desc` - 交换链描述符,包含尺寸、缓冲数量、格式等
|
||||
|
||||
**返回:** 新创建的交换链指针,失败返回 `nullptr`
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
SwapChainDesc swapChainDesc;
|
||||
swapChainDesc.width = 1280;
|
||||
swapChainDesc.height = 720;
|
||||
swapChainDesc.bufferCount = 2;
|
||||
swapChainDesc.format = (uint32_t)Format::R8G8B8A8_UNorm;
|
||||
swapChainDesc.refreshRate = 60;
|
||||
swapChainDesc.sampleCount = 1;
|
||||
swapChainDesc.sampleQuality = 0;
|
||||
|
||||
RHISwapChain* swapChain = device->CreateSwapChain(swapChainDesc);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIDevice 总览](device.md) - 返回类总览
|
||||
- [RHISwapChain](../swap-chain/swap-chain.md) - 交换链类
|
||||
Reference in New Issue
Block a user