We're looking for a user researcher to understand the needs of developers and designers. Is this you or someone you know? Check out the post: https://mzl.la/2IGzdXS


Nos bénévoles n'ont pas encore traduit cet article en Français. Inscrivez-vous et aidez-nous à réaliser cette tâche !
Vous pouvez également lire cet article en English (US).

The WebGLRenderingContext.stencilFunc() method of the WebGL API sets the front and back function and reference value for stencil testing.

Stencilling enables and disables drawing on a per-pixel basis. It is typically used in multipass rendering to achieve special effects.


void gl.stencilFunc(func, ref, mask);


A GLenum specifying the test function. The default function is gl.ALWAYS. The possible values are:
  • gl.NEVER:       Never pass.
  • gl.LESS:         Pass if (ref & mask) <  (stencil & mask).
  • gl.EQUAL:       Pass if (ref & mask) =  (stencil & mask).
  • gl.LEQUAL:     Pass if (ref & mask) <= (stencil & mask).
  • gl.GREATER:   Pass if (ref & mask) >  (stencil & mask).
  • gl.NOTEQUAL: Pass if (ref & mask) != (stencil & mask).
  • gl.GEQUAL:     Pass if (ref & mask) >= (stencil & mask).
  • gl.ALWAYS:     Always pass.
A GLint specifying the reference value for the stencil test. This value is clamped to the range 0 to 2n -1 where n is the number of bitplanes in the stencil buffer. The default value is 0.
A GLuint specifying a bit-wise mask that is used to AND the reference value and the stored stencil value when the test is done. The default value is all 1.

Return value



The stencil testing is disabled by default. To enable or disable stencil testing, use the enable() and disable() methods with the argument gl.STENCIL_TEST.

gl.stencilFunc(gl.LESS, 0.2, 1110011);

To get the current stencil function, reference value, or other stencil information, query the following constants with getParameter().



Specification Status Comment
WebGL 1.0
The definition of 'stencilFunc' in that specification.
Recommendation Initial definition.
OpenGL ES 2.0
The definition of 'glStencilFunc' in that specification.
Standard Man page of the OpenGL API.

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support912411125.1
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support Yes25 Yes Yes128.1 Yes

See also

Étiquettes et contributeurs liés au document

Contributeurs à cette page : fscholz, teoli
Dernière mise à jour par : fscholz,