Bun Plugin GLSL

Import, inline (and minify) GLSL/WGSL shader files

Inspired by vite-plugin-glsl, compatible with Babylon.js, three.js and lygia.

Installation

bun add bun-plugin-glsl --dev

Usage

import glsl from 'bun-plugin-glsl';

Bun.plugin(glsl());

With TypeScript

Add extension declarations to your types in tsconfig.json:

{
  "compilerOptions": {
    "types": [
      "bun-plugin-glsl/ext"
    ]
  }
}

or as a package dependency directive to your global types:

/// <reference types="bun-plugin-glsl/ext" />

Default Options

glsl({
  include: /\.(glsl|wgsl|vert|frag|vs|fs)$/, // RegExp of file extensions to import
  removeDuplicatedImports: false,            // Automatically remove an already imported chunk
  warnDuplicatedImports: true,               // Warn if the same chunk was imported multiple times
  defaultExtension: 'glsl',                  // Shader suffix to use when no extension is specified
  importKeyword: '#include',                 // Keyword used to import shader chunks
  minify: false,                             // Minify/optimize output shader code
  watch: true,                               // Recompile shader on change
  root: '/'                                  // Directory for root imports
})