W3cubDocs

/DOM

WebGLRenderingContext.getContextAttributes

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 Edge Firefox Internet Explorer Opera Safari
Basic support 9 12 4 11 12 5.1
Feature Android webview Chrome for Android Edge mobile Firefox for Android IE mobile Opera Android iOS Safari
Basic support Yes 25 Yes Yes 11 12 8.1

See also

© 2005–2018 Mozilla Developer Network and individual contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getContextAttributes