Skip to content

Webpack loader for wgsl, wgslx, and wgsli files.

License

Notifications You must be signed in to change notification settings

wgslx/wgslx-loader

Repository files navigation

WGSLX Loader (wgslx-loader)

Webpack loader for wgsl, wgslx, and wgsli files. Load, validate, and minify WebGPU shaders with ease. Planned support for including other shader files.

import { code } from './shader.wgsl';

//...

const shaderModule = device.createShaderModule({ code });
/** Shader module. */
export interface WgslxShader {
  /** Shader source. */
  readonly code: string;

  /** Shader label derived from the file name. */
  readonly label?: string;

  /** Shader source map if configured to be generated. */
  readonly sourceMap?: string;
}

Installation

npm install --save-dev wgslx-loader

Usage

Install webpack loader for *.wgsl, *.wgslx, and *.wgsli files by adding the loader into your webpack config.

// webpack.config.js
module.exports = {
  module: {
    rules: [
      {
        test: /\.(wgsl[ix]?)$/,
        use: 'wgslx-loader',
      },
    ],
  },
};

Install types for *.wgsl, *.wgslx, and *.wgslxi files

// tsconfig.json
{
  "compilerOptions": {
    "types": ["@wgslx/wgslx-loader"]
  }
}

Releases

No releases published

Packages

No packages published