ContextQMD
Back to Content

WebGLRenderingContext: stencilOp() method

files/en-us/web/api/webglrenderingcontext/stencilop/index.md

latest3.0 KB
Original Source

{{APIRef("WebGL")}}{{AvailableInWorkers}}

The WebGLRenderingContext.stencilOp() method of the WebGL API sets both the front and back-facing stencil test actions.

Syntax

js-nolint
stencilOp(fail, zfail, zpass)

Parameters

  • fail
    • : A {{domxref("WebGL_API/Types", "GLenum")}} specifying the function to use when the stencil test fails. The default value is gl.KEEP.
  • zfail
    • : A {{domxref("WebGL_API/Types", "GLenum")}} specifying the function to use when the stencil test passes, but the depth test fails. The default value is gl.KEEP.
  • zpass
    • : A {{domxref("WebGL_API/Types", "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.

Return value

None ({{jsxref("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 {{domxref("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 {{domxref("WebGLRenderingContext.enable", "enable()")}} and {{domxref("WebGLRenderingContext.disable", "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 {{domxref("WebGLRenderingContext.getParameter", "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);

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

  • {{domxref("WebGLRenderingContext.stencilOpSeparate()")}}
  • {{domxref("WebGLRenderingContext.stencilFunc()")}}
  • {{domxref("WebGLRenderingContext.stencilFuncSeparate()")}}
  • {{domxref("WebGLRenderingContext.stencilMask()")}}
  • {{domxref("WebGLRenderingContext.stencilMaskSeparate()")}}