Gl.StencilMask (gb.opengl)

Static Sub StencilMask ( Mask As Integer )

Control the front and back writing of individual bits in the stencil planes.

Parameters

mask

Specifies a bit mask to enable and disable writing of individual bits in the stencil planes. Initially, the mask is all 1's.

Description

Gl.StencilMask controls the writing of individual bits in the stencil planes. The least significant n bits of mask, where n is the number of bits in the stencil buffer, specify a mask. Where a 1 appears in the mask, it's possible to write to the corresponding bit in the stencil buffer. Where a 0 appears, the corresponding bit is write-protected. Initially, all bits are enabled for writing.

There can be two separate mask writemasks; one affects back-facing polygons, and the other affects front-facing polygons as well as other non-polygon primitives. Gl.StencilMask sets both front and back stencil writemasks to the same values. Use Gl.StencilMaskSeparate to set front and back stencil writemasks to different values.

Notes

Gl.StencilMask is the same as calling Gl.StencilMaskSeparate with face set to Gl.FRONT_AND_BACK.

Associated Gets

Gl.Get with argument Gl.STENCIL_WRITEMASK, Gl.STENCIL_BACK_WRITEMASK, or Gl.STENCIL_BITS

See also

Gl.StencilFuncSeparate, Gl.StencilMaskSeparate, Gl.StencilOp, Gl.StencilOpSeparate

See original documentation on OpenGL website