The WebGLRenderingContext.getContextAttributes()
method returns a WebGLContextAttributes
object that contains the actual context parameters. Might return null
, if the context is lost.
Syntax
gl.getContextAttributes();
Return value
A WebGLContextAttributes
object that contains the actual context parameters, or null
if the context is lost.
Examples
Given this <canvas>
element
<canvas id="canvas"></canvas>
and given this WebGL context
var canvas = document.getElementById("canvas"); var gl = canvas.getContext("webgl"); gl.getContextAttributes();
the getContextAttributes
method returns an object that describes the attributes set on this context, for example:
{ alpha: true, antialias: true, depth: true, failIfMajorPerformanceCaveat: false, premultipliedAlpha: true, preserveDrawingBuffer: false, stencil: false }
The context attributes can be set when creating the context using the HTMLCanvasElement.getContext()
method:
canvas.getContext("webgl", { antialias: false, depth: false });
See getContext()
for more information about the individual attributes.
Specifications
Specification | Status | Comment |
---|---|---|
WebGL 1.0 The definition of 'WebGLRenderingContext.getContextAttributes' in that specification. |
Recommendation | Initial definition. |
Browser compatibility
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari |
---|---|---|---|---|---|
Basic support | 9 | 4.0 (2.0) | 11 | 12 | 5.1 |
Feature | Android | Chrome for Android | Firefox Mobile (Gecko) | IE Mobile | Opera Mobile | Safari Mobile |
---|---|---|---|---|---|---|
Basic support | (Yes) | 25 | 4.0 (2.0) | (Yes) | 12 | 8.1 |