Revision Difference
Enums/STENCILCOMPARISONFUNCTION#516553
<cat>enum</cat>
<enum>
<description>
Enumerations for use with <page>render.SetStencilCompareFunction</page>.
The comparison is between the reference value set by <page>render.SetStencilReferenceValue</page>, and the value of each pixel in the stencil buffer.
Clientside only.
&lt;noinclude&gt;<note>These enumerations are also mirrored as <page>STENCIL</page>.</note>&lt;/noinclude&gt;&lt;includeonly&gt;
These enumerations are mirrors of <page>STENCILCOMPARISONFUNCTION</page>.&lt;/includeonly&gt;
Also see this corresponding MSDN entry: http://msdn.microsoft.com/en-us/library/windows/desktop/ff476101%28v=vs.85%29.aspx.
</description>
<items><item key="{{#titleparts:{{SUBPAGENAME</items>
</enum>
" value="|-1}}_NEVER">1|Never passes.</item>⤶
<item key="{{#titleparts:{{SUBPAGENAME}}" value="|-1}}_LESS">2|Passes where the reference value is less than the stencil value.</item>⤶
<item key="{{#titleparts:{{SUBPAGENAME}}" value="|-1}}_EQUAL">3|Passes where the reference value is equal to the stencil value.</item>⤶
<item key="{{#titleparts:{{SUBPAGENAME}}" value="|-1}}_LESSEQUAL">4|Passes where the reference value is less than or equal to the stencil value.</item>⤶
<item key="{{#titleparts:{{SUBPAGENAME}}" value="|-1}}_GREATER">5|Passes where the reference value is greater than the stencil value.</item>⤶
<item key="{{#titleparts:{{SUBPAGENAME}}" value="|-1}}_NOTEQUAL">6|Passes where the reference value is not equal to the stencil value.</item>⤶
<item key="{{#titleparts:{{SUBPAGENAME}}" value="|-1}}_GREATEREQUAL">7|Passes where the reference value is greater than or equal to the stencil value.</item>⤶
<item key="{{#titleparts:{{SUBPAGENAME}}" value="|-1}}_ALWAYS">8|Always passes.</item>⤶
}}
" value="|-1"></item>⤶
_NEVER|1|Never passes.}}<item key="{{#titleparts:{{SUBPAGENAME}}" value="|-1"></item>⤶
_LESS|2|Passes where the reference value is less than the stencil value.}}<item key="{{#titleparts:{{SUBPAGENAME}}" value="|-1"></item>⤶
_EQUAL|3|Passes where the reference value is equal to the stencil value.}}<item key="{{#titleparts:{{SUBPAGENAME}}" value="|-1"></item>⤶
_LESSEQUAL|4|Passes where the reference value is less than or equal to the stencil value.}}<item key="{{#titleparts:{{SUBPAGENAME}}" value="|-1"></item>⤶
_GREATER|5|Passes where the reference value is greater than the stencil value.}}<item key="{{#titleparts:{{SUBPAGENAME}}" value="|-1"></item>⤶
_NOTEQUAL|6|Passes where the reference value is not equal to the stencil value.}}<item key="{{#titleparts:{{SUBPAGENAME}}" value="|-1"></item>⤶
_GREATEREQUAL|7|Passes where the reference value is greater than or equal to the stencil value.}}<item key="{{#titleparts:{{SUBPAGENAME}}" value="|-1"></item>⤶
_ALWAYS|8|Always passes.}}
}}