gl-preserve-state

Caches specified GL state, runs a callback, and restores the cached state when done.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
gl-preserve-state
701.0.07 years ago7 years agoMinified + gzip package size for gl-preserve-state in KB

Readme

gl-preserve-state
Caches specified GL state, runs a callback, and restores the cached state when done.
Modularized from Brandon Jones' webgl-utils.

Install

$ npm install --save gl-preserve-state

Example usage:

var savedState = [
  gl.ARRAY_BUFFER_BINDING,

  // TEXTURE_BINDING_2D or _CUBE_MAP must always be followed by the texure unit.
  gl.TEXTURE_BINDING_2D, gl.TEXTURE0,

  gl.CLEAR_COLOR,
];
// After this call the array buffer, texture unit 0, active texture, and clear
// color will be restored. The viewport will remain changed, however, because
// gl.VIEWPORT was not included in the savedState list.
WGLUPreserveGLState(gl, savedState, function(gl) {
  gl.viewport(0, 0, gl.drawingBufferWidth, gl.drawingBufferHeight);

  gl.bindBuffer(gl.ARRAY_BUFFER, buffer);
  gl.bufferData(gl.ARRAY_BUFFER, ....);

  gl.activeTexture(gl.TEXTURE0);
  gl.bindTexture(gl.TEXTURE_2D, texture);
  gl.texImage2D(gl.TEXTURE_2D, ...);

  gl.clearColor(1, 0, 0, 1);
  gl.clear(gl.COLOR_BUFFER_BIT);
});

Note that this is not intended to be fast. Managing state in your own code to avoid redundant state setting and querying will always be faster. This function is most useful for cases where you may not have full control over the WebGL calls being made, such as tooling or effect injectors.

License

Copyright (c) 2016 Brandon Jones