Giter Club home page Giter Club logo

ts-shader-loader's Introduction

Webpack loader for GLSL shaders

NPM

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.

Why fork

I had a problem using other webpack shader loaders with typescript. While i was investigating what is the problem, i forked and tried to make my version work with typescript. Other than support with typescript, it has no other benefits.

Quick Guide

1. Install

npm install --save-dev ts-shader-loader

2. Add to webpack configuration

{
    module: {
        rules: [
            {
                test: /\.(glsl|vs|fs)$/,
                loader: 'ts-shader-loader'
            }
        ]
    }
}

3. Declare shared files as modules

Create glsl.d.ts file in your project and add the following in to it:

declare module "*.glsl" {
  const value: string;
  export default value;
}

declare module "*.vs" {
  const value: string;
  export default value;
}

declare module "*.fs" {
  const value: string;
  export default value;
}

4. Import shaders

import myShader from './myShader.glsl';

console.log(myShader);

Includes

This loader supports #include "path/to/shader.glsl" syntax, which you can use inside your shaders.

Example

Example project structure:

src/
---- ts/
---- ---- main.ts
---- shaders/
---- ---- includes/
---- ---- ---- perlin-noise.glsl
---- ---- fragment.glsl

If we import fragment.glsl shader inside main.ts:

import shader from '../shaders/fragment.glsl';

We can have that shader include other .glsl files inline, like so:

#include "./includes/perlin-noise.glsl";

N.B. all includes within .glsl are relative to the file doing the importing.

Imported files are parsed for #include statements as well, so you can nest imports as deep as you'd like.

Imported files are inserted directly into the source file in place of the #include 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

ts-shader-loader's People

Contributors

github-actions[bot] avatar grieve avatar kokosin4ik avatar ludwigthepig avatar mentos1386 avatar pascal-so 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.