Skip to content

Latest commit

 

History

History
92 lines (62 loc) · 2.01 KB

tpl.readme.md

File metadata and controls

92 lines (62 loc) · 2.01 KB

${pkg.banner}

npm version npm downloads Twitter Follow

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

About

${pkg.description}

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}

${supportPackages}

${relatedPackages}

${blogPosts}

Installation

${pkg.install}

${pkg.size}

Dependencies

${pkg.deps}

${examples}

API

${docLink}

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

${authors}

License

© ${copyright} // ${license}