https://github.com/vanruesc/esbuild-plugin-glsl

A GLSL plugin for esbuild.
https://github.com/vanruesc/esbuild-plugin-glsl

Last synced: 13 days ago
JSON representation

A GLSL plugin for esbuild.

• Host: GitHub
• URL: https://github.com/vanruesc/esbuild-plugin-glsl
• Owner: vanruesc
• License: zlib
• Created: 2020-12-07T22:36:09.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-05-22T12:43:44.000Z (6 months ago)
• Last Synced: 2024-10-26T07:24:32.548Z (18 days ago)
• Language: TypeScript
• Homepage:
• Size: 245 KB
• Stars: 40
• Watchers: 2
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-esbuild - esbuild-plugin-glsl

README

        
# esbuild-plugin-glsl

[![CI](https://badgen.net/github/checks/vanruesc/esbuild-plugin-glsl/main)](https://github.com/vanruesc/esbuild-plugin-glsl/actions)

[![Version](https://badgen.net/npm/v/esbuild-plugin-glsl?color=green)](https://www.npmjs.com/package/esbuild-plugin-glsl)

An [esbuild](https://esbuild.github.io/) [plugin](https://esbuild.github.io/plugins/) that adds support for `.frag`, `.vert`, `.glsl` and `.wgsl` [file imports](https://esbuild.github.io/content-types/#text) with optional shader minification.

## Installation

```sh

npm install esbuild-plugin-glsl

```

## Usage

```js

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. | `false` |

| resolveIncludes | When enabled, shaders can include other shaders with the custom `#include "path"` directive. | `true`  |

### TypeScript

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

```ts

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.