node package manager
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

glsl-token-descope

glsl-token-descope

experimental

"Descope" an array of GLSL tokens such that they can be safely inlined alongside within another shader without causing any global variable conflicts.

Useful for modularising GLSL source files, e.g. as is done in glslify, but should be useful in other tools too.

Written with WebGL's GLSL syntax in mind – all the same, pull requests to support other variants would be much appreciated :)

Usage

NPM

descope(tokens, [rename(name)])

Takes an array of GLSL tokens produced by glsl-tokenizer and renames variables to avoid global conflicts by modifying their "data" property in-place.

For example:

var tokenize  = require('glsl-tokenizer/string')
var descope   = require('glsl-token-descope')
var stringify = require('glsl-token-string')
 
var src = `
precision mediump float;
 
uniform mat4  top1;
uniform float top2;
 
void main() {
  float x = 1.0;
  gl_FragColor = vec4(vec3(x), top2);
}
`.trim()
 
var tokens = tokenize(src)
 
console.log(stringify(descope(tokens)))

Which should rename main, top1 and top2 to result in this output:

precision mediump float;
 
uniform mat4  top1_0;
uniform float top2_1;
 
void main_2() {
  float x = 1.0;
  gl_FragColor = vec4(vec3(x), top2_1);
}

Optionally, you may pass in a custom rename function as descope's second argument to choose how you rename your variables. For example, adding a custom rename function to the previous function:

descope(tokens, function(name) {
  return 'a_' + name
})

Would result in the following shader:

precision mediump float;
 
uniform mat4  a_top1;
uniform float a_top2;
 
void a_main() {
  float x = 1.0;
  gl_FragColor = vec4(vec3(x), a_top2);
}

See Also

License

MIT. See LICENSE.md for details.