JSPM – @thi.ng/shader-ast-js@0.7.12

Package Exports

@thi.ng/shader-ast-js
@thi.ng/shader-ast-js/api
@thi.ng/shader-ast-js/env
@thi.ng/shader-ast-js/env/bvec
@thi.ng/shader-ast-js/env/float
@thi.ng/shader-ast-js/env/int
@thi.ng/shader-ast-js/env/ivec2
@thi.ng/shader-ast-js/env/ivec3
@thi.ng/shader-ast-js/env/ivec4
@thi.ng/shader-ast-js/env/mat2
@thi.ng/shader-ast-js/env/mat3
@thi.ng/shader-ast-js/env/mat4
@thi.ng/shader-ast-js/env/uint
@thi.ng/shader-ast-js/env/uvec2
@thi.ng/shader-ast-js/env/uvec3
@thi.ng/shader-ast-js/env/uvec4
@thi.ng/shader-ast-js/env/vec2
@thi.ng/shader-ast-js/env/vec3
@thi.ng/shader-ast-js/env/vec4
@thi.ng/shader-ast-js/runtime
@thi.ng/shader-ast-js/target

Readme

npm downloads

This project is part of the @thi.ng/umbrella monorepo.

About
Installation
Dependencies
Usage examples
API
Authors
License

About

Customizable JS codegen, compiler & runtime for @thi.ng/shader-ast.

Due to the lack of native vector operations in JS, this compile target is much more involved than the @thi.ng/shader-ast-glsl code gen and uses a pluggable backend to perform all math ops. The default backend delegates all ops to @thi.ng/vectors and @thi.ng/matrices, which altogether provide ~750 optimized vector/matrix functions.

Unsupported features

texture lookups (see texture tunnel demo for a monkey-patched solution)
derivatives (dFdx, dFdy, fwidth) - probably never supported in this env
out / inout function args (see #96 for discussion)

Status

STABLE - used in production

Search or submit any issues for this package

@thi.ng/shader-ast-glsl - Customizable GLSL codegen for @thi.ng/shader-ast
@thi.ng/shader-ast-stdlib - Function collection for modular GPGPU / shader programming with @thi.ng/shader-ast

Installation

yarn add @thi.ng/shader-ast-js

ES module import:

<script type="module" src="https://cdn.skypack.dev/@thi.ng/shader-ast-js"></script>

Skypack documentation

For Node.js REPL:

# with flag only for < v16
node --experimental-repl-await

> const shaderAstJs = await import("@thi.ng/shader-ast-js");

Package sizes (gzipped, pre-treeshake): ESM: 7.21 KB

Dependencies

Usage examples

Several demos in this repo's /examples directory are using this package.

A selection:

Description	Live demo	Source
2D canvas shader emulation	Demo	Source
HOF shader procedural noise function composition	Demo	Source
WebGL & JS canvas2D raymarch shader cross-compilation	Demo	Source
WebGL & JS canvas 2D SDF	Demo	Source
WebGL & Canvas2D textured tunnel shader	Demo	Source
Fork-join worker-based raymarch renderer (JS/CPU only)	Demo	Source

API

Generated API docs

// AST node functions from main shader-ast pkg
import {
    mul,
    defn,
    float,
    ret,
    vec3
} from "@thi.ng/shader-ast";

// codegen / compiler
import { targetJS } from "@thi.ng/shader-ast-js";

const js = targetJS();

const hello = defn("vec4", "hello", ["float"], (n) => [
    ret(vec4(mul(vec3(1, 2, 3), n), -1))
]);

js(hello)

const Module = js.compile(hello);
Module.hello(10);
// [10, 20, 30, -1]

Authors

Karsten Schmidt

If this project contributes to an academic publication, please cite it as:

@misc{thing-shader-ast-js,
  title = "@thi.ng/shader-ast-js",
  author = "Karsten Schmidt",
  note = "https://thi.ng/shader-ast-js",
  year = 2019
}

@thi.ng/shader-ast-js