包详细信息

esbuild-plugin-glsl

vanruesc6.6kZlib1.4.0

An esbuild plugin that adds support for shader imports.

esbuild, plugin, glsl, frag

自述文件

esbuild-plugin-glsl

CI Version

An esbuild plugin that adds support for .frag, .vert, .glsl and .wgsl file imports with optional shader minification.

Installation

npm install esbuild-plugin-glsl

Usage

import { build } from "esbuild";
import { glsl } from "esbuild-plugin-glsl";

build({
    entryPoints: ["input.js"],
    outfile: "output.js",
    bundle: true,
    plugins: [glsl({
        minify: true
    })]
});

Options

Option Description Default
minify Enables or disables basic shader minification. follows minify
resolveIncludes When enabled, shaders can include other shaders with the custom #include "path" directive. true
preserveLegalComments Preserves comments that start with //! or /*! or include @license or @preserve. follows legal-comments

TypeScript

To make the TypeScript compiler know how to handle shader sources, add a shaders.d.ts ambient declaration file to your project:

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

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

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

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

Contributing

Use the issue tracker to propose and discuss changes. Maintain the existing coding style. Lint and test your code.