It forms one of the core components of the stack.gl
ecosystem, allowing you to install GLSL modules from npm and
use them in your shaders. This makes it trivial to piece together different
effects and techniques from the community, including but certainly not limited
to
fog,
noise,
film grain,
raymarching helpers,
easing functions and
lighting models.
A full list can be found on the stack.gl packages list
under the "Shader Components" category.
Because glslify just outputs a single shader file as a string, it's easy to use
it with any WebGL framework of your choosing,
provided they accept custom shaders. Integration is planned for
three.js and
pex, with more on the way!
Open an issue here if you'd like to
discuss integrating glslify with your platform of choice.
If you're interested in playing around with glslify, you should check out
glslb.in: it's a fragment shader sandbox similar to
Shadertoy and
GLSL Sandbox
with built in support for glslify.
Compile a shader using an inline shader string or a file name.
These are convencience methods provided that call glsl.compile() or
glsl.file() accordingly. These methods are also provided for backwards
compatibility with the previous < 6 interface.
Optionally provide:
opts.basedir - directory to resolve relative paths
opts.transform - an array of transform functions, transform module name
var src = glsl.compile(src, opts)
Compile a shader string from a string src.
opts.basedir - directory to resolve relative paths in src
opts.transform - an array of transform functions, transform module name
strings, or [trname,tropts] pairs
var src = glsl.file(filename, opts)
Compile a shader from a filename.
opts.basedir - directory to resolve relative paths in src
opts.transform - an array of transform functions, transform module name
strings, or [trname,tropts] pairs
Installation
To install the command-line interface, install glslify globally like
so:
npm install -g glslify
To install glslify for use as a browserify transform, you should
install it locally instead:
npm install glslify
Getting Started
CLI
The CLI can take a file as its first argument, and output to a file
using the -o flag:
glslify index.glsl -o output.glsl
It can also read input from stdin and output to stdout:
cat index.glsl | glslify > output.glsl
Browserify Transform
If using browserify from the command-line, simply pass glslify
in as a transform using the -t/--transform flag:
browserify -t glslify index.js -o bundle.js
Alternatively, you may include glslify as a browserify.transform
in your package.json file:
You can use glslify-babel as a Babel plugin. This allows you to use all ES6 features with glslify, including import statements and tagged template strings. Check out the repository to learn more.
:bulb: A Note on Babel Import/Export
If you are using Babel presets to transpile ES6 import/export to CommonJS require() statements, you may run into issues with glslify. This is because Babel mangles the output into source code that isn't easy to statically analyze. One solution is to directly map glslify to CommonJS statements, using babel-plugin-import-to-require in your .babelrc.
Usage
Installing a GLSL Module
Much like plain JavaScript modules, GLSL modules are stored on npm.
The main difference is that GLSL modules contain an index.glsl file
instead of an index.js. Generally, these modules start with glsl-
in their name.
Normally, glslify renames tokens to avoid conflicts across contexts. Sometimes, however, you want to reference the same thing from different contexts. The require function lets you explicitly fix reference names in order to guarantee that two different modules are talking about the same reference.
Give some-module access to locally declared bar whenever it looks for foo internally:
int bar;#pragma glslify: require('some-module',foo=bar,...)
It's important to make sure that bar has already been declared when you invoke #pragma glslify: require(...).
Now time for some imagination. Let's pretend that we have some float[500] arrays that we'd like to be summed up.
Here's a module that performs a reduction using a function map.
float accumulate(float list[N]) { float z = 0; for (int i = 0; i<N; i++) { z = map(z,list[i]); } return z;}#pragma glslify: export(accumulate)
But notice that this module doesn't actually declare const int N; or define a function map anywhere. We have to make sure they are already defined when we require the module, and pass their names along with the require function:
const int M = 500;float add(float a, float b){ return a+b; }#pragma glslify: sum500 = require('./accumulator.glsl',N=M,map=add)
The accumulator has been imported and glslified into a sum function. We can also multiply all of the floats in some float[17] arrays the same way:
const int M = 500;const int L = 17;float add(float a, float b){ return a+b; }float mul(float a, float b){ return a*b; }#pragma glslify: sum500 = require('./accumulator.glsl',N=M,map=add)#pragma glslify: product17 = require('./accumulator.glsl',N=L,map=mul)
Glsl-hash-blur is an example of a module that uses this feature.
Source Transforms
Source transforms are a feature inspired by browserify, allowing you to
modify your GLSL source at build time on a per-package basis. This is
useful both for transpilation (e.g. converting from or to
HLSL) or for
making incremental improvements to GLSL syntax. (e.g. you can use
glslify-hex to include CSS-style
hex strings for colors in place of vec3s).
There are three kinds of source transform:
Local transforms, the default. These are applied per-file, and only
applied to a single package. If you're defining it via the CLI using -t
it'll only apply itself to files outside of node_modules, but you
can include it in package.json too: these will be applied only to that
package without interfering with any of the package's parents or children.
Global transforms are applied after local transforms to every file,
regardless of whether or not it's a dependency.
Post transforms are applied to the entire output file once it's been
bundled. Generally, you want to reserve this for very specific use cases
such as whole-shader optimisation.
There are a number of ways to use a transform. Start by
installing it in your project:
npm install --save glslify-hex
The preferred way to enable a transform is through your project's
package.json file's glslify.transform property, like so: