The WebGLRenderingContext.getContextAttributes() method returns a WebGLContextAttributes object that contains the actual context parameters. Might return null, if the context is lost.
On this page
WebGLRenderingContext: getContextAttributes() method
Syntax
js
getContextAttributes()
Parameters
None.
Return value
A WebGLContextAttributes object that contains the actual context parameters, or null if the context is lost.
Examples
Given this <canvas> element
html
<canvas id="canvas"></canvas>
and given this WebGL context
js
const canvas = document.getElementById("canvas");
const gl = canvas.getContext("webgl");
gl.getContextAttributes();
the getContextAttributes method returns an object that describes the attributes set on this context, for example:
js
{
alpha: true,
antialias: true,
depth: true,
failIfMajorPerformanceCaveat: false,
powerPreference: "default",
premultipliedAlpha: true,
preserveDrawingBuffer: false,
stencil: false,
desynchronized: false
}
The context attributes can be set when creating the context using the HTMLCanvasElement.getContext() method:
js
canvas.getContext("webgl", { antialias: false, depth: false });
See getContext() for more information about the individual attributes.
Specifications
| Specification |
|---|
| WebGL Specification # 5.14.2 |
Browser compatibility
| Desktop | Mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
getContextAttributes |
9 | 12 | 4 | 11 | 12 | 5.1 | 4.4.3 | 25 | 4 | 12 | 8 | 1.5 |
See also
© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getContextAttributes