glClearStencil(3) Mac OS X Manual Page

Mac Dev Center Mac OS X Reference Library General Mac OS X Man Pages

This manual page is for Mac OS X version 10.6.3

If you are running a different version of Mac OS X, view the documentation locally:

In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

For more information about the manual page format, see the manual page for manpages(5).
For more information about this technology, look for other documentation in the Apple Reference Library.
For general information about writing shell scripts, read Shell Scripting Primer.


GLCLEARSTENCIL(3G)                                                                        GLCLEARSTENCIL(3G)



NAME
       glClearStencil - specify the clear value for the stencil buffer


C SPECIFICATION
       void glClearStencil( GLint s )


PARAMETERS
       s  Specifies the index used when the stencil buffer is cleared.  The initial value is 0.

DESCRIPTION
       glClearStencil specifies the index used by glClear to clear the stencil buffer.  s is masked with 2^m
       - 1, where m is the number of bits in the stencil buffer.

ERRORS
       GL_INVALID_OPERATION is generated if glClearStencil is executed between the execution of glBegin  and
       the corresponding execution of glEnd.

ASSOCIATED GETS
       glGet with argument GL_STENCIL_CLEAR_VALUE
       glGet with argument GL_STENCIL_BITS

SEE ALSO
       glClear(3G), glStencilFunc(3G), glStencilOp(3G), glStencilMask(3G)




                                                                                          GLCLEARSTENCIL(3G)

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors: Report errors in the content of this documentation to the OpenGL project.
Bug reports: Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems: Report formatting mistakes in the online version of these pages with the feedback links below.

Did this document help you?