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.
Use this with RenderStateBlock and ScriptableRenderContext.DrawRenderers to override the GPU's render state.
Corresponds to the Stencil command in ShaderLab.
Additional resources: RenderStateBlock, [[ScriptableRenderContext.DrawRenderers], ShaderLab command: Stencil.
| Property | Description |
|---|---|
| defaultValue | Default values for the stencil state. |
| Property | Description |
|---|---|
| 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. |
| Constructor | Description |
|---|---|
| StencilState | Creates a new stencil state with the given values. |
| Method | Description |
|---|---|
| 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. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.