
S
glStencilFunc
Chapter 17
403
glStencilFunc
glStencilFunc
: set function and reference value for stencil testing.
C Specification
void glStencilFunc(
GLenum func,
GLint ref,
GLuint mask)
Parameters
func
Specifies the test function. Eight tokens are valid: GL_NEVER,
GL_LESS, GL_LEQUAL, GL_GREATER, GL_GEQUAL, GL_EQUAL,
GL_NOTEQUAL, and GL_ALWAYS. The initial value is GL_ALWAYS.
ref
Specifies the reference value for the stencil test. ref is clamped to the
range [0, 2
n
- 1], where n is the number of bitplanes in the stencil
buffer. The initial value is 0.
mask
Specifies a mask that is ANDed with both the reference value and the
stored stencil value when the test is done. The initial value is all 1s.
Description
Stenciling, like depth-buffering, enables and disables drawing on a per-pixel basis. You
draw into the stencil planes using GL drawing primitives, then render geometry and
images, using the stencil planes to mask out portions of the screen. Stenciling is typically
used in multipass rendering algorithms to achieve special effects, such as decals,
outlining, and constructive solid geometry rendering.
The stencil test conditionally eliminates a pixel based on the outcome of a comparison
between the reference value and the value in the stencil buffer. To enable and disable the
test, call glEnable and glDisable with argument GL_STENCIL_TEST. To specify actions
based on the outcome of the stencil test, call glStencilOp.
func is a symbolic constant that determines the stencil comparison function. It accepts
one of eight values, shown in the following list. ref is an integer reference value that is
used in the stencil comparison. It is clamped to the range [0, 2
n
- 1], where n is the
number of bitplanes in the stencil buffer. mask is bitwise anded with both the reference
value and the stored stencil value, with the anded values participating in the
comparison.
If stencil represents the value stored in the corresponding stencil buffer location, the
following list shows the effect of each comparison function that can be specified by func.
Only if the comparison succeeds is the pixel passed through to the next stage in the
rasterization process (see glStencilOp). All tests treat stencil values as unsigned integers
in the range [0, 2
n
- 1], where n is the number of bitplanes in the stencil buffer.
Summary of Contents for c3700 - Workstation
Page 9: ...Chapter 1 9 1 A ...
Page 18: ...A glArrayElement Chapter 1 18 glNormalPointer glTexCoordPointer glVertexPointer ...
Page 19: ...Chapter 2 19 2 B ...
Page 40: ...B gluBuild2DMipmaps Chapter 2 40 ...
Page 41: ...Chapter 3 41 3 C ...
Page 49: ...C glXChooseVisual Chapter 3 49 See Also glXCreateContext glXGetConfig ...
Page 73: ...C glCopyPixels Chapter 3 73 glReadBuffer glReadPixels glStencilFunc ...
Page 84: ...C glCopyTexSubImage2D Chapter 3 84 glTexParameter glTexSubImage1D glTexSubImage2D ...
Page 93: ...Chapter 4 93 4 D ...
Page 99: ...D glDeleteTextures Chapter 4 99 glTexImage1D glTexImage2D glTexParameter ...
Page 127: ...Chapter 5 127 5 E ...
Page 148: ...E glEvalPoint Chapter 5 148 ...
Page 149: ...Chapter 6 149 6 F ...
Page 161: ...Chapter 7 161 7 G ...
Page 164: ...G glGenTextures Chapter 7 164 glTexImage1D glTexImage2D glTexParameter ...
Page 207: ...G glGetPointer Chapter 7 207 glSelectBuffer glTexCoordPointer glVertexPointer ...
Page 225: ...Chapter 8 225 8 H ...
Page 228: ...H glHint Chapter 8 228 ...
Page 229: ...Chapter 9 229 9 I ...
Page 248: ...I glIsTexture Chapter 9 248 ...
Page 249: ...Chapter 10 249 10 L ...
Page 256: ...L glLightModel Chapter 10 256 See Also glLight glMaterial ...
Page 271: ...Chapter 11 271 11 M ...
Page 291: ...Chapter 12 291 12 N ...
Page 312: ...N gluNurbsSurface Chapter 12 312 ...
Page 313: ...Chapter 13 313 13 O ...
Page 317: ...Chapter 14 317 14 P ...
Page 360: ...P glPushName Chapter 14 360 See Also glInitNames glLoadName glRenderMode glSelectBuffer ...
Page 362: ...P gluPwlCurve Chapter 14 362 ...
Page 363: ...Chapter 15 363 15 Q ...
Page 372: ...Q glXQueryVersion Chapter 15 372 glXQueryVersion ...
Page 373: ...Chapter 16 373 16 R ...
Page 390: ...R glRotate Chapter 16 390 ...
Page 391: ...Chapter 17 391 17 S ...
Page 397: ...S glScissor Chapter 17 397 See Also glEnable glViewport ...
Page 409: ...Chapter 18 409 18 T ...
Page 448: ...T glTexImage3DEXT Chapter 18 448 glTexGen glTexImage1D glTexImage2D glTexParameter ...
Page 457: ...T glTexSubImage1D Chapter 18 457 glTexImage2D glTexParameter glTexSubImage2D ...
Page 465: ...T glTranslate Chapter 18 465 See Also glMatrixMode glMultMatrix glPushMatrix glScale ...
Page 466: ...T glTranslate Chapter 18 466 ...
Page 467: ...Chapter 19 467 19 U ...
Page 469: ...U gluUnProject Chapter 19 469 See Also glGet gluProject ...
Page 471: ...U glXUseXFont Chapter 19 471 See Also glBitmap glXMakeCurrent ...
Page 472: ...U glXUseXFont Chapter 19 472 ...
Page 473: ...Chapter 20 473 20 V ...
Page 482: ...V glVisibilityBufferhp Chapter 20 482 ...
Page 483: ...Chapter 21 483 21 W ...
Page 486: ...W glXWaitX Chapter 21 486 ...