WebGLContextEvent

Baseline Widely available

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

The WebContextEvent interface is part of the WebGL API and is an interface for an event that is generated in response to a status change to the WebGL rendering context.

Constructor

WebGLContextEvent(): Creates a new WebGLContextEvent object.

Instance properties

This interface inherits properties from its parent interface, Event.

WebGLContextEvent.statusMessage: A read-only property containing additional information about the event.

Instance methods

This interface doesn't define any own methods, but inherits methods from its parent interface, Event.

Examples

With the help of the WEBGL_lose_context extension, you can simulate the webglcontextlost and webglcontextrestored events:

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

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

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

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

Specifications

Specification
WebGL Specification # 5.15

Browser compatibility

BCD tables only load in the browser