Options
All
  • Public
  • Public/Protected
  • All
Menu

@thi.ng/shader-ast-js

@thi.ng/shader-ast-js

npm (scoped) npm downloads Twitter Follow

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

About

JavaScript code generator, compiler & runtime for @thi.ng/shader-ast.

Due to lack of native vector operations in JS, this compile target is much more involved than GLSL 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)

Installation

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

Dependencies

Usage examples

Commented examples:

(Possibly non-exhaustive list, live demo links in readme's)

// 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

License

© 2018 Karsten Schmidt // Apache Software License 2.0

Generated using TypeDoc