HTMLCanvasElement: webglcontextcreationerror event
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 webglcontextcreationerror
event of the WebGL API is fired if the user agent is unable to create a WebGLRenderingContext
context.
This event has a WebGLContextEvent.statusMessage
property, which can contain a platform dependent string with more information about the failure.
This event does not bubble.
Syntax
Use the event name in methods like addEventListener()
, or set an event handler property.
js
addEventListener("webglcontextcreationerror", (event) => {});
onwebglcontextcreationerror = (event) => {};
Event type
A WebGLContextEvent
. Inherits from Event
.
Event properties
This interface inherits properties from its parent interface, Event
.
WebGLContextEvent.statusMessage
-
A read-only property containing additional information about the event.
Example
js
const canvas = document.getElementById("canvas");
canvas.addEventListener(
"webglcontextcreationerror",
(e) => {
console.log(e.statusMessage || "Unknown error");
},
false,
);
const gl = canvas.getContext("webgl");
// logs statusMessage or "Unknown error" if unable to create WebGL context
Specifications
Specification |
---|
WebGL Specification # 5.15.4 |
Browser compatibility
BCD tables only load in the browser