webpack-glsl-loader

A webpack loader for glsl shaders - includes support for nested imports.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
webpack-glsl-loader
1.0.19 years ago9 years agoMinified + gzip package size for webpack-glsl-loader in KB

Readme

Webpack loader for GLSL shaders
A glsl shader loader for webpack, includes support for nested imports, allowing for smart code reuse among more complex shader implementations. The shader is returned as a string.

Install

npm install --save-dev webpack-glsl-loader

Usage

With require

N.B. As noted in the webpack documentation(
http://webpack.github.io/docs/using-loaders.html#loaders-in-require), you should avoid using this and use the configuration method in the next section.
require('webpack-glsl!./my-lovely-shader.glsl`;

In configuration

{
    module: {
        loaders: [
            {
                test: /\.glsl$/,
                loader: 'webpack-glsl'
            }
        ]
    }
}

and then
require('./my-lovely-shader.glsl`;

On command line

You can also define the module extension bind on the command line if you are not using a configuration file (you probably should be though).
webpack --module-bind 'glsl=webpack-glsl'

Imports

This loader supports an import syntax to allow you to maximise your code reuse and keep those shaders DRY. This syntax is very similar to that of SASS.

Example

Example project structure:
src/
---- js/
---- ---- main.js
---- glsl/
---- ---- includes/
---- ---- ---- perlin-noise.glsl
---- ---- fragment.glsl

If I require my fragment shader inside main.js:
var shader = require('../glsl/fragment.glsl');

I can have that shader include other .glsl files inline, like so:
@import ./includes/perlin-noise;

N.B. all imports within .glsl files exclude the file extension and
are relative to the file doing the importing.
Imported files are parsed for @import statements as well, so you can nest imports as deep as you'd like (although, you should probably rethink your shader if you require any more than 2 levels).
Imported files are inserted directly into the source file in place of the @import statement and no special handling or error checking is provided. So, if you get syntax errors, please first check that shader works as one contiguous file before raising an issue.

TODO

  • Deduplicate imports, to prevent code clobbering and conflicts at runtime
  • Make loader file extension agnostic, to allow for you odd people who use
other extensions like .vert and .frag.