Garry's Mod Wiki

Revision Difference

Enums/STENCILCOMPARISONFUNCTION#516117

<cat>enum</cat> <enumeration> <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. &amp;lt;noinclude&amp;gt;<note>These enumerations are also mirrored as <page>STENCIL</page>.</note>&amp;lt;/noinclude&amp;gt;&amp;lt;includeonly&amp;gt; These enumerations are mirrors of <page>STENCILCOMPARISONFUNCTION</page>.&amp;lt;/includeonly&amp;gt; Also see this corresponding MSDN entry: http://msdn.microsoft.com/en-us/library/windows/desktop/ff476101%28v=vs.85%29.aspx. </description> <fields>{{EnumField|{{#titleparts:{{SUBPAGENAME</fields> <fields><item key="{{#titleparts:{{SUBPAGENAME</fields> </enumeration> ||-1}}_NEVER|1|Never passes.}}{{EnumField|{{#titleparts:{{SUBPAGENAME}}||-1}}_LESS|2|Passes where the reference value is less than the stencil value.}}{{EnumField|{{#titleparts:{{SUBPAGENAME}}||-1}}_EQUAL|3|Passes where the reference value is equal to the stencil value.}}{{EnumField|{{#titleparts:{{SUBPAGENAME}}||-1}}_LESSEQUAL|4|Passes where the reference value is less than or equal to the stencil value.}}{{EnumField|{{#titleparts:{{SUBPAGENAME}}||-1}}_GREATER|5|Passes where the reference value is greater than the stencil value.}}{{EnumField|{{#titleparts:{{SUBPAGENAME}}||-1}}_NOTEQUAL|6|Passes where the reference value is not equal to the stencil value.}}{{EnumField|{{#titleparts:{{SUBPAGENAME}}||-1}}_GREATEREQUAL|7|Passes where the reference value is greater than or equal to the stencil value.}}{{EnumField|{{#titleparts:{{SUBPAGENAME}}||-1}}_ALWAYS|8|Always passes.}} " 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> }}