docs: update RHI API docs
This commit is contained in:
53
docs/api/rhi/enums/blend-factor.md
Normal file
53
docs/api/rhi/enums/blend-factor.md
Normal file
@@ -0,0 +1,53 @@
|
||||
# BlendFactor
|
||||
|
||||
**命名空间**: `XCEngine::RHI`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**描述**: 混合因子枚举,定义颜色混合的权重因子
|
||||
|
||||
## 概述
|
||||
|
||||
BlendFactor 枚举定义了混合运算中使用的各种因子,用于控制源颜色和目标颜色的混合权重。
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 描述 |
|
||||
|--------|------|
|
||||
| `Zero` | 0 |
|
||||
| `One` | 1 |
|
||||
| `SrcColor` | 源颜色 |
|
||||
| `InvSrcColor` | 1 - 源颜色 |
|
||||
| `SrcAlpha` | 源 alpha 值 |
|
||||
| `InvSrcAlpha` | 1 - 源 alpha 值 |
|
||||
| `DstAlpha` | 目标 alpha 值 |
|
||||
| `InvDstAlpha` | 1 - 目标 alpha 值 |
|
||||
| `DstColor` | 目标颜色 |
|
||||
| `InvDstColor` | 1 - 目标颜色 |
|
||||
| `SrcAlphaSat` | 饱和的源 alpha 值 |
|
||||
| `BlendFactor` | 自定义混合因子 |
|
||||
| `InvBlendFactor` | 1 - 自定义混合因子 |
|
||||
| `Src1Color` | 第二个源的 RGB |
|
||||
| `InvSrc1Color` | 1 - 第二个源的 RGB |
|
||||
| `Src1Alpha` | 第二个源的 alpha |
|
||||
| `InvSrc1Alpha` | 1 - 第二个源的 alpha |
|
||||
|
||||
## 使用示例
|
||||
|
||||
```cpp
|
||||
#include "RHI/RHIEnums.h"
|
||||
|
||||
void Example() {
|
||||
BlendFactor srcFactor = BlendFactor::SrcAlpha;
|
||||
BlendFactor dstFactor = BlendFactor::InvSrcAlpha;
|
||||
|
||||
if (srcFactor == BlendFactor::One) {
|
||||
// 完全使用源颜色
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [BlendOp](blend-op.md) - 混合操作枚举
|
||||
- [ColorWriteMask](color-write-mask.md) - 颜色写入掩码枚举
|
||||
Reference in New Issue
Block a user