The WebGLRenderingContext.stencilOp()
method of the WebGL API sets both the front and back-facing stencil test actions.
The WebGLRenderingContext.stencilOp()
method of the WebGL API sets both the front and back-facing stencil test actions.
js
stencilOp(fail, zfail, zpass)
All three parameters accept all constants listed below.
fail
A GLenum
specifying the function to use when the stencil test fails. The default value is gl.KEEP
.
zfail
A GLenum
specifying the function to use when the stencil test passes, but the depth test fails. The default value is gl.KEEP
.
zpass
A GLenum
specifying the function to use when both the stencil test and the depth test pass, or when the stencil test passes and there is no depth buffer or depth testing is disabled. The default value is gl.KEEP
.
None (undefined
).
gl.KEEP
Keeps the current value.
gl.ZERO
Sets the stencil buffer value to 0.
gl.REPLACE
Sets the stencil buffer value to the reference value as specified by WebGLRenderingContext.stencilFunc()
.
gl.INCR
Increments the current stencil buffer value. Clamps to the maximum representable unsigned value.
gl.INCR_WRAP
Increments the current stencil buffer value. Wraps stencil buffer value to zero when incrementing the maximum representable unsigned value.
gl.DECR
Decrements the current stencil buffer value. Clamps to 0.
gl.DECR_WRAP
Decrements the current stencil buffer value. Wraps stencil buffer value to the maximum representable unsigned value when decrementing a stencil buffer value of 0.
gl.INVERT
Inverts the current stencil buffer value bitwise.
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
.
js
gl.enable(gl.STENCIL_TEST); gl.stencilOp(gl.INCR, gl.DECR, gl.INVERT);
To get the current information about stencil and depth pass or fail, query the following constants with getParameter()
.
js
gl.getParameter(gl.STENCIL_FAIL); gl.getParameter(gl.STENCIL_PASS_DEPTH_PASS); gl.getParameter(gl.STENCIL_PASS_DEPTH_FAIL); gl.getParameter(gl.STENCIL_BACK_FAIL); gl.getParameter(gl.STENCIL_BACK_PASS_DEPTH_PASS); gl.getParameter(gl.STENCIL_BACK_PASS_DEPTH_FAIL); gl.getParameter(gl.STENCIL_BITS);
Specification |
---|
WebGL Specification # 5.14.3 |
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
stencilOp |
9 | 12 | 4 | 11 | 12 | 5.1 | 4.4.3 | 25 | 4 | 12 | 8 | 1.5 |
© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/stencilOp