glslang but in WebAssembly.

Checks your GLSL shaders for errors and compiles them via SPIR-V from JavaScript. Errors match glslangValidator.

• Nothing else to install and no unnecessary deps
• Handles OpenGL, Vulkan, ES, #include
• Runs in Node (used in glsl-vscode), browsers and web workers 🔗

[!NOTE] Built clean from Khronos glslang 16.6.0 and SPIRV-Cross, see compile.sh.

Usage

npm install glslang-wasm

// @ts-check
import { createGlslang } from 'glslang-wasm';

const glslang = await createGlslang();
const { diagnostics } = await glslang.check(source, { stage: 'fragment' });
const { spirv } = await glslang.compile(source, { stage: 'fragment' }); // Uint32Array
const { source: webgl, uniforms } = await glslang.crossCompile(spirv, { version: 300, es: true });

createGlslang(options?: {
  // glslang.wasm bytes - default reads glslang.wasm from next to glslang.js
  wasmBinary?: Uint8Array;
});

check(source: string, options: {
  stage: 'vertex' | 'tesscontrol' | 'tesseval' | 'geometry' | 'fragment' | 'compute'
    | 'raygen' | 'intersect' | 'anyhit' | 'closesthit' | 'miss' | 'callable' | 'task' | 'mesh';
  // File name shown in diagnostics, e.g. 'sky.frag' - default '0'
  name?: string;
  // Default none, vulkan for compile()
  client?: 'none' | 'opengl' | 'vulkan';
  // Version for source without #version line, e.g. 450 - default 100
  defaultVersion?: number;
  // Profile for source without #version line, e.g. 'core' - default none
  defaultProfile?: 'none' | 'core' | 'compatibility' | 'es';
  // Default 1.4
  vulkanVersion?: '1.0' | '1.1' | '1.2' | '1.3' | '1.4';
  // Default 1.6, 1.0 for opengl
  spirvVersion?: '1.0' | '1.1' | '1.2' | '1.3' | '1.4' | '1.5' | '1.6';
  // Code inserted after #version, e.g. '#define LIGHTS 4' - doesn't shift source line numbers
  preamble?: string;
  // Called for each #include, e.g. #include "common.glsl" in sky.frag calls:
  //   include('common.glsl', { includer: 'sky.frag', system: false, depth: 1 })
  //   returns { name: 'resolved/path/common.glsl', source: '...' } or undefined
  // system: true for #include <lib.glsl>, false for #include "lib.glsl"
  // Without it #include is an error
  include?: (header: string, context: { includer: string; system: boolean; depth: number })
    => { name: string; source: string } | undefined;
  // Also check shader as a whole, e.g. missing main() or function declared but never defined
  // Default false, compile() always links
  link?: boolean;
});

compile(source: string, options: {
  // Same as check() without link, plus:
  // Assign missing locations and bindings, e.g. loose `uniform float x;` with client opengl
  autoMap?: boolean;
});

crossCompile(spirv: Uint32Array, options: {
  // Output GLSL version, e.g. 300 for WebGL2
  version: number;
  es: boolean;
});
// Returns { source, uniforms, error }
// Uniform blocks and push constants become plain struct uniforms
// uniforms: [{ name: 'material.color', label: 'color', type: 'vec3', size: 1 }, ...]
// error: e.g. a feature the output version lacks

License

• MIT
• dist/ is under glslang, SPIRV-Cross, Emscripten, musl licenses