Version: 2022.3

StencilState

struct in UnityEngine.Rendering

切换到手册

描述

模板状态的值。

Use this with RenderStateBlock and ScriptableRenderContext.DrawRenderers to override the GPU's render state.

Corresponds to the Stencil command in ShaderLab.

See Also: RenderStateBlock, [[ScriptableRenderContext.DrawRenderers], ShaderLab command: Stencil.

静态变量

defaultValue模板状态的默认值。

变量

compareFunctionBack用于将参考值与缓冲区的当前内容进行比较的函数(适用于背面几何体)。
compareFunctionFront用于将参考值与缓冲区的当前内容进行比较的函数(适用于正面几何体)。
enabled控制是否启用模板缓冲区。
failOperationBack如果模板测试失败,如何处理缓冲区的内容(适用于背面几何体)。
failOperationFront如果模板测试失败,如何处理缓冲区的内容(适用于正面几何体)。
passOperationBack如果模板测试(和深度测试)通过,如何处理缓冲区的内容(适用于背面几何体)。
passOperationFront如果模板测试(和深度测试)通过,如何处理缓冲区的内容(适用于正面几何体)。
readMask一个 8 位掩码,值为 0 到 255 之间的整数,比较参考值和缓冲区的内容时使用。
writeMask一个 8 位掩码,值为 0 到 255 之间的整数,写入缓冲区时使用。
zFailOperationBack如果模板测试通过但深度测试失败,如何处理缓冲区的内容(适用于背面几何体)。
zFailOperationFront如果模板测试通过但深度测试失败,如何处理缓冲区的内容(适用于正面几何体)。

构造函数

StencilState使用给定值创建新模板状态。

公共函数

SetCompareFunction用于将参考值与缓冲区的当前内容进行比较的函数。
SetFailOperation如果模板测试失败,如何处理缓冲区的内容。
SetPassOperation如果模板测试(和深度测试)通过,如何处理缓冲区的内容。
SetZFailOperation如果模板测试通过但深度测试失败,如何处理缓冲区的内容。