struct in UnityEngine.Rendering
/
Implemented in:UnityEngine.CoreModule
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.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
CloseValues for the stencil state.
See Also: RenderStateBlock, ShaderLab: Stencil.
defaultValue | Default values for the stencil state. |
compareFunctionBack | The function used to compare the reference value to the current contents of the buffer for back-facing geometry. |
compareFunctionFront | The function used to compare the reference value to the current contents of the buffer for front-facing geometry. |
enabled | Controls whether the stencil buffer is enabled. |
failOperationBack | What to do with the contents of the buffer if the stencil test fails for back-facing geometry. |
failOperationFront | What to do with the contents of the buffer if the stencil test fails for front-facing geometry. |
passOperationBack | What to do with the contents of the buffer if the stencil test (and the depth test) passes for back-facing geometry. |
passOperationFront | What to do with the contents of the buffer if the stencil test (and the depth test) passes for front-facing geometry. |
readMask | An 8 bit mask as an 0–255 integer, used when comparing the reference value with the contents of the buffer. |
writeMask | An 8 bit mask as an 0–255 integer, used when writing to the buffer. |
zFailOperationBack | What to do with the contents of the buffer if the stencil test passes, but the depth test fails for back-facing geometry. |
zFailOperationFront | What to do with the contents of the buffer if the stencil test passes, but the depth test fails for front-facing geometry. |
StencilState | Creates a new stencil state with the given values. |
SetCompareFunction | The function used to compare the reference value to the current contents of the buffer. |
SetFailOperation | What to do with the contents of the buffer if the stencil test fails. |
SetPassOperation | What to do with the contents of the buffer if the stencil test (and the depth test) passes. |
SetZFailOperation | What to do with the contents of the buffer if the stencil test passes, but the depth test fails. |