Template:NifSE NiStencilProperty Stencil Functions

List of the stencil functions used by NiStencilProperty blocks. Used by NifSE.

Stencil Functions

This function determines whether a particular pixel will be drawn based on the contents of the stencil buffer at that location. The formula is StencilFunction(mask & buffer value, mask & ref). Thus, assuming the default mask value of 0xFFFFFFFF, a StencilFunction value of 1 (i.e. LESS) would mean that the stencil property tests value < ref, and if true, draws the pixel in question.

  • NEVER = 0
  • LESS = 1
  • EQUAL = 2
  • LEQUAL = 3
  • GREATER = 4
  • NOT_EQUAL = 5
  • GEQUAL = 6
  • ALWAYS = 7