onejs-sl 0.1.0 → 0.1.2

package/src/lib/index.ts

@@ -0,0 +1,47 @@
+/**
+ * The helper library every backend draws from: value and simplex noise, the
+ * octave kinds, voronoi, hsv2rgb, toLinear and the 42 distance shapes.
+ *
+ * Its one source is `lib/*.hlsl` in this package. OneJS's `.cginc` files are
+ * generated copies of it, and the tables here (`table.ts`, `glsl.ts`,
+ * `wgsl.ts`, `hlsl.ts`) are its translations, printed at build time by
+ * `lib/translate.ts`. Nothing here parses shader text; it only picks entries.
+ */
+
+import { LIB_FUNCTIONS } from "./table"
+
+export { LIB_FUNCTIONS, SDF_CALLS } from "./table"
+export type { LibFunction, SdfCall } from "./types"
+
+/**
+ * A function's index by name, and by parameter types when the name is
+ * overloaded (`sl_toLinear`, `onejsFbm`). Throws for a name the library does
+ * not have, since an emitter asking for one is a bug in the emitter.
+ */
+export function libIndex(name: string, params?: readonly string[]): number {
+    const hits: number[] = []
+    LIB_FUNCTIONS.forEach((f, i) => {
+        if (f.name === name && (params === undefined || sameList(f.params, params))) hits.push(i)
+    })
+    if (hits.length !== 1) {
+        const sig = params === undefined ? name : `${name}(${params.join(", ")})`
+        throw new Error(`internal: the shader library has ${hits.length === 0 ? "no" : "more than one"} ${sig}`)
+    }
+    return hits[0]!
+}
+
+/** Every index named, with everything each one calls, in library order (which is dependency order). */
+export function libClosure(indices: Iterable<number>): number[] {
+    const want = new Set<number>()
+    const add = (i: number) => {
+        if (want.has(i)) return
+        want.add(i)
+        for (const d of LIB_FUNCTIONS[i]!.deps) add(d)
+    }
+    for (const i of indices) add(i)
+    return [...want].sort((a, b) => a - b)
+}
+
+function sameList(a: readonly string[], b: readonly string[]): boolean {
+    return a.length === b.length && a.every((x, i) => x === b[i])
+}

package/src/lib/table.ts

@@ -0,0 +1,125 @@
+// GENERATED by lib/generate.ts from lib/*.hlsl. Do not edit: change the
+// .hlsl and run `npm run lib`. src/lib/lib.test.ts fails when this is stale.
+
+import type { LibFunction, SdfCall } from "./types"
+
+/** Every function in the library, in dependency order. `deps` are indices into this list. */
+export const LIB_FUNCTIONS: readonly LibFunction[] = [
+    { name: "glslMod", params: ["float", "float"], ret: "float", wgsl: "glslMod", deps: [], colour: false },
+    { name: "ndot", params: ["float2", "float2"], ret: "float", wgsl: "ndot", deps: [], colour: false },
+    { name: "dot2", params: ["float2"], ret: "float", wgsl: "dot2", deps: [], colour: false },
+    { name: "sdCircle", params: ["float2", "float"], ret: "float", wgsl: "sdCircle", deps: [], colour: false },
+    { name: "sdRoundedBox", params: ["float2", "float2", "float4"], ret: "float", wgsl: "sdRoundedBox", deps: [], colour: false },
+    { name: "sdBox", params: ["float2", "float2"], ret: "float", wgsl: "sdBox", deps: [], colour: false },
+    { name: "sdOrientedBox", params: ["float2", "float2", "float2", "float"], ret: "float", wgsl: "sdOrientedBox", deps: [], colour: false },
+    { name: "sdSegment", params: ["float2", "float2", "float2"], ret: "float", wgsl: "sdSegment", deps: [], colour: false },
+    { name: "sdRhombus", params: ["float2", "float2"], ret: "float", wgsl: "sdRhombus", deps: [1], colour: false },
+    { name: "sdTrapezoid", params: ["float2", "float", "float", "float"], ret: "float", wgsl: "sdTrapezoid", deps: [2], colour: false },
+    { name: "sdParallelogram", params: ["float2", "float", "float", "float"], ret: "float", wgsl: "sdParallelogram", deps: [], colour: false },
+    { name: "sdEquilateralTriangle", params: ["float2", "float"], ret: "float", wgsl: "sdEquilateralTriangle", deps: [], colour: false },
+    { name: "sdTriangleIsosceles", params: ["float2", "float2"], ret: "float", wgsl: "sdTriangleIsosceles", deps: [], colour: false },
+    { name: "sdTriangle", params: ["float2", "float2", "float2", "float2"], ret: "float", wgsl: "sdTriangle", deps: [], colour: false },
+    { name: "sdUnevenCapsule", params: ["float2", "float", "float", "float"], ret: "float", wgsl: "sdUnevenCapsule", deps: [], colour: false },
+    { name: "sdPentagon", params: ["float2", "float"], ret: "float", wgsl: "sdPentagon", deps: [], colour: false },
+    { name: "sdHexagon", params: ["float2", "float"], ret: "float", wgsl: "sdHexagon", deps: [], colour: false },
+    { name: "sdOctogon", params: ["float2", "float"], ret: "float", wgsl: "sdOctogon", deps: [], colour: false },
+    { name: "sdHexagram", params: ["float2", "float"], ret: "float", wgsl: "sdHexagram", deps: [], colour: false },
+    { name: "sdStar5", params: ["float2", "float", "float"], ret: "float", wgsl: "sdStar5", deps: [], colour: false },
+    { name: "sdStar", params: ["float2", "float", "int", "float"], ret: "float", wgsl: "sdStar", deps: [0], colour: false },
+    { name: "sdPie", params: ["float2", "float2", "float"], ret: "float", wgsl: "sdPie", deps: [], colour: false },
+    { name: "sdCutDisk", params: ["float2", "float", "float"], ret: "float", wgsl: "sdCutDisk", deps: [], colour: false },
+    { name: "sdArc", params: ["float2", "float2", "float", "float"], ret: "float", wgsl: "sdArc", deps: [], colour: false },
+    { name: "sdRing", params: ["float2", "float2", "float", "float"], ret: "float", wgsl: "sdRing", deps: [], colour: false },
+    { name: "sdHorseshoe", params: ["float2", "float2", "float", "float2"], ret: "float", wgsl: "sdHorseshoe", deps: [], colour: false },
+    { name: "sdVesica", params: ["float2", "float", "float"], ret: "float", wgsl: "sdVesica", deps: [], colour: false },
+    { name: "sdOrientedVesica", params: ["float2", "float2", "float2", "float"], ret: "float", wgsl: "sdOrientedVesica", deps: [], colour: false },
+    { name: "sdMoon", params: ["float2", "float", "float", "float"], ret: "float", wgsl: "sdMoon", deps: [], colour: false },
+    { name: "sdRoundedCross", params: ["float2", "float"], ret: "float", wgsl: "sdRoundedCross", deps: [2], colour: false },
+    { name: "sdEgg", params: ["float2", "float", "float", "float", "float"], ret: "float", wgsl: "sdEgg", deps: [], colour: false },
+    { name: "sdHeart", params: ["float2"], ret: "float", wgsl: "sdHeart", deps: [], colour: false },
+    { name: "sdCross", params: ["float2", "float2", "float"], ret: "float", wgsl: "sdCross", deps: [], colour: false },
+    { name: "sdRoundedX", params: ["float2", "float", "float"], ret: "float", wgsl: "sdRoundedX", deps: [], colour: false },
+    { name: "sdEllipse", params: ["float2", "float2"], ret: "float", wgsl: "sdEllipse", deps: [], colour: false },
+    { name: "sdParabola", params: ["float2", "float"], ret: "float", wgsl: "sdParabola", deps: [], colour: false },
+    { name: "sdParabolaSegment", params: ["float2", "float", "float"], ret: "float", wgsl: "sdParabolaSegment", deps: [], colour: false },
+    { name: "sdBezier", params: ["float2", "float2", "float2", "float2"], ret: "float", wgsl: "sdBezier", deps: [], colour: false },
+    { name: "sdBlobbyCross", params: ["float2", "float"], ret: "float", wgsl: "sdBlobbyCross", deps: [], colour: false },
+    { name: "sdTunnel", params: ["float2", "float2"], ret: "float", wgsl: "sdTunnel", deps: [], colour: false },
+    { name: "sdStairs", params: ["float2", "float2", "float"], ret: "float", wgsl: "sdStairs", deps: [], colour: false },
+    { name: "sdQuadraticCircle", params: ["float2"], ret: "float", wgsl: "sdQuadraticCircle", deps: [], colour: false },
+    { name: "sdHyberbola", params: ["float2", "float", "float"], ret: "float", wgsl: "sdHyberbola", deps: [], colour: false },
+    { name: "sdCoolS", params: ["float2"], ret: "float", wgsl: "sdCoolS", deps: [2], colour: false },
+    { name: "sdCircleWave", params: ["float2", "float", "float"], ret: "float", wgsl: "sdCircleWave", deps: [0], colour: false },
+    { name: "onejsHash21", params: ["float2", "float"], ret: "float", wgsl: "onejsHash21", deps: [], colour: false },
+    { name: "onejsVNoise", params: ["float2", "float"], ret: "float", wgsl: "onejsVNoise", deps: [45], colour: false },
+    { name: "onejsFbm", params: ["float2", "float", "int", "float", "float"], ret: "float", wgsl: "onejsFbm_f2_f_i_f_f", deps: [46], colour: false },
+    { name: "onejsFbm", params: ["float2", "float", "int"], ret: "float", wgsl: "onejsFbm_f2_f_i", deps: [47], colour: false },
+    { name: "onejsMod289", params: ["float2"], ret: "float2", wgsl: "onejsMod289_f2", deps: [], colour: false },
+    { name: "onejsMod289", params: ["float3"], ret: "float3", wgsl: "onejsMod289_f3", deps: [], colour: false },
+    { name: "onejsPermute", params: ["float3"], ret: "float3", wgsl: "onejsPermute", deps: [50], colour: false },
+    { name: "onejsSimplexRaw", params: ["float2"], ret: "float", wgsl: "onejsSimplexRaw", deps: [49, 51], colour: false },
+    { name: "onejsSimplex", params: ["float2", "float"], ret: "float", wgsl: "onejsSimplex", deps: [52], colour: false },
+    { name: "onejsFbmSimplex", params: ["float2", "float", "int", "float", "float"], ret: "float", wgsl: "onejsFbmSimplex", deps: [53], colour: false },
+    { name: "onejsTurbulence", params: ["float2", "float", "int", "float", "float"], ret: "float", wgsl: "onejsTurbulence", deps: [52], colour: false },
+    { name: "onejsRidged", params: ["float2", "float", "int", "float", "float"], ret: "float", wgsl: "onejsRidged", deps: [52], colour: false },
+    { name: "onejsFbmKind", params: ["int", "float2", "float", "int", "float", "float"], ret: "float", wgsl: "onejsFbmKind", deps: [47, 54, 55, 56], colour: false },
+    { name: "sl_hash21", params: ["float2"], ret: "float", wgsl: "sl_hash21", deps: [], colour: false },
+    { name: "sl_valueNoise", params: ["float2"], ret: "float", wgsl: "sl_valueNoise", deps: [46], colour: false },
+    { name: "sl_simplex", params: ["float2"], ret: "float", wgsl: "sl_simplex", deps: [53], colour: false },
+    { name: "sl_fbm", params: ["float2", "int", "int"], ret: "float", wgsl: "sl_fbm", deps: [57], colour: false },
+    { name: "sl_hsv2rgb", params: ["float3"], ret: "float3", wgsl: "sl_hsv2rgb", deps: [], colour: false },
+    { name: "sl_sdfDistance", params: ["int", "float2", "float4", "float2"], ret: "float", wgsl: "sl_sdfDistance", deps: [3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44], colour: false },
+    { name: "sl_voronoi", params: ["float2"], ret: "float", wgsl: "sl_voronoi", deps: [58], colour: false },
+    { name: "sl_luminance", params: ["float3"], ret: "float", wgsl: "sl_luminance", deps: [], colour: false },
+    { name: "sl_gammaToLinear", params: ["float3"], ret: "float3", wgsl: "sl_gammaToLinear", deps: [], colour: false },
+    { name: "sl_toLinear", params: ["float"], ret: "float", wgsl: "sl_toLinear_f", deps: [66], colour: true },
+    { name: "sl_toLinear", params: ["float2"], ret: "float2", wgsl: "sl_toLinear_f2", deps: [66], colour: true },
+    { name: "sl_toLinear", params: ["float3"], ret: "float3", wgsl: "sl_toLinear_f3", deps: [66], colour: true },
+    { name: "sl_toLinear", params: ["float4"], ret: "float4", wgsl: "sl_toLinear_f4", deps: [66], colour: true },
+]
+
+/** Shape id to the function and where its parameters come from, read from sl_sdfDistance's switch. */
+export const SDF_CALLS: readonly SdfCall[] = [
+    { fn: "sdCircle", args: [[0]] },
+    { fn: "sdRoundedBox", args: [[0, 1], [2, 3, 4, 5]] },
+    { fn: "sdBox", args: [[0, 1]] },
+    { fn: "sdOrientedBox", args: [[0, 1], [2, 3], [4]] },
+    { fn: "sdSegment", args: [[0, 1], [2, 3]] },
+    { fn: "sdRhombus", args: [[0, 1]] },
+    { fn: "sdTrapezoid", args: [[0], [1], [2]] },
+    { fn: "sdParallelogram", args: [[0], [1], [2]] },
+    { fn: "sdEquilateralTriangle", args: [[0]] },
+    { fn: "sdTriangleIsosceles", args: [[0, 1]] },
+    { fn: "sdTriangle", args: [[0, 1], [2, 3], [4, 5]] },
+    { fn: "sdUnevenCapsule", args: [[0], [1], [2]] },
+    { fn: "sdPentagon", args: [[0]] },
+    { fn: "sdHexagon", args: [[0]] },
+    { fn: "sdOctogon", args: [[0]] },
+    { fn: "sdHexagram", args: [[0]] },
+    { fn: "sdStar5", args: [[0], [1]] },
+    { fn: "sdStar", args: [[0], { int: 1 }, [2]] },
+    { fn: "sdPie", args: [[0, 1], [2]] },
+    { fn: "sdCutDisk", args: [[0], [1]] },
+    { fn: "sdArc", args: [[0, 1], [2], [3]] },
+    { fn: "sdRing", args: [[0, 1], [2], [3]] },
+    { fn: "sdHorseshoe", args: [[0, 1], [2], [3, 4]] },
+    { fn: "sdVesica", args: [[0], [1]] },
+    { fn: "sdOrientedVesica", args: [[0, 1], [2, 3], [4]] },
+    { fn: "sdMoon", args: [[0], [1], [2]] },
+    { fn: "sdRoundedCross", args: [[0]] },
+    { fn: "sdEgg", args: [[0], [1], [2], [3]] },
+    { fn: "sdHeart", args: [] },
+    { fn: "sdCross", args: [[0, 1], [2]] },
+    { fn: "sdRoundedX", args: [[0], [1]] },
+    { fn: "sdEllipse", args: [[0, 1]] },
+    { fn: "sdParabola", args: [[0]] },
+    { fn: "sdParabolaSegment", args: [[0], [1]] },
+    { fn: "sdBezier", args: [[0, 1], [2, 3], [4, 5]] },
+    { fn: "sdBlobbyCross", args: [[0]] },
+    { fn: "sdTunnel", args: [[0, 1]] },
+    { fn: "sdStairs", args: [[0, 1], [2]] },
+    { fn: "sdQuadraticCircle", args: [] },
+    { fn: "sdHyberbola", args: [[0], [1]] },
+    { fn: "sdCoolS", args: [] },
+    { fn: "sdCircleWave", args: [[0], [1]] },
+]

package/src/lib/types.ts

@@ -0,0 +1,23 @@
+/** One function of the helper library, as `lib/generate.ts` records it. */
+export interface LibFunction {
+    name: string
+    /** Parameter types, HLSL spelling: `float`, `float2`, `int`... */
+    params: readonly string[]
+    ret: string
+    /** Its WGSL name: an overloaded name carries its signature there, since WGSL has no overloading. */
+    wgsl: string
+    /** Indices of the functions it calls, all earlier in the list. */
+    deps: readonly number[]
+    /** Written once per colour space (`#ifdef UNITY_COLORSPACE_GAMMA`). */
+    colour: boolean
+}
+
+/**
+ * How a shape's parameters reach its function: each argument after the point
+ * is a list of indices into `[a.x, a.y, a.z, a.w, b.x, b.y]`, or `{ int: i }`
+ * for an integer parameter.
+ */
+export interface SdfCall {
+    fn: string
+    args: ReadonlyArray<readonly number[] | { int: number }>
+}