The glStencilMask function controls the writing of individual bits in the stencil planes.
void glStencilMask(
GLuint mask
);
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
The following are the error codes generated and their conditions.
| Error Code | Condition |
|---|---|
| GL_INVALID_OPERATION | glStencilMask was called between a call to glBegin and the corresponding call to glEnd. |
Windows NT: Use version 3.5 and later.
Windows: Use Windows 95 and later.
Windows CE: Unsupported.
Header: Declared in gl.h.
Import Library: Link with opengl32.lib.
glBegin, glColorMask, glDepthMask, glEnd, glIndexMask, glStencilFunc, glStencilOp