webgl-context

2.2.0 • Public • Published

webgl-context

stable

Grabs a WebGLRenderingContext, returning null if it doesn't exist. Similar to 2d-context.

//get a webgl context, will be null if not found
var gl = require('webgl-context')()
 
if (gl) {
    document.body.appendChild(gl.canvas)
    //do something...
}

Or, with options:

//or with optional settings...
var gl = require('webgl-context')({
    canvas: canvas, //the canvas DOM element to use
    width: 400, //resizes the canvas..
    height: 200, 
    antialias: true //can specify custom attributes here
})

Usage

NPM

ctx = require('webgl-context')([opt])

Gets a new canvas context with optional parameters:

  • canvas a canvas element to use, otherwise creates a new element
  • width a width to set, otherwise no change
  • height a height to set, otherwise no change
  • other attributes are passed to the getContext call, like alpha and antialias

You can then get a reference of the canvas element with ctx.canvas.

See Also

License

MIT, see LICENSE.md for details.

Package Sidebar

Install

npm i webgl-context

Weekly Downloads

190,967

Version

2.2.0

License

MIT

Last publish

Collaborators

  • mattdesl