ContextQMD
Back to Content

WEBGL_lose_context extension

files/en-us/web/api/webgl_lose_context/index.md

latest1.8 KB
Original Source

{{APIRef("WebGL")}}

The WEBGL_lose_context extension is part of the WebGL API and exposes functions to simulate losing and restoring a {{domxref("WebGLRenderingContext")}}.

WebGL extensions are available using the {{domxref("WebGLRenderingContext.getExtension()")}} method. For more information, see also Using Extensions in the WebGL tutorial.

[!NOTE] This extension is available to both, {{domxref("WebGLRenderingContext", "WebGL1", "", 1)}} and {{domxref("WebGL2RenderingContext", "WebGL2", "", 1)}} contexts.

Instance methods

  • {{domxref("WEBGL_lose_context.loseContext()")}}
    • : Simulates losing the context.
  • {{domxref("WEBGL_lose_context.restoreContext()")}}
    • : Simulates restoring the context.

Examples

With this extension, you can simulate the webglcontextlost and webglcontextrestored events:

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

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

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

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

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also