@thi.ng/shader-ast-stdlib 1.0.7 → 1.0.9

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2025-01-29T16:25:48Z
+- **Last updated**: 2025-02-19T20:59:58Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/README.md

@@ -7,7 +7,7 @@
 [![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 201 standalone projects, maintained as part
+> This is one of 202 standalone projects, maintained as part
 > of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
 > and anti-framework.
 >

package/color/cosine-gradient.d.ts

@@ -2,12 +2,13 @@ import { type FloatTerm, type Vec3Term } from "@thi.ng/shader-ast";
 /**
  * Inline function. Computes the unclamped cosine-based color gradient value:
  * `a+b*cos(2π*(c*t+d))`, where `a`..`d` are the gradient coefficients and `t`
- * the gradient position in the [0,1] interval.
+ * the gradient position in the `[0,1]` interval.
  *
  * @remarks
  * Based on technique by Inigo Quilez
  *
  * References:
+ *
  * - https://iquilezles.org/articles/palettes/
  * - https://github.com/thi-ng/umbrella/tree/develop/packages/color#cosine-gradients
  *

package/color/levels.d.ts

@@ -17,7 +17,7 @@ export declare const midLevelGamma: import("@thi.ng/shader-ast").TaggedFn1<"floa
 export declare const midLevelGammaRGB: (mid: Vec3Term) => import("@thi.ng/shader-ast").Lit<"vec3">;
 /**
  * Applies level remapping from `input` to `output` (each given as
- * `vec2(min,max)`) with `gamma` correction. Results will be clamped to [0..1]
+ * `vec2(min,max)`) with `gamma` correction. Results will be clamped to `[0,1]`
  * range.
  */
 export declare const levelAdjustGamma: import("@thi.ng/shader-ast").TaggedFn4<"float", "float", "vec2", "vec2", "float">;

package/color/porter-duff.d.ts

@@ -6,7 +6,7 @@ import type { FloatTerm, Vec4Sym } from "@thi.ng/shader-ast";
  * optimized AST function which accepts 2 RGBA colors (vec4) and returns blended
  * & clamped result (also a vec4).
  *
- * @remark
+ * @remarks
  * All built-in PD operators are defined via this HOF. The two given coefficient
  * functions are used to extract blending coefficients for src/dest colors and
  * are called with the alpha components of both colors.

package/controlflow/branches.d.ts

@@ -1,7 +1,7 @@
 import type { FloatTerm, Term, Type } from "@thi.ng/shader-ast";
 /**
  * Utility function to create an n-ary conditional based on given float value
- * `x` in [0,1] range and any number of branch terms (at least 1). Returns a
+ * `x` in `[0,1]` range and any number of branch terms (at least 1). Returns a
  * nested ternary expression.
  *
  * @remarks

package/fog/exp.d.ts

@@ -1,6 +1,6 @@
 /**
- * Computes exponential fog factor [0..1], based on given fully
- * saturated fog distance and density.
+ * Computes exponential fog factor `[0,1]`, based on given fully saturated fog
+ * distance and density.
  *
  * @param dist - float
  * @param density - float

package/fog/exp2.d.ts

@@ -1,7 +1,7 @@
 /**
- * Similar to {@link fogExp}. Computes exponential fog factor [0..1], based on
+ * Similar to {@link fogExp}. Computes exponential fog factor `[0,1]`, based on
  * given fully saturated fog distance and density. Uses
- * [`exp2()`](https://docs.thi.ng/umbrella/shader-ast/functions/exp2.html)
+ * [`exp2`](https://docs.thi.ng/umbrella/shader-ast/functions/exp2.html)
  * internally.
  *
  * @param dist - float

package/fog/linear.d.ts

@@ -1,6 +1,5 @@
 /**
- * Computes linear fog factor [0..1], based on given fog min/max
- * distances.
+ * Computes linear fog factor `[0,1]`, based on given fog min/max distances.
  *
  * @param dist - float
  * @param start - float

package/math/additive.d.ts

@@ -1,17 +1,16 @@
 import type { Fn } from "@thi.ng/api";
 import type { FloatTerm, Prim, Term } from "@thi.ng/shader-ast";
 /**
- * Higher order function. Takes an AST type ID, a single-arg scalar
- * function `fn`, number of octaves (default: 4) and an optional
- * function name. Returns a new function which computes the summed value
- * of `fn` over the given number octaves and accepts 3 args:
+ * Higher order function. Takes an AST type ID, a single-arg scalar function
+ * `fn`, number of octaves (default: 4) and an optional function name. Returns a
+ * new function which computes the summed value of `fn` over the given number
+ * octaves and accepts 3 args:
  *
  * - position (float)
  * - octave shift (float)
  * - octave decay (usually 0.5)
  *
- * For each octave `i` [0..oct), the function is (in principle)
- * evaluated as:
+ * For each octave `i` `[0,oct)`, the function is (in principle) evaluated as:
  *
  * n += decay / exp2(i) * fn(pos * exp2(i) + i * shift)
  *

package/math/fit.d.ts

@@ -1,7 +1,7 @@
 import type { Prim, PrimTerm, Term, TermType } from "@thi.ng/shader-ast";
 /**
- * Returns normalized value of `x` WRT to interval [a,b]. Returns 0, if
- * `a` equals `b`.
+ * Returns normalized value of `x` WRT to interval `[a,b]`. Returns 0, if `a`
+ * equals `b`.
  *
  * @param x -
  * @param a -
@@ -10,7 +10,7 @@ import type { Prim, PrimTerm, Term, TermType } from "@thi.ng/shader-ast";
 export declare const fitNorm1: import("@thi.ng/shader-ast").TaggedFn3<"float", "float", "float", "float">;
 /**
  * Similar to {@link fitNorm1} but also for vector types and without checking if
- * `a == b`. Scales value `x` from closed interval [a,b] to closed [0,1]
+ * `a == b`. Scales value `x` from closed interval `[a,b]` to closed `[0,1]`
  * interval. No clamping performed.
  *
  * @param x
@@ -19,7 +19,7 @@ export declare const fitNorm1: import("@thi.ng/shader-ast").TaggedFn3<"float", "
  */
 export declare const fitNorm: <T extends Prim>(x: Term<T>, a: Term<T>, b: Term<T>) => import("@thi.ng/shader-ast").Op2<T>;
 /**
- * Fits value `x` from closed interval [a,b] to closed interval [c,d]. No
+ * Fits value `x` from closed interval `[a,b]` to closed interval `[c,d]`. No
  * clamping performed.
  *
  * @param x -
@@ -30,7 +30,7 @@ export declare const fitNorm: <T extends Prim>(x: Term<T>, a: Term<T>, b: Term<T
  */
 export declare const fit: <T extends Prim>(x: Term<T>, a: Term<T>, b: Term<T>, c: Term<T>, d: Term<T>) => import("@thi.ng/shader-ast").FnCall<T>;
 /**
- * Same as {@link fit}, but first clamps `x` to closed [a,b] interval.
+ * Same as {@link fit}, but first clamps `x` to closed `[a,b]` interval.
  *
  * @param x -
  * @param a -
@@ -40,8 +40,8 @@ export declare const fit: <T extends Prim>(x: Term<T>, a: Term<T>, b: Term<T>, c
  */
 export declare const fitClamped: <T extends Prim>(x: Term<T>, a: Term<T>, b: Term<T>, c: Term<T>, d: Term<T>) => import("@thi.ng/shader-ast").FnCall<T>;
 /**
- * Inline function. Fits value `a` in [0..1] interval to new interval
- * [b..c]. No clamping performed. Same as `mix(b, c, a)`
+ * Inline function. Fits value `a` in `[0,1]` interval to new interval `[b,c]`.
+ * No clamping performed. Same as `mix(b, c, a)`
  *
  * @param a -
  * @param b -
@@ -49,15 +49,15 @@ export declare const fitClamped: <T extends Prim>(x: Term<T>, a: Term<T>, b: Ter
  */
 export declare const fit01: <T extends Prim>(a: Term<T>, b: Term<T>, c: Term<T>) => Term<T>;
 /**
- * Inline function. Fits value `x` in [-1..+1] interval to [0..1]
- * interval. No clamping performed.
+ * Inline function. Fits value `x` in `[-1,1]` interval to `[0,1]` interval. No
+ * clamping performed.
  *
  * @param x -
  */
 export declare const fit1101: <T extends PrimTerm>(x: T) => Term<TermType<T>>;
 /**
- * Inline function. Fits value `x` in [0..1] interval to [-1..+1]
- * interval. No clamping performed.
+ * Inline function. Fits value `x` in `[0,1]` interval to `[-1,1]` interval. No
+ * clamping performed.
  *
  * @param x -
  */

package/math/interval.d.ts

@@ -8,8 +8,10 @@ export declare const trunc: import("@thi.ng/shader-ast").TaggedFn1<"float", "flo
  */
 export declare const modulo: import("@thi.ng/shader-ast").TaggedFn2<"float", "float", "float">;
 /**
- * Same as thi.ng/math foldback01(). Folds `x` into the closed [0..1] interval,
- * using infinite internal reflection on either side of the interval.
+ * Same as
+ * [`foldback01`](https://docs.thi.ng/umbrella/math/functions/foldback01.html).
+ * Folds `x` into the closed `[0,1]` interval, using infinite internal
+ * reflection on either side of the interval.
  *
  * @param x
  */

package/math/orthogonal.d.ts

@@ -1,14 +1,14 @@
 import type { Vec2Term } from "@thi.ng/shader-ast";
 /**
  * Inline function. Returns counter-clockwise perpendicular vector (assuming
- * Y-up). [-y, x]
+ * Y-up). `[-y,x]`
  *
  * @param v -
  */
 export declare const perpendicularCCW: (v: Vec2Term) => import("@thi.ng/shader-ast").Lit<"vec2">;
 /**
  * Inline function. Returns clockwise perpendicular vector (assuming Y-up).
- * [y,-x]
+ * `[y,-x]`
  *
  * @param v -
  */

package/math/pack-float.d.ts

@@ -1,6 +1,6 @@
 /**
- * Encodes a float value in [0,1) interval to a vec4 suitable for a 8bit/channel
- * render texture. Use {@link unpackFloat} for reverse op.
+ * Encodes a float value in `[0,1)` interval to a vec4 suitable for a
+ * 8bit/channel render texture. Use {@link unpackFloat} for reverse op.
  *
  * @remarks
  * Reference:

package/math/smoother-step.d.ts

@@ -1,7 +1,7 @@
 import type { TaggedFn1 } from "@thi.ng/shader-ast";
 /**
  * Specialized version of {@link smootherStep}, assuming edges are 0/1
- * respectively and `x` is in [0..1]. No clamping performed.
+ * respectively and `x` is in `[0,1]`. No clamping performed.
  *
  * @param x
  */

package/noise/voronoi2.d.ts

@@ -2,10 +2,10 @@
  * IQ's parametric 2D voronoise. Depending on `u` and `v`, this function
  * produces 4 different noise types
  *
- * - cell noise (0,0)
- * - voronoi (1,0)
- * - perlin noise (0,1)
- * - voronoise (1,1)
+ * - cell noise `(0,0)`
+ * - voronoi `(1,0)`
+ * - perlin noise `(0,1)`
+ * - voronoise `(1,1)`
  *
  * http://www.iquilezles.org/www/articles/voronoise/voronoise.htm
  *

package/noise/worley2.d.ts

@@ -4,7 +4,7 @@ export declare const worleyDistManhattan: import("@thi.ng/shader-ast").TaggedFn2
 /**
  * Higher order function. Computes 2D Worley noise using provided distance
  * function. The returned function takes 2 args: position and jitter amount, the
- * latter in [0..1] interval. Returns noise components as vec2, with the x
+ * latter in `[0,1]` interval. Returns noise components as vec2, with the x
  * component containing the distance from closest simplex center and y the noise
  * value. The vector components can be used individually or combined (e.g.
  * `noise.y - noise.x`)...

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/shader-ast-stdlib",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "Function collection for modular GPGPU / shader programming with @thi.ng/shader-ast",
   "type": "module",
   "module": "./index.js",
@@ -42,12 +42,12 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.11.19",
-    "@thi.ng/shader-ast": "^1.0.7"
+    "@thi.ng/api": "^8.11.21",
+    "@thi.ng/shader-ast": "^1.0.9"
   },
   "devDependencies": {
-    "esbuild": "^0.24.2",
-    "typedoc": "^0.27.6",
+    "esbuild": "^0.25.0",
+    "typedoc": "^0.27.7",
     "typescript": "^5.7.3"
   },
   "keywords": [
@@ -375,5 +375,5 @@
     ],
     "year": 2019
   },
-  "gitHead": "dcc1dbfa6eae31ac65e12843987b94d4a7edc144\n"
+  "gitHead": "bee617702ac61d093465b967f8f973dc566faa6b\n"
 }

package/raymarch/ao.d.ts

@@ -1,9 +1,9 @@
 import type { RaymarchScene } from "../api.js";
 /**
- * Higher order function returning an function to compute the Ambient
- * Occlusion term / shadow factor for given SDF scene function. The
- * returned function takes 2 arguments: surface pos and normal. It
- * returns a float in [0..1] interval (zero = fully occluded).
+ * Higher order function returning an function to compute the Ambient Occlusion
+ * term / shadow factor for given SDF scene function. The returned function
+ * takes 2 arguments: surface pos and normal. It returns a float in `[0,1]`
+ * interval (zero = fully occluded).
  *
  * @param scene -
  * @param numSamples -

package/screen/uv.d.ts

@@ -1,6 +1,7 @@
 import type { Vec2Term, Vec4Term } from "@thi.ng/shader-ast";
 /**
- * Computes UV coord in [0..1] interval from given `fragCoord` and screen `res`.
+ * Computes UV coord in `[0,1]` interval from given `fragCoord` and screen
+ * `res`.
  *
  * @param fragCoord -
  * @param res -
@@ -8,7 +9,7 @@ import type { Vec2Term, Vec4Term } from "@thi.ng/shader-ast";
 export declare const fragUV: (fragCoord: Vec4Term, res: Vec2Term) => import("@thi.ng/shader-ast").Op2<"vec2">;
 /**
  * Takes `pos`, a screen coord (e.g. gl_FragCoord) and viewport resolution
- * `res`, returns aspect corrected uv, with uv.y in [-1..1] interval and uv.x
+ * `res`, returns aspect corrected uv, with uv.y in `[-1,1]` interval and uv.x
  * scaled by the aspect ratio `resx / resy`.
  *
  * @param fragCoord - vec2
@@ -17,7 +18,7 @@ export declare const fragUV: (fragCoord: Vec4Term, res: Vec2Term) => import("@th
 export declare const aspectCorrectedUV: import("@thi.ng/shader-ast").TaggedFn2<"vec2", "vec2", "vec2">;
 /**
  * Returns true if at least one coordinate of the given point is within the
- * `width` internal border region of UV rect ([0,0] .. [1,1]).
+ * `width` internal border region of UV rect (`[0,0]`..`[1,1]`).
  *
  * ```c
  * borderMask(vec2(0.91, 0.5), 0.1) // true

package/sdf/arc.d.ts

@@ -1,6 +1,6 @@
 /**
  * Returns signed distance from `p` to 2D circular arc with `aperture` (in
- * [0..π] interval), radius `ra` and `thickness`.
+ * `[0,π]` interval), radius `ra` and `thickness`.
  *
  * @remarks
  * Slightly modified version (easier to use aperture control) of original GLSL

package/sdf/box-rounded.d.ts

@@ -4,7 +4,7 @@
  *
  * @remarks
  * Ported from original GLSL impl by Inigo Quilez:
- * - https://iquilezles.org/articles/distfunctions2d/
+ * https://iquilezles.org/articles/distfunctions2d/
  *
  * @param p - vec2
  * @param size - vec2

package/sdf/cross.d.ts

@@ -3,11 +3,12 @@
  * radius `r`.
  *
  * @remarks
+ *
  * - `size` consist of overall width/size (in x) and thickness (in y component)
  * - corner radius can also be negative
  *
  * Ported from original GLSL impl by Inigo Quilez:
- * - https://iquilezles.org/articles/distfunctions2d/
+ * https://iquilezles.org/articles/distfunctions2d/
  *
  * @param p -
  * @param size -
@@ -20,7 +21,7 @@ export declare const sdfCross2: import("@thi.ng/shader-ast").TaggedFn3<"vec2", "
  *
  * @remarks
  * Ported from original GLSL impl by Inigo Quilez:
- * - https://iquilezles.org/articles/distfunctions2d/
+ * https://iquilezles.org/articles/distfunctions2d/
  *
  * @param p -
  * @param size -

package/sdf/hex.d.ts

@@ -3,7 +3,7 @@
  *
  * @remarks
  * Ported from original GLSL impl by Inigo Quilez:
- * - https://iquilezles.org/articles/distfunctions2d/
+ * https://iquilezles.org/articles/distfunctions2d/
  */
 export declare const sdfHexagon2: import("@thi.ng/shader-ast").TaggedFn2<"vec2", "float", "float">;
 //# sourceMappingURL=hex.d.ts.map

package/sdf/polygon.d.ts

@@ -4,7 +4,7 @@
  *
  * @remarks
  * Based on original GLSL impl by Inigo Quilez:
- * - https://iquilezles.org/articles/distfunctions2d/
+ * https://iquilezles.org/articles/distfunctions2d/
  *
  * @param N
  */

package/viz/function.d.ts

@@ -24,14 +24,14 @@ export interface FnSampleOpts {
     area: boolean;
     /**
      * Min X position (in function domain). The function will only be evaluated
-     * within the [min..max] domain.
+     * within the `[min,max]` domain.
      *
      * @defaultValue 0
      */
     min: number;
     /**
      * Max X position (in function domain). The function will only be evaluated
-     * within the [min..max] domain.
+     * within the `[min,max]` domain.
      *
      * @defaultValue 1
      */