glStencilMask  29NWSK

[New - Windows 95, OEM Service Release 2]

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

void 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.

 

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:

glGet8KNKTW with argument GL_STENCIL_WRITEMASK

glGet with argument GL_STENCIL_BITS

 

Error Codes

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.

 

See Also

glBegin, glColorMask, glDepthMask, glEnd, glIndexMask, glStencilFunc, glStencilOp