gl-vao

gl-vao

Vertex array object wrapper and shim for WebGL

Example

Try out the demo in your browser

var shell = require("gl-now")()
var createBuffer = require("gl-buffer")
var createVAO = require("gl-vao")
var createSimpleShader = require("simple-2d-shader")

var vao, shader

shell.on("gl-init", function() {
  var gl = shell.gl
  
  shader = createSimpleShader(gl)
  
  //Create vertex array object
  vao = createVAO(gl, [
    { "buffer": createBuffer(gl, [-1, 0, 0, -1, 1, 1]),
      "type": gl.FLOAT,
      "size": 2,
      "offset": 0,
      "stride": 0,
      "normalized": false
    },
    [0.8, 1, 0.5]
  ])
})

shell.on("gl-render", function(t) {
  var gl = shell.gl

  shader.bind()
  
  //Bind vertex array object and set locations
  vao.bind()
  shader.attributes.position.location = 0
  shader.attributes.color.location = 1

  //Draw stuff
  vao.draw(gl.TRIANGLES, 3)
  
  //Unbind vertex array when fini
  vao.unbind()
})

Assuming everything worked, here is what it should look like:

<img src=https://raw.github.com/mikolalysenko/gl-vao/master/images/screenshot.png>

Install

Use npm:

npm install gl-vao

To compile demos in for your browser try browserify or beefy.

API

var createVAO = require("gl-vao")

var vao = createVAO(gl, attributes[, elements])

Creates a vertex array object

• gl is the gl context in which the vertex array object is created

• attributes is an array of objects that give the attributes bound to particular locations starting at 0. Each of these attributes is either an array-like object of length 4 or less representing a constant attribute value, or else it is an object with the following properties that correspond to the parameters passed to gl.vertexAttribPointer

  • buffer a gl-buffer object encoding a webgl buffer
  • size the size of the attribute (default 4)
  • type the type of the attribute (default gl.FLOAT)
  • normalized a flag that checks whether the attribute should be normalized or not
  • stride the stride of the attribute in bytes (default 0)
  • offset offset to the start of the attribute in the buffer in bytes (default 0)

• elements is a buffer created using gl-buffer encoding the state of the vertex elements

vao.bind()

Binds the vertex array object to the active vertex state.

vao.unbind()

Unbinds the vertex array object.

Note You should call this method before switching back to using vertex arrays and buffers as usual. Failing to do so can cause the state of the vertex array object to become corrupted. However, it is acceptable to skip the unbind step if another vertex array object is immediately bound.

vao.draw(mode, count[, offset])

Draws the vertex array object.

• mode is the mode to use when drawing the buffer, for example gl.TRIANGLES, gl.LINES, etc.
• count is the number of vertices to draw.
• offset is the offset to start drawing from. Default 0

vao.update(attributes[, elements])

Updates the contents of the vertex array object using the same syntax and conventions as the constructor.

vao.dispose()

Destroys the vertex array object and releases all of its resources.

Credits

(c) 2013 Mikola Lysenko. MIT License