@thi.ng/shader-ast-stdlib

# ![@thi.ng/shader-ast-stdlib](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/banners/thing-shader-ast-stdlib.svg?29e3203a) [![npm version](https://img.shields.io/npm/v/@thi.ng/shader-ast-stdlib.svg)](https://www.npmjs.com/package/@thi.ng/shader-ast-stdlib) ![npm downloads](https://img.shields.io/npm/dm/@thi.ng/shader-ast-stdlib.svg) [![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi) > [!NOTE] > This is one of 210 standalone projects, maintained as part > of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo > and anti-framework. > > 🚀 Please help me to work full-time on these projects by [sponsoring me on > GitHub](https://github.com/sponsors/postspectacular). Thank you! ❤️ - [About](#about) - [Status](#status) - [Related packages](#related-packages) - [Installation](#installation) - [Dependencies](#dependencies) - [Usage examples](#usage-examples) - [API](#api) - [Basic Lambert shader](#basic-lambert-shader) - [Generated vertex shader](#generated-vertex-shader) - [Generated fragment shader](#generated-fragment-shader) - [Using higher order functions](#using-higher-order-functions) - [API](#api) - [Color](#color) - [Porter-Duff alpha blending](#porter-duff-alpha-blending) - [Fog](#fog) - [Intersection tests](#intersection-tests) - [Lighting](#lighting) - [Math](#math) - [Easing functions](#easing-functions) - [Oscillators](#oscillators) - [Matrix operations](#matrix-operations) - [Noise / randomness](#noise--randomness) - [Raymarching](#raymarching) - [Screen coordinates](#screen-coordinates) - [Signed Distance Fields](#signed-distance-fields) - [Primitives](#primitives) - [Polyhedra](#polyhedra) - [Operators / combinators](#operators--combinators) - [Texture lookups](#texture-lookups) - [Visualization](#visualization) - [Authors](#authors) - [License](#license) ## About Function collection for modular GPGPU / shader programming with [@thi.ng/shader-ast](https://github.com/thi-ng/umbrella/tree/develop/packages/shader-ast). A growing collection (currently ~230) of useful functions & higher order constructs (incl. meta programming approaches) for GPU / shader programming, acting as optional standard library for [@thi.ng/shader-ast](https://github.com/thi-ng/umbrella/tree/develop/packages/shader-ast) based workflows. These functions can be imported like normal TS/JS functions and (in TS) are fully type checked. Some of the functions have been ported from GLSL: - Signed Distance Field primitives and operations are based on work by Inigo Quilezles (iq), HG_SDF (Mercury). - Hash functions (PRNGs) by Dave Hoskins - Noise functions by Ashima Arts / Stefan Gustavson - Various other functions ported from thi.ng/shadergraph, thi.ng/vectors, thi.ng/matrices, thi.ng/color, thi.ng/dsp Reference: - http://www.iquilezles.org/www/articles/distfunctions2d/distfunctions2d.htm - http://www.iquilezles.org/www/articles/distfunctions/distfunctions.htm - http://mercury.sexy/hg_sdf/ - https://www.shadertoy.com/view/4djSRW - https://github.com/ashima/webgl-noise ## Status **STABLE** - used in production [Search or submit any issues for this package](https://github.com/thi-ng/umbrella/issues?q=%5Bshader-ast-stdlib%5D+in%3Atitle) ## Related packages - [@thi.ng/shader-ast-glsl](https://github.com/thi-ng/umbrella/tree/develop/packages/shader-ast-glsl) - Customizable GLSL codegen for [@thi.ng/shader-ast](https://github.com/thi-ng/umbrella/tree/develop/packages/shader-ast) - [@thi.ng/shader-ast-js](https://github.com/thi-ng/umbrella/tree/develop/packages/shader-ast-js) - Customizable JS codegen, compiler & runtime for [@thi.ng/shader-ast](https://github.com/thi-ng/umbrella/tree/develop/packages/shader-ast) - [@thi.ng/webgl](https://github.com/thi-ng/umbrella/tree/develop/packages/webgl) - WebGL & GLSL abstraction layer ## Installation ```bash yarn add @thi.ng/shader-ast-stdlib ``` ESM import: ```ts import * as std from "@thi.ng/shader-ast-stdlib"; ``` Browser ESM import: ```html <script type="module" src="https://esm.run/@thi.ng/shader-ast-stdlib"></script> ``` [JSDelivr documentation](https://www.jsdelivr.com/) For Node.js REPL: ```js const std = await import("@thi.ng/shader-ast-stdlib"); ``` Package sizes (brotli'd, pre-treeshake): ESM: 14.03 KB ## Dependencies - [@thi.ng/api](https://github.com/thi-ng/umbrella/tree/develop/packages/api) - [@thi.ng/shader-ast](https://github.com/thi-ng/umbrella/tree/develop/packages/shader-ast) Note: @thi.ng/api is in _most_ cases a type-only import (not used at runtime) ## Usage examples 14 projects in this repo's [/examples](https://github.com/thi-ng/umbrella/tree/develop/examples) directory are using this package: | Screenshot | Description | Live demo | Source | |:-----------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------|:----------------------------------------------------------|:---------------------------------------------------------------------------------------| | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/ascii-raymarch.jpg" width="240"/> | ASCII art raymarching with thi.ng/shader-ast & thi.ng/text-canvas | [Demo](https://demo.thi.ng/umbrella/ascii-raymarch/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/ascii-raymarch) | | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/shader-ast/shader-ast-01.jpg" width="240"/> | 2D canvas shader emulation | [Demo](https://demo.thi.ng/umbrella/shader-ast-canvas2d/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/shader-ast-canvas2d) | | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/shader-ast-easings.png" width="240"/> | Shader-AST meta-programming techniques for animated function plots | [Demo](https://demo.thi.ng/umbrella/shader-ast-easings/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/shader-ast-easings) | | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/shader-ast-evo.jpg" width="240"/> | Evolutionary shader generation using genetic programming | [Demo](https://demo.thi.ng/umbrella/shader-ast-evo/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/shader-ast-evo) | | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/shader-ast-noise.jpg" width="240"/> | HOF shader procedural noise function composition | [Demo](https://demo.thi.ng/umbrella/shader-ast-noise/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/shader-ast-noise) | | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/shader-ast/shader-ast-raymarch.jpg" width="240"/> | WebGL & JS canvas2D raymarch shader cross-compilation | [Demo](https://demo.thi.ng/umbrella/shader-ast-raymarch/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/shader-ast-raymarch) | | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/shader-ast-sdf2d.jpg" width="240"/> | WebGL & JS canvas 2D SDF | [Demo](https://demo.thi.ng/umbrella/shader-ast-sdf2d/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/shader-ast-sdf2d) | | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/shader-ast-tunnel.jpg" width="240"/> | WebGL & Canvas2D textured tunnel shader | [Demo](https://demo.thi.ng/umbrella/shader-ast-tunnel/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/shader-ast-tunnel) | | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/shader-ast-workers.jpg" width="240"/> | Fork-join worker-based raymarch renderer (JS/CPU only) | [Demo](https://demo.thi.ng/umbrella/shader-ast-workers/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/shader-ast-workers) | | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/viz-ridge-lines.avif" width="240"/> | Interactive ridge-line plot | [Demo](https://demo.thi.ng/umbrella/viz-ridge-lines/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/viz-ridge-lines) | | | Minimal multi-pass / GPGPU example | [Demo](https://demo.thi.ng/umbrella/webgl-multipass/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/webgl-multipass) | | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/webgl-shadertoy.jpg" width="240"/> | Shadertoy-like WebGL setup | [Demo](https://demo.thi.ng/umbrella/webgl-shadertoy/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/webgl-shadertoy) | | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/webgl-ssao.jpg" width="240"/> | WebGL screenspace ambient occlusion | [Demo](https://demo.thi.ng/umbrella/webgl-ssao/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/webgl-ssao) | | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/webgl-texture-paint.jpg" width="240"/> | Interactively drawing to & reading from a WebGL offscreen render texture | [Demo](https://demo.thi.ng/umbrella/webgl-texture-paint/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/webgl-texture-paint) | ## API [Generated API docs](https://docs.thi.ng/umbrella/shader-ast-stdlib/) ### Basic Lambert shader Below is a brief demonstration of a fully defined shader pair, implementing basic diffuse lighting: ```ts import { assign, defMain, vec4 } from "@thi.ng/shader-ast"; import { diffuseLighting, halfLambert, transformMVP } from "@thi.ng/shader-ast-stdlib"; import { shader } from "@thi.ng/webgl"; // obtain WebGL/WebGL2 context // the generated shader code will automatically target the right GLSL version const gl = ... // transpile & instantiate fully working shader const myShader = shader(gl, { // vertex shader fn // given args are symbolic uniforms, attribs, varyings & GL builtin vars // here `ins` are vertex attribs and `outs` are "varying" vs: (gl, unis, ins, outs) => [ defMain(() => [ assign(outs.vnormal, ins.normal), assign(gl.gl_Position, transformMVP(ins.position, unis.model, unis.view, unis.proj)), ]) ], // fragment shader fn // here `ins` are "varying" & `outs` are output variables fs: (gl, unis, ins, outs) => [ defMain(() => [ assign( outs.fragCol, vec4( diffuseLighting( halfLambert(normalize(ins.vnormal), unis.lightDir), unis.diffuseCol, unis.lightCol, unis.ambientCol ), 1 ) ) ]) ], // attribs w/ optional location info attribs: { position: ["vec3", 0], normal: ["vec3", 1] }, varying: { vnormal: "vec3" }, // uniforms with optional default values / functions uniforms: { model: "mat4", view: "mat4", proj: "mat4", lightDir: ["vec3", [0, 1, 0]], lightCol: ["vec3", [1, 1, 1]], diffuseCol: ["vec3", [0.8, 0, 0]], ambientCol: ["vec3", [0.1, 0.1, 0.1]] } }); ``` ### Generated vertex shader The `#define`s are auto-injected by default, but can be disabled / customized / replaced... ```glsl #version 300 es #ifdef GL_FRAGMENT_PRECISION_HIGH precision highp int; precision highp float; #else precision mediump int; precision mediump float; #endif #ifndef PI #define PI 3.141592653589793 #endif #ifndef TAU #define TAU 6.283185307179586 #endif #ifndef HALF_PI #define HALF_PI 1.570796326794896 #endif uniform mat4 model; uniform mat4 view; uniform mat4 proj; uniform vec3 lightDir; uniform vec3 lightCol; uniform vec3 diffuseCol; uniform vec3 ambientCol; layout(location=0) in vec3 position; layout(location=1) in vec3 normal; out vec3 vnormal; void main() { vnormal = normal; gl_Position = ((proj * (view * model)) * vec4(position, 1.0)); } ``` ### Generated fragment shader The `fragColor` output variable is auto-created by [@thi.ng/webgl](https://github.com/thi-ng/umbrella/tree/develop/packages/webgl) if no other output vars are defined. For WebGL v1 this is defined as an alias for `gl_FragColor`... ```glsl #version 300 es /* (omitting #define's for brevity, same as in VS) */ uniform mat4 model; uniform mat4 view; uniform mat4 proj; uniform vec3 lightDir; uniform vec3 lightCol; uniform vec3 diffuseCol; uniform vec3 ambientCol; in vec3 vnormal; layout(location=0) out vec4 fragColor; void main() { fragColor = vec4((((lightCol * ((dot(normalize(vnormal), lightDir) * 0.5) + 0.5)) * diffuseCol) + ambientCol), 1.0); } ``` ### Using higher order functions Several of the functions included here are defined as higher-order functions, providing powerful functional compositional features not usually seen in shader code and not easily achievable via the usual string templating approach used by most other GLSL libraries. For example, the [`additive()`](https://docs.thi.ng/umbrella/shader-ast-stdlib/functions/additive.html) HOF takes a single-arg scalar function and a number of octaves. It returns a new function which computes the summed value of `fn` over the given number octaves, with a user defined phase shift & decay factor (per octave). This can be used for additive wave synthesis, multi-octave noise or any other similar use cases... Due to the way user defined AST functions keep track of their own call graph, the anonymous function returned by `additive` does not need to be pre-declared in any way and also ensures all of its own function dependencies are resolved and emitted in the correct topological order during later code generation. Below is the main shader code of the [Simplex noise example](https://github.com/thi-ng/umbrella/tree/develop/examples/shader-ast-noise). ```ts import { add, defn, float, ret, sym, vec2, vec3, vec4 } from "@thi.ng/shader-ast"; import { additive, aspectCorrectedUV, fit1101, snoise2 } from "@thi.ng/shader-ast-stdlib"; const mainImage = defn( "vec4", "mainImage", ["vec2", "vec2", "float"], (frag, res, time) => { let uv; let noise; return [ // compute UV coords and assign to `uv` uv = sym(aspectCorrectedUV(frag, res)), // dynamically create a multi-octave version of `snoise2` // computed over 4 octaves w/ given phase shift and decay // factor (both per octave) noise = sym( additive("vec2", snoise2, 4)(add(uv, time), vec2(2), float(0.5)) ), // `noise` is in [-1..1] interval, use fit1101 to fit to [0..1] ret(vec4(vec3(fit1101(noise)), 1)) ]; } ); ``` Run the above-linked example and view the console to see the full generated shader code. Also check out the raymarching demo which uses several other HOFs from this library to drastically simplify user code. ## API [Generated API docs](https://docs.thi.ng/umbrella/shader-ast-stdlib/) ### Color [/src/color](https://github.com/thi-ng/umbrella/tree/develop/packages/shader-ast-stdlib/src/color/) - `ACESFilm` (tone mapping) - `cosineGradient` - `levelAdjustGamma` / `levelAdjustGammaRGB` - `levelAdjustMid` / `levelAdjustMidRGB` - `luminanceRGB` - `midLevelGamma` / `midLevelGammaRGB` - `toLinear` - `toSRGB` - `decodeRGBE` ### Porter-Duff alpha blending Use the `porterDuff` higher order function to define new blend modes. See [@thi.ng/porter-duff](https://github.com/thi-ng/umbrella/tree/develop/packages/porter-duff) for reference. 12 standard PD operators for `vec4` RGBA colors: - `blendSrcOver` - `blendDestOver` - `blendSrcIn` - `blendDestIn` - `blendSrcOut` - `blendDestOut` - `blendSrcAtop` - `blendDestAtop` - `blendXor` - `blendPlus` Related: - `premultiplyAlpha` / `postmultiplyAlpha` ### Fog [/src/fog](https://github.com/thi-ng/umbrella/tree/develop/packages/shader-ast-stdlib/src/fog/) - `fogLinear` - `fogExp` - `fogExp2` ### Intersection tests [/src/isec](https://github.com/thi-ng/umbrella/tree/develop/packages/shader-ast-stdlib/src/isec/) - `isPointInCircle` - `isPointInRect` ### Lighting [/src/light](https://github.com/thi-ng/umbrella/tree/develop/packages/shader-ast-stdlib/src/light/) - `lambert` - `halfLambert` - `diffuseLighting` - `trilight` ### Math [/src/math](https://github.com/thi-ng/umbrella/tree/develop/packages/shader-ast-stdlib/src/math/) - `additive` - `cartesian2` / `cartesian3` - `clamp01` / `clamp11` - `cross2` / `crossC2` - `distChebyshev2` / `distChebyshev3` / `distChebyshev4` - `distManhattan2` / `distManhattan3` / `distManhattan4` - `fit01` / `fit11` / `fit1101` / `fit0111` - `magSq2` / `magSq3` / `magSq4` - `maxComp2` / `maxComp3` / `maxComp4` - `minComp2` / `minComp3` / `minComp4` - `perpendicularCCW` / `perpendicularCW` - `orthogonal3` - `packFloat` / `unpackFloat` - `polar2` / `polar3` - `sincos` / `cossin` - `smootherStep` / `smootherStep2` / `smootherStep3` / `smootherStep4` - `smootherStep01` / `smootherStep01_2` / `smootherStep01_3` / `smootherStep01_4` ### Easing functions [/src/math/easing.ts](https://github.com/thi-ng/umbrella/tree/develop/packages/shader-ast-stdlib/src/math/easing.ts) - `easeInBack` / `easeOutBack` / `easeInOutBack` - `easeInBounce` / `easeOutBounce` / `easeInOutBounce` - `easeInCirc` / `easeOutCirc` / `easeInOutCirc` - `easeInCubic` / `easeOutCubic` / `easeInOutCubic` - `easeInElastic` / `easeOutElastic` / `easeInOutElastic` - `easeInExpo` / `easeOutExpo` / `easeInOutExpo` - `easeInQuad` / `easeOutQuad` / `easeInOutQuad` - `easeInQuart` / `easeOutQuart` / `easeInOutQuart` - `easeInQuint` / `easeOutQuint` / `easeInOutQuint` - `easeInSine` / `easeOutSine` / `easeInOutSine` ### Oscillators [/src/math](https://github.com/thi-ng/umbrella/tree/develop/packages/shader-ast-stdlib/src/math/osc.ts) - `sinOsc` / `sawOsc` / `triOsc` / `rectOsc` ### Matrix operations [/src/matrix](https://github.com/thi-ng/umbrella/tree/develop/packages/shader-ast-stdlib/src/matrix/) - `lookat` - `transformMVP` - `surfaceNormal` - `rotation2` - `rotationX3` / `rotationY3` / `rotationZ3` - `rotationX4` / `rotationY4` / `rotationZ4` ### Noise / randomness [/src/noise](https://github.com/thi-ng/umbrella/tree/develop/packages/shader-ast-stdlib/src/noise/) - `fbmNoiseVec34` - `hash2` / `hash3` - `hash11` / `hash12` / `hash13` - `hash21` / `hash22` / `hash23` - `hash31` / `hash32` / `hash33` - `hash41` / `hash42` / `hash43` / `hash44` - `permute` / `permute3` / `permute4` - `snoise2` - `snoise3` / `snoiseVec32` / `snoiseVec3` - `voronoise2` - `worley2` / `worleyDist` / `worleyDistManhattan` ### Raymarching [/src/raymarch](https://github.com/thi-ng/umbrella/tree/develop/packages/shader-ast-stdlib/src/raymarch/) - `raymarchAO` - `raymarchDir` - `raymarchNormal` - `raymarchScene` - `rayPointAt` ### Screen coordinates [/src/screen](https://github.com/thi-ng/umbrella/tree/develop/packages/shader-ast-stdlib/src/screen/) - `aspectCorrectedUV` ### Signed Distance Fields [/src/sdf](https://github.com/thi-ng/umbrella/tree/develop/packages/shader-ast-stdlib/src/sdf/) #### Primitives - `sdfArc2` - `sdfBox2` - `sdfBox3` - `sdfCircle` - `sdfCylinder` - `sdfLine2` - `sdfLine3` - `sdfPlane2` - `sdfPlane3` - `sdfPolygon2` - `sdfPolyline2` - `sdfQuadratic2` - `sdfSphere` - `sdfTorus` - `sdfTriangle2` #### Polyhedra - `sdfDodecahedron` / `sdfDodecahedronSmooth` - `sdfIcosahedron` / `sdfIcosahedronSmooth` - `sdfOctahedron` / `sdfOctahedronSmooth` - `sdfTruncatedOctahedron` / `sdfTruncatedOctahedronSmooth` - `sdfTruncatedIcosahedron` / `sdfTruncatedIcosahedronSmooth` #### Operators / combinators - `sdfAnnular` - `sdfIntersect` - `sdfMirror2` - `sdfRepeat2` - `sdfRepeatPolar2` - `sdfRepeat3` - `sdfRound` - `sdfSubtract` - `sdfSmoothIntersect` / `sdfSmoothIntersectAll` - `sdfSmoothSubtract` / `sdfSmoothSubtractAll` - `sdfSmoothUnion` / `sdfSmoothUnionAll` - `sdfUnion` ### Texture lookups [/src/tex](https://github.com/thi-ng/umbrella/tree/develop/packages/shader-ast-stdlib/src/tex/) - `indexToCoord` / `coordToIndex` - `indexToUV` / `uvToIndex` - `normal2` / `packedNormal2` - `readIndex1` / `readIndex2` / `readIndex3` / `readIndex4` ### Visualization [/src/viz](https://github.com/thi-ng/umbrella/tree/develop/packages/shader-ast-stdlib/src/viz/) - `functionDomainMapper` - `functionSampler` ## Authors - [Karsten Schmidt](https://thi.ng) (Main author) - [Yury Hantsouski](https://github.com/Hantsouski) If this project contributes to an academic publication, please cite it as: ```bibtex @misc{thing-shader-ast-stdlib, title = "@thi.ng/shader-ast-stdlib", author = "Karsten Schmidt and others", note = "https://thi.ng/shader-ast-stdlib", year = 2019 } ``` ## License © 2019 - 2025 Karsten Schmidt // Apache License 2.0