var buffer = createBuffer(gl[, data, type, usage])
gl is a WebGL context
data is either an integer, an array, a typed array, an array buffer or an ndarray representing the data of the buffer. Default is 0
type is an optional parameter specifying the type of the webgl buffer. Default is gl.ARRAY_BUFFER.
usage is an optional parameter representing the intended usage for the buffer (in the WebGL sense). It is not clear this does anything in current WebGL implementations. Default gl.DYNAMIC_DRAW
Properties
buffer.gl
A reference to the buffer's WebGL context
buffer.handle
A handle to the underlying WebGLBuffer object
buffer.type
The type of the buffer (either gl.ARRAY_BUFFER or gl.ELEMENT_ARRAY_BUFFER)
buffer.length
The size of the buffer in bytes
buffer.usage
The internal WebGL usage for the buffer.
Methods
buffer.bind()
Binds the buffer to the appropriate target. Equivalent to gl.bindBuffer( ... )
buffer.dispose()
Deletes the buffer releasing all associated resources. Equivalent to gl.deleteBuffer(...)
buffer.update(data[, offset])
Updates the data in the buffer. There are two basic modes to this function. In the first, it calls gl.bufferSubData to update a portion of the buffer in place, and in the second it calls gl.bufferData to completely resize the buffer.
data the new data to add to the buffer. This follows the same semantics as in the constructor.
offset the offset in bytes to copy data into the buffer from or if unspecified then the buffer is resized by calling gl.bufferData instead of gl.bufferSubData. Default 0.