Home -> IStateGroupNode -> StencilComparisonFunction
Description
The StencilComparisonFunction enumeration specifies the comparison operation used by the stencil test when stencil testing is enabled.
Members
| Name | Description | |
|---|---|---|
 |
Never |
The stencil test always fails.
|
|
Equal |
The stencil test passes when the incoming value is equal to the stored or reference value.
|
|
NotEqual |
The stencil test passes when the incoming value is not equal to the stored or reference value.
|
|
Less |
The stencil test passes when the incoming value is less than the stored or reference value.
|
|
LessOrEqual |
The stencil test passes when the incoming value is less than or equal to the stored or reference value.
|
|
Greater |
The stencil test passes when the incoming value is greater than the stored or reference value.
|
|
GreaterOrEqual |
The stencil test passes when the incoming value is greater than or equal to the stored or reference value.
|
|
Always |
The stencil test always passes.
|