WEBGL_lose_context: loseContext() method

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

It triggers the steps described in the WebGL specification for handling context lost. The context will remain lost until restoreContext() is called. It also destroys the underlying graphics context and all graphics resources. This is the recommended mechanism for applications to programmatically halt their use of the WebGL API.

Syntax

loseContext()

Parameters

None.

Return value

None (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

Browser compatibility

See also

• isContextLost()
• Events: webglcontextlost, webglcontextrestored, webglcontextcreationerror