Web/API/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, 
  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:

canvas.getContext('webgl',
                 { antialias: false,
                   depth: false });

See getContext() for more information about the individual attributes.

Specifications

Specification	Status	Comment
WebGL 1.0The definition of 'WebGLRenderingContext.getContextAttributes' in that specification.	Recommendation	Initial definition.

Browser compatibility

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`getContextAttributes`	Chrome Full support 9	Edge Full support 12	Firefox Full support 4	IE Full support 11	Opera Full support 12	Safari Full support 5.1	WebView Android Full support Yes	Chrome Android Full support 25	Firefox Android Full support Yes	Opera Android Full support 12	Safari iOS Full support 8	Samsung Internet Android Full support 1.5

Legend

Full support: Full support