[ Previous | Next | Contents | Glossary | Home | Search ]
OpenGL 1.1 for AIX: Reference Manual

glClearStencil Subroutine

Purpose

Specifies the clear value for the stencil buffer.

Library

OpenGL C bindings library: libGL.a

C Syntax

void glClearStencil(GLint Stencil)

Parameters

Stencil Specifies the index used when the stencil buffer is cleared. The default value is 0 (zero).

Description

The glClearStencil subroutine specifies the index used by glClear to clear the stencil buffer. The Stencil parameter is masked with 2m - 1, where m is the number of bits in the stencil buffer.

Errors

GL_INVALID_OPERATION Indicates that glClearStencil is called between a call to glBegin and the corresponding call to glEnd.

Associated Gets

Associated gets for the glClearStencil subroutine are as follows. (See the glGet subroutine for more information.)

glGet with argument GL_STENCIL_CLEAR_VALUE

glGet with argument GL_STENCIL_BITS.

Files

/usr/include/GL/gl.h Contains C language constants, variable type definitions, and ANSI function prototypes for OpenGL.

Related Information

The glBegin or glEnd subroutine, glClear subroutine.

OpenGL Overview.


[ Previous | Next | Contents | Glossary | Home | Search ]