StencilState
Creates a new stencil state with the given values.
Read time 2 minutesLast updated 7 days ago
Definition
- Type: Constructor
- Namespace: UnityEngine.Rendering
- Assembly: UnityEngine.CoreModule
StencilState(bool, byte, byte, CompareFunction, StencilOp, StencilOp, StencilOp)
Creates a new stencil state with the given values.
public StencilState(bool enabled = true, byte readMask = 255, byte writeMask = 255, CompareFunction compareFunction = CompareFunction.Always, StencilOp passOperation = StencilOp.Keep, StencilOp failOperation = StencilOp.Keep, StencilOp zFailOperation = StencilOp.Keep)
Parameters
Controls whether the stencil buffer is enabled.
An 8 bit mask as an 0–255 integer, used when comparing the reference value with the contents of the buffer.
An 8 bit mask as an 0–255 integer, used when writing to the buffer.
The function used to compare the reference value to the current contents of the buffer.
What to do with the contents of the buffer if the stencil test (and the depth test) passes.
What to do with the contents of the buffer if the stencil test fails.
What to do with the contents of the buffer if the stencil test passes, but the depth test.
StencilState(bool, byte, byte, CompareFunction, StencilOp, StencilOp, StencilOp, CompareFunction, StencilOp, StencilOp, StencilOp)
Creates a new stencil state with the given values.
public StencilState(bool enabled, byte readMask, byte writeMask, CompareFunction compareFunctionFront, StencilOp passOperationFront, StencilOp failOperationFront, StencilOp zFailOperationFront, CompareFunction compareFunctionBack, StencilOp passOperationBack, StencilOp failOperationBack, StencilOp zFailOperationBack)
Parameters
Controls whether the stencil buffer is enabled.
An 8 bit mask as an 0–255 integer, used when comparing the reference value with the contents of the buffer.
An 8 bit mask as an 0–255 integer, used when writing to the buffer.
The function used to compare the reference value to the current contents of the buffer for front-facing geometry.
What to do with the contents of the buffer if the stencil test (and the depth test) passes for front-facing geometry.
What to do with the contents of the buffer if the stencil test fails for front-facing geometry.
What to do with the contents of the buffer if the stencil test passes, but the depth test fails for front-facing geometry.
The function used to compare the reference value to the current contents of the buffer for back-facing geometry.
What to do with the contents of the buffer if the stencil test (and the depth test) passes for back-facing geometry.
What to do with the contents of the buffer if the stencil test fails for back-facing geometry.
What to do with the contents of the buffer if the stencil test passes, but the depth test fails for back-facing geometry.