HTMLCanvasElement: webglcontextcreationerror event

{{APIRef("WebGL API")}}

The webglcontextcreationerror event of the WebGL API is fired if the user agent is unable to create a {{domxref("WebGLRenderingContext")}} context.

This event has a {{domxref("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 {{domxref("EventTarget.addEventListener", "addEventListener()")}}, or set an event handler property.

addEventListener("webglcontextcreationerror", (event) => { })

onwebglcontextcreationerror = (event) => { }

Event type

A {{domxref("WebGLContextEvent")}}. Inherits from {{domxref("Event")}}.

{{InheritanceDiagram("WebGLContextEvent")}}

Event properties

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

• {{domxref("WebGLContextEvent.statusMessage")}}
  • : A read-only property containing additional information about the event.

Example

const canvas = document.getElementById("canvas");

canvas.addEventListener("webglcontextcreationerror", (e) => {
  console.log(e.statusMessage || "Unknown error");
});

const gl = canvas.getContext("webgl");
// logs statusMessage or "Unknown error" if unable to create WebGL context

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• {{domxref("WebGLContextEvent")}}
• {{domxref("WebGLRenderingContext.isContextLost()")}}
• {{domxref("WEBGL_lose_context")}}, {{domxref("WEBGL_lose_context.loseContext()")}}, {{domxref("WEBGL_lose_context.restoreContext()")}}