glClearStencil function
The glClearStencil function specifies the clear value for the stencil buffer.
Syntax
void WINAPI glClearStencil(
GLint s
);
Parameters
-
s
-
The index used when the stencil buffer is cleared. The default value is zero.
Return value
This function does not return a value.
Error codes
The following error code can be retrieved by the glGetError function.
| Name | Meaning |
|---|---|
|
The function was called between a call to glBegin and the corresponding call to glEnd. |
Remarks
The glClearStencil function specifies the index used by glClear to clear the stencil buffer. The s parameter is masked with 2m - 1, where m is the number of bits in the stencil buffer.
The following functions retrieve information related to the glClearStencil function:
glGet with argument GL_STENCIL_CLEAR_VALUE
glGet with argument GL_STENCIL_BITS
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows 2000 Professional [desktop apps only] |
| Minimum supported server |
Windows 2000 Server [desktop apps only] |
| Header |
|
| Library |
|
| DLL |
|