glStencilMask function

The glStencilMask function controls the writing of individual bits in the stencil planes.

Syntax

void WINAPI glStencilMask(
   GLuint mask
);

Parameters

mask

A bit mask to enable and disable writing of individual bits in the stencil planes. Initially, the mask is all ones.

Return value

This function does not return a value.

Error codes

The following error code can be retrieved by the glGetError function.

Remarks

The glStencilMask function 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. Wherever a one appears in the mask, the corresponding bit in the stencil buffer is made writable. Where a zero appears, the bit is write-protected. Initially, all bits are enabled for writing.

The following functions retrieve information related to glStencilMask:

glGet with argument GL_STENCIL_WRITEMASK

glGet with argument GL_STENCIL_BITS

Requirements

See also

glBegin

glColorMask

glDepthMask

glEnd

glIndexMask

glStencilFunc

glStencilOp