WEBGL_lose_context: loseContext() method

{{APIRef("WebGL")}}

The WEBGL_lose_context.loseContext() method is part of the WebGL API and allows you to simulate losing the context of a {{domxref("WebGLRenderingContext")}} context.

It triggers the steps described in the WebGL specification for handling context lost. The context will remain lost until {{domxref("WEBGL_lose_context.restoreContext()")}} is called.

Syntax

loseContext()

Parameters

None.

Return value

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

Examples

With this method, you can simulate the webglcontextlost event:

const canvas = document.getElementById("canvas");
const gl = canvas.getContext("webgl");

canvas.addEventListener("webglcontextlost", (e) => {
  console.log(e);
});

gl.getExtension("WEBGL_lose_context").loseContext();

// WebGLContextEvent event with type "webglcontextlost" is logged.

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• {{domxref("WebGLRenderingContext.isContextLost()")}}
• Events: webglcontextlost, webglcontextrestored, webglcontextcreationerror