Files
XCEngine/docs/api/rhi/enums/stencil-op.md
2026-03-20 02:35:45 +08:00

1007 B

StencilOp

命名空间: XCEngine::RHI

类型: enum class

描述: 模板操作枚举,定义模板测试失败时的操作

概述

StencilOp 枚举定义了当模板测试失败时对模板缓冲区执行的操作,用于实现各种遮罩和剪裁效果。

枚举值

枚举值 描述
Keep 保持现有模板值
Zero 将模板值设为 0
Replace 用参考值替换模板值
IncrSat 递增模板值,饱和到最大值
DecrSat 递减模板值,饱和到最小值
Invert 按位翻转模板值
Incr 递增模板值(可回绕)
Decr 递减模板值(可回绕)

使用示例

#include "RHI/RHIEnums.h"

void Example() {
    StencilOp failOp = StencilOp::Keep;
    
    if (failOp == StencilOp::Replace) {
        // 替换模板值
    }
}

相关文档