LanguageEnglish
  • C#

StencilState Constructor

Leave feedback
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

Submission failed

For 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.

Close

Cancel

public StencilState(bool enabled, byte readMask, byte writeMask, Rendering.CompareFunction compareFunction, Rendering.StencilOp passOperation, Rendering.StencilOp failOperation, Rendering.StencilOp zFailOperation);
public StencilState(bool enabled, byte readMask, byte writeMask, Rendering.CompareFunction compareFunctionFront, Rendering.StencilOp passOperationFront, Rendering.StencilOp failOperationFront, Rendering.StencilOp zFailOperationFront, Rendering.CompareFunction compareFunctionBack, Rendering.StencilOp passOperationBack, Rendering.StencilOp failOperationBack, Rendering.StencilOp zFailOperationBack);

Parameters

readMaskAn 8 bit mask as an 0–255 integer, used when comparing the reference value with the contents of the buffer.
writeMaskAn 8 bit mask as an 0–255 integer, used when writing to the buffer.
enabledControls whether the stencil buffer is enabled.
compareFunctionFrontThe function used to compare the reference value to the current contents of the buffer for front-facing geometry.
passOperationFrontWhat to do with the contents of the buffer if the stencil test (and the depth test) passes for front-facing geometry.
failOperationFrontWhat to do with the contents of the buffer if the stencil test fails for front-facing geometry.
zFailOperationFrontWhat to do with the contents of the buffer if the stencil test passes, but the depth test fails for front-facing geometry.
compareFunctionBackThe function used to compare the reference value to the current contents of the buffer for back-facing geometry.
passOperationBackWhat to do with the contents of the buffer if the stencil test (and the depth test) passes for back-facing geometry.
failOperationBackWhat to do with the contents of the buffer if the stencil test fails for back-facing geometry.
zFailOperationBackWhat to do with the contents of the buffer if the stencil test passes, but the depth test fails for back-facing geometry.
compareFunctionThe function used to compare the reference value to the current contents of the buffer.
passOperationWhat to do with the contents of the buffer if the stencil test (and the depth test) passes.
failOperationWhat to do with the contents of the buffer if the stencil test fails.
zFailOperationWhat to do with the contents of the buffer if the stencil test passes, but the depth test.

Description

Creates a new stencil state with the given values.

对文档有任何疑问，请移步至开发者社区提问，我们将尽快为您解答