Giter Club home page Giter Club logo

webpack-glsl-loader's Introduction

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 navinfo-webpack-glsl-loader

Usage

With require

N.B. As noted in the webpack documentation, you should avoid using this and use the configuration method in the next section.

require('navinfo-webpack-glsl-loader!./my-lovely-shader.glsl');

In configuration

{
    module: {
        loaders: [
            {
                test: /\.(vs|fs|glsl)$/,
                loader: 'navinfo-webpack-glsl-loader'
            }
        ]
    }
}

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=navinfo-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.glsl;

N.B. all imports within .glsl files include 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

webpack-glsl-loader's People

Contributors

grieve avatar

Watchers

James Cloos avatar 王屯 avatar 李万冲 avatar 徐杰 avatar 陈晓 avatar 吴振 avatar 马丽 avatar 赵航 avatar 王春梅 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.