STENCILCOMPARISONFUNCTION Enumerations

From Garry's Mod
Jump to: navigation, search

Enumerations for use with render.SetStencilCompareFunction.

The comparison is between the reference value set by render.SetStencilReferenceValue, and the value of each pixel in the stencil buffer.

Clientside only.

NOTE

These enumerations are also mirrored as STENCIL_ Enums.

Also see this corresponding MSDN entry: http://msdn.microsoft.com/en-us/library/windows/desktop/ff476101%28v=vs.85%29.aspx.

Warning! Decimal values are for reference only! The actual value may be different between two Garry's Mod versions.
Name Decimal Description
STENCILCOMPARISONFUNCTION_NEVER 1 Never passes.
STENCILCOMPARISONFUNCTION_LESS 2 Passes where the reference value is less than the stencil value.
STENCILCOMPARISONFUNCTION_EQUAL 3 Passes where the reference value is equal to the stencil value.
STENCILCOMPARISONFUNCTION_LESSEQUAL 4 Passes where the reference value is less than or equal to the stencil value.
STENCILCOMPARISONFUNCTION_GREATER 5 Passes where the reference value is greater than the stencil value.
STENCILCOMPARISONFUNCTION_NOTEQUAL 6 Passes where the reference value is not equal to the stencil value.
STENCILCOMPARISONFUNCTION_GREATEREQUAL 7 Passes where the reference value is greater than or equal to the stencil value.
STENCILCOMPARISONFUNCTION_ALWAYS 8 Always passes.
Personal tools
Navigation