ContextQMD
Back to Content

WebGLContextEvent

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

latest1.9 KB
Original Source

{{APIRef("WebGL")}}{{AvailableInWorkers}}

The WebGLContextEvent 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.

{{InheritanceDiagram}}

Constructor

  • {{domxref("WebGLContextEvent.WebGLContextEvent", "WebGLContextEvent()")}}
    • : Creates a new WebGLContextEvent object.

Instance properties

This interface inherits properties from its parent interface, {{domxref("Event")}}.

  • {{domxref("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, {{domxref("Event")}}.

Examples

With the help of the {{domxref("WEBGL_lose_context")}} extension, you can simulate the {{domxref("HTMLCanvasElement/webglcontextlost_event", "webglcontextlost")}} and {{domxref("HTMLCanvasElement/webglcontextrestored_event", "webglcontextrestored")}} events:

js
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