WEBGL_lose_context: restoreContext() method

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since April 2018.

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

It triggers the steps described in the WebGL specification for handling context restored. The context is not usable until the webglcontextrestored event is fired.

Syntax

js
restoreContext()

Parameters

None.

Return value

None (undefined).

Exceptions

Browsers may not report WebGL errors by default. WebGL's error reporting works by calling getError() and checking for errors. The following exceptions may be thrown:

INVALID_OPERATION

Thrown if the context was not lost.

Examples

With this method, you can simulate the webglcontextrestored event:

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

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

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

Specifications

Specification
WebGL WEBGL_lose_context Khronos Ratified Extension Specification

Browser compatibility

See also