docs: update RHI API docs
This commit is contained in:
39
docs/api/rhi/enums/present-flags.md
Normal file
39
docs/api/rhi/enums/present-flags.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# PresentFlags
|
||||
|
||||
**命名空间**: `XCEngine::RHI`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**描述**: 显示标志枚举,定义帧显示的选项
|
||||
|
||||
## 概述
|
||||
|
||||
PresentFlags 枚举定义了_present_操作的标志,用于控制交换链呈现行为。
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 描述 |
|
||||
|--------|------|
|
||||
| `None` | 无特殊标志 |
|
||||
| `AllowTearing` | 允许垂直同步撕裂 |
|
||||
| `StrictlyTimedFrame` | 严格计时帧 |
|
||||
| `AllowDisplayLatencyWaitableObject` | 允许显示延迟等待对象 |
|
||||
|
||||
## 使用示例
|
||||
|
||||
```cpp
|
||||
#include "RHI/RHIEnums.h"
|
||||
|
||||
void Example() {
|
||||
PresentFlags flags = PresentFlags::AllowTearing;
|
||||
|
||||
if (flags == PresentFlags::None) {
|
||||
// 标准呈现
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [StoreAction](store-action.md) - 存储操作枚举
|
||||
- [ResourceStates](resource-states.md) - 资源状态枚举
|
||||
Reference in New Issue
Block a user