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 Servo
Basic Support9124.011125.1No support
Feature Android Chrome for Android Edge Mobile Firefox for Android IE Mobile Opera Mobile Safari Mobile
Basic Support(Yes)25(Yes)4.0128.1

See also

Document Tags and Contributors

 Contributors to this page: teoli, fscholz
 Last updated by: teoli,