GlStencilMask

From QB64 Wiki
Jump to navigation Jump to search

_glStencilMask: control the front and back writing of individual bits in the stencil planes


Syntax

 SUB _glStencilMask (BYVAL mask AS _UNSIGNED LONG)
 void _glStencilMask(GLuint mask);


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

_glStencilMask 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. _glStencilMask sets both front and back stencil writemasks to the same values. Use _glStencilMaskSeparate to set front and back stencil writemasks to different values.


Notes:

_glStencilMask is the same as calling _glStencilMaskSeparate with face set to _GL_FRONT_AND_BACK.


Use With:

_glGet with argument _GL_STENCIL_WRITEMASK, _GL_STENCIL_BACK_WRITEMASK, or _GL_STENCIL_BITS


See also

SUB _GL _glClear, _glClearBuffer, _glColorMask, _glDepthMask, _glStencilFunc, _glStencilFuncSeparate, _glStencilMaskSeparate, _glStencilOp, _glStencilOpSeparate


Copyright: 1991-2006 Silicon Graphics, Inc. This document is licensed under the SGI Free Software B License.
For details, see http://oss.sgi.com/projects/FreeB/.



Navigation:
Keyword Reference - Alphabetical
Keyword Reference - By Usage
Main Wiki Page

Copyright 1991-2006 Silicon Graphics, Inc. This document is licensed under the SGI Free Software B License. For details, see http://oss.sgi.com/projects/FreeB/.