threeify-glsl-transpiler

A glsl to JS module transpiler.

threeify-glsl-transpiler is glsl to JS module transpiler. It is part of the threeify ecosystem.

The purpose of this is to allow one to use raw glsl files in JavaScript in the most easy fashion possible. Keeping glsl files as *.glsl files has the benefits that syntax highlighers work out of the box as do linters. This allows one to maximize their productivity.

Usage

Usage: threeify-glsl-transpiler [options]

Options:
  -V, --version               output the version number
  -p, --projectDir <dirpath>  the root of the project directory tree
  -r, --rootDir <dirpath>     the root of the source directory tree
  -o, --outDir <dirpath>      the root of the output directory tree
  -w, --watch                 watch and incremental transpile any changed files
  -j, --allowJSIncludes       allow referencing javascript and typescript code via includes
  -m, --minify                reduce the size of the glsl code
  -e, --extensions <items>    comma separated list of extensions to transpile
  -v, --verboseLevel <level>  higher numbers means more output
  -h, --help                  display help for command

You can also use a threeify.json configuration file in the root of your project:

{
  "glsl": {
    "rootDir": "./src",
    "outDir": "./dist",
    "extensions": ["glsl", "frag", "vert"],
    "minify": true,
    "allowJSIncludes": true,
    "verboseLevel": 0
  }
}

Build

Just run it to transform all glsl files from the input directory into the corresponding glsl.js JavaScript modules in the output directory.

yarn start -p ../threeify

Watch

To have the transpiler constantly run and transpile files incrementally on change use the watch option:

yarn start -p ../threeify -w

Features

• Allow you to keep your glsl files in raw glsl.
• Convert glsl files into JavaScript modules.
• Mix JS generated glsl with raw glsl files.
• Support "#pragma once" include guard creation.
• Incremental updates when in watch mode.

Example

An original rgbe.glsl file:

#pragma once
#pragma include "../../math/math.glsl"

vec4 rgbeToLinear( in vec4 value ) {
	return vec4( value.rgb * exp2( value.a * 255.0 - 128.0 ), 1.0 );
}

vec4 linearToRGBE( in vec4 value ) {
	float maxComponent = max( max( value.r, value.g ), value.b );
	float fExp = clamp( ceil( log2( maxComponent ) ), -128.0, 127.0 );
	return vec4( value.rgb / exp2( fExp ), ( fExp + 128.0 ) / 255.0 );
}

Will be transformed into a rgbe.glsl.js JavaScript module:

import _renderers_webgl2_shaders_includes_math_math_glsl from "../../math/math.glsl.js";

export default /* glsl */ `
#ifndef _renderers_webgl2_shaders_includes_color_spaces_rgbe_glsl // start of include guard
#define _renderers_webgl2_shaders_includes_color_spaces_rgbe_glsl

${_renderers_webgl2_shaders_includes_math_math_glsl}

vec4 rgbeToLinear( in vec4 value ) {
	return vec4( value.rgb * exp2( value.a * 255.0 - 128.0 ), 1.0 );
}

vec4 linearToRGBE( in vec4 value ) {
	float maxComponent = max( max( value.r, value.g ), value.b );
	float fExp = clamp( ceil( log2( maxComponent ) ), -128.0, 127.0 );
	return vec4( value.rgb / exp2( fExp ), ( fExp + 128.0 ) / 255.0 );
}

#endif // end of include guard
`;

Which you can use in your JavaScript code via:

import rgbe_code from "rgbe.glsl.js";

console.log(rgbe_cole);