WebGL
The WebGLRenderingContext.stencilOpSeparate() method of
the WebGL API sets the front and/or
back-facing stencil test actions.
Syntax
stencilOpSeparate(face, fail, zfail, zpass)
Parameters
-
face- : A WebGL_API/Types specifying whether the front and/or back stencil state is
updated. The possible values are:
gl.FRONTgl.BACKgl.FRONT_AND_BACK
- : A WebGL_API/Types specifying whether the front and/or back stencil state is
updated. The possible values are:
-
fail- : A WebGL_API/Types specifying the function to use when the stencil test fails.
The default value is
gl.KEEP.
- : A WebGL_API/Types specifying the function to use when the stencil test fails.
The default value is
-
zfail- : A WebGL_API/Types specifying the function to use when the stencil test passes,
but the depth test fails. The default value is
gl.KEEP.
- : A WebGL_API/Types specifying the function to use when the stencil test passes,
but the depth test fails. The default value is
-
zpass- : A WebGL_API/Types 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.
- : A WebGL_API/Types 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
Return value
None (undefined).
Constants
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.
Examples
The stencil testing is disabled by default. To enable or disable stencil testing, use
the WebGLRenderingContext.enable and
WebGLRenderingContext.disable methods with the argument
gl.STENCIL_TEST.
gl.enable(gl.STENCIL_TEST);
gl.stencilOpSeparate(gl.FRONT, gl.INCR, gl.DECR, gl.INVERT);
To get the current information about stencil and depth pass or fail, query the following constants with WebGLRenderingContext.getParameter.
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);
Specifications
Browser compatibility
See also
- WebGLRenderingContext.stencilOp()
- WebGLRenderingContext.stencilFunc()
- WebGLRenderingContext.stencilFuncSeparate()
- WebGLRenderingContext.stencilMask()
- WebGLRenderingContext.stencilMaskSeparate()
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
