Back to Content

WebGLRenderingContext: disable() method

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

latest3.6 KB
Original Source

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

The WebGLRenderingContext.disable() method of the WebGL API disables specific WebGL capabilities for this context.

Syntax

js-nolint
disable(capability)

Parameters

  • capability
    • : A {{domxref("WebGL_API/Types", "GLenum")}} specifying which WebGL capability to disable. Possible values:

      ConstantDescription
      gl.BLENDDeactivates blending of the computed fragment color values. See {{domxref("WebGLRenderingContext.blendFunc()")}}.
      gl.CULL_FACEDeactivates culling of polygons. See {{domxref("WebGLRenderingContext.cullFace()")}}.
      gl.DEPTH_TESTDeactivates depth comparisons and updates to the depth buffer. See {{domxref("WebGLRenderingContext.depthFunc()")}}.
      gl.DITHERDeactivates dithering of color components before they get written to the color buffer.
      gl.POLYGON_OFFSET_FILLDeactivates adding an offset to depth values of polygon's fragments. See {{domxref("WebGLRenderingContext.polygonOffset()")}}.
      gl.SAMPLE_ALPHA_TO_COVERAGEDeactivates the computation of a temporary coverage value determined by the alpha value.
      gl.SAMPLE_COVERAGEDeactivates ANDing the fragment's coverage with the temporary coverage value. See {{domxref("WebGLRenderingContext.sampleCoverage()")}}.
      gl.SCISSOR_TESTDeactivates the scissor test that discards fragments that are outside of the scissor rectangle. See {{domxref("WebGLRenderingContext.scissor()")}}.
      gl.STENCIL_TESTDeactivates stencil testing and updates to the stencil buffer. See {{domxref("WebGLRenderingContext.stencilFunc()")}}.

      When using a {{domxref("WebGL2RenderingContext", "WebGL 2 context", "", 1)}}, the following values are available additionally:

      ConstantDescription
      gl.RASTERIZER_DISCARDDeactivates that primitives are discarded immediately before the rasterization stage, but after the optional transform feedback stage. gl.clear() commands are ignored.

Return value

None ({{jsxref("undefined")}}).

Examples

js
gl.disable(gl.DITHER);

To check if a capability is disabled, use the {{domxref("WebGLRenderingContext.isEnabled()")}} method:

js
gl.isEnabled(gl.DITHER);
// false

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

  • {{domxref("WebGLRenderingContext.enable()")}}
  • {{domxref("WebGLRenderingContext.isEnabled()")}}