Legacy Documentation: Version 5.0
Language: English
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

StencilOp

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual

Description

Specifies the operation that's performed on the stencil buffer when rendering.

Variables

KeepKeeps the current stencil value.
ZeroSets the stencil buffer value to zero.
ReplaceReplace the stencil buffer value with reference value (specified in the shader).
IncrementSaturateIncrements the current stencil buffer value. Clamps to the maximum representable unsigned value.
DecrementSaturateDecrements the current stencil buffer value. Clamps to 0.
InvertBitwise inverts the current stencil buffer value.
IncrementWrapIncrements the current stencil buffer value. Wraps stencil buffer value to zero when incrementing the maximum representable unsigned value.
DecrementWrapDecrements the current stencil buffer value. Wraps stencil buffer value to the maximum representable unsigned value when decrementing a stencil buffer value of zero.