Merge pull request #8730 from perminder-17/random-strands

implementing random function for strands

Author: davepagurek

src/image/filterRenderer2D.js

@@ -17,6 +17,8 @@ import filterBaseVert from '../webgl/shaders/filters/base.vert';
 import webgl2CompatibilityShader from '../webgl/shaders/webgl2Compatibility.glsl';
 import { glslBackend } from '../webgl/strands_glslBackend';
 import { getShaderHookTypes } from '../webgl/shaderHookUtils';
+import randomGLSL from '../webgl/shaders/functions/randomGLSL.glsl';
+import randomVertGLSL from '../webgl/shaders/functions/randomVertGLSL.glsl';
 import { makeFilterShader } from '../core/filterShaders';
 
 class FilterRenderer2D {
@@ -309,6 +311,14 @@ class FilterRenderer2D {
   }
 
 
+  getRandomFragmentShaderSnippet() {
+    return randomGLSL;
+  }
+
+  getRandomVertexShaderSnippet() {
+    return randomVertGLSL;
+  }
+
   /**
    * Set the current filter operation and parameter. If a customShader is provided,
    * that overrides the operation-based shader.

src/strands/p5.strands.js

@@ -49,6 +49,7 @@ function strands(p5, fn) {
     ctx.windowOverrides = {};
     ctx.fnOverrides = {};
     ctx.graphicsOverrides = {};
+    ctx._randomSeed = null;
     if (active) {
       p5.disableFriendlyErrors = true;
     }
@@ -64,6 +65,7 @@ function strands(p5, fn) {
     ctx.computeDeclarations = new Set();
     ctx.hooks = [];
     ctx.active = false;
+    ctx._randomSeed = null;
     p5.disableFriendlyErrors = ctx.previousFES;
     for (const key in ctx.windowOverrides) {
       window[key] = ctx.windowOverrides[key];

src/strands/strands_api.js

@@ -318,6 +318,8 @@ export function initGlobalStrandsAPI(p5, fn, strandsContext) {
   // Add noise function with backend-agnostic implementation
   const originalNoise = fn.noise;
   const originalNoiseDetail = fn.noiseDetail;
+  const originalRandom = fn.random;
+  const originalRandomSeed = fn.randomSeed;
   const originalMillis = fn.millis;
 
   strandsContext._noiseOctaves = null;
@@ -382,6 +384,84 @@ export function initGlobalStrandsAPI(p5, fn, strandsContext) {
     return createStrandsNode(id, dimension, strandsContext);
   });
 
+  strandsContext._randomSeed = null;
+
+  augmentFn(fn, p5, 'randomSeed', function (seed) {
+    if (!strandsContext.active) {
+      return originalRandomSeed.apply(this, arguments);
+    }
+    strandsContext._randomSeed = seed;
+  });
+
+  augmentFn(fn, p5, 'random', function (...args) {
+    if (!strandsContext.active) {
+      return originalRandom.apply(this, args);
+    }
+
+    const randomVertSnippet = strandsContext.backend.getRandomVertexShaderSnippet();
+    const randomFragSnippet = strandsContext.backend.getRandomFragmentShaderSnippet();
+
+    strandsContext.vertexDeclarations.add(randomVertSnippet);
+    strandsContext.fragmentDeclarations.add(randomFragSnippet);
+
+    if (strandsContext.backend.getRandomComputeShaderSnippet) {
+      const randomComputeSnippet = strandsContext.backend.getRandomComputeShaderSnippet();
+      strandsContext.computeDeclarations.add(randomComputeSnippet);
+    }
+
+    let seedNode;
+    if (strandsContext._randomSeed !== null && strandsContext._randomSeed.isStrandsNode) {
+      seedNode = strandsContext._randomSeed;
+    } else {
+      const userSeed = strandsContext._randomSeed;
+      seedNode = getOrCreateUniformNode(
+        strandsContext,
+        '_p5_randomSeed',
+        DataType.float1,
+        userSeed !== null
+          ? () => userSeed
+          : () => performance.now(),
+      );
+    }
+
+    // The shader-side random() owns a private per-invocation counter, so a
+    // single AST node still produces distinct values across runtime loop
+    // iterations. We just pass the seed.
+    const nodeArgs = [seedNode];
+    const randomOverloads = [{
+      params: [DataType.float1],
+      returnType: DataType.float1,
+    }];
+
+    if (args.length === 0) {
+      const { id, dimension } = build.functionCallNode(strandsContext, 'random', nodeArgs, {
+        overloads: randomOverloads,
+      });
+      return createStrandsNode(id, dimension, strandsContext);
+    } else if (args.length === 1) {
+      // random(max) → [0, max)
+      const rawNode = build.functionCallNode(strandsContext, 'random', nodeArgs, {
+        overloads: randomOverloads,
+      });
+      const rawStrandsNode = createStrandsNode(rawNode.id, rawNode.dimension, strandsContext);
+      return rawStrandsNode.mult(p5.strandsNode(args[0]));
+    } else if (args.length === 2) {
+      // random(min, max) → [min, max)
+      const rawNode = build.functionCallNode(strandsContext, 'random', nodeArgs, {
+        overloads: randomOverloads,
+      });
+      const rawStrandsNode = createStrandsNode(rawNode.id, rawNode.dimension, strandsContext);
+      const minNode = p5.strandsNode(args[0]);
+      const maxNode = p5.strandsNode(args[1]);
+      // min + raw * (max - min)
+      return rawStrandsNode.mult(maxNode.sub(minNode)).add(minNode);
+    } else {
+      p5._friendlyError(
+        `It looks like you've called random() with ${args.length} arguments. In strands, random() supports 0, 1, or 2 numeric arguments.`
+      );
+    }
+  });
+
   augmentFn(fn, p5, 'millis', function (...args) {
     if (!strandsContext.active) {
       return originalMillis.apply(this, args);

src/webgl/shaders/functions/randomGLSL.glsl

@@ -0,0 +1,27 @@
+// _p5_hash: "Hash without Sine" by Dave Hoskins (https://www.shadertoy.com/view/4djSRW)
+// Mixing constants: R₂ sequence by Martin Roberts (https://extremelearning.com.au/unreasonable-effectiveness-of-quasirandom-sequences/)
+//   α₁ = 1/φ₂ = 0.7548776662 (plastic constant reciprocal)
+//   α₂ = 1/φ₂² = 0.5698402910
+//   1/φ = 0.6180339887 (golden ratio conjugate)
+
+int _p5_randomCallIndex = 0;
+
+float _p5_hash(vec3 p) {
+  p = fract(p * vec3(0.1031, 0.1030, 0.0973));
+  p += dot(p, p.yxz + 33.33);
+  return fract((p.x + p.y) * p.z);
+}
+
+float random(float seed) {
+  vec2 pixelCoord = gl_FragCoord.xy;
+  float callIndex = float(_p5_randomCallIndex);
+  _p5_randomCallIndex += 1;
+  // fract(seed * α₁) normalizes large seeds (e.g. performance.now()) into [0,1)
+  // and spreads them optimally via the R₂ sequence's plastic constant
+  float s = fract(seed * 0.7548776662);
+  return _p5_hash(vec3(
+    pixelCoord.x + s,
+    pixelCoord.y + callIndex * 0.5698402910,
+    s + callIndex * 0.6180339887
+  ));
+}

src/webgl/shaders/functions/randomVertGLSL.glsl

@@ -0,0 +1,25 @@
+// _p5_hash: "Hash without Sine" by Dave Hoskins (https://www.shadertoy.com/view/4djSRW)
+// Mixing constants: R₂ sequence by Martin Roberts (https://extremelearning.com.au/unreasonable-effectiveness-of-quasirandom-sequences/)
+//   α₁ = 1/φ₂ = 0.7548776662 (plastic constant reciprocal)
+//   α₂ = 1/φ₂² = 0.5698402910
+//   1/φ = 0.6180339887 (golden ratio conjugate)
+
+int _p5_randomCallIndex = 0;
+
+float _p5_hash(vec3 p) {
+  p = fract(p * vec3(0.1031, 0.1030, 0.0973));
+  p += dot(p, p.yxz + 33.33);
+  return fract((p.x + p.y) * p.z);
+}
+
+float random(float seed) {
+  float vid = float(gl_VertexID);
+  float callIndex = float(_p5_randomCallIndex);
+  _p5_randomCallIndex += 1;
+  float s = fract(seed * 0.7548776662);
+  return _p5_hash(vec3(
+    vid + s,
+    vid * 0.5698402910 + callIndex * 0.6180339887,
+    s + callIndex * 0.7548776662
+  ));
+}

src/webgl/strands_glslBackend.js

@@ -1,4 +1,6 @@
 import noiseGLSL from './shaders/functions/noise3DGLSL.glsl';
+import randomGLSL from './shaders/functions/randomGLSL.glsl';
+import randomVertGLSL from './shaders/functions/randomVertGLSL.glsl';
 import { NodeType, OpCodeToSymbol, BlockType, OpCode, NodeTypeToName, isStructType, BaseType, StatementType, DataType, INSTANCE_ID_VARYING_NAME } from "../strands/ir_types";
 import { getNodeDataFromID, extractNodeTypeInfo } from "../strands/ir_dag";
 import * as FES from '../strands/strands_FES';
@@ -173,6 +175,12 @@ export const glslBackend = {
   getNoiseShaderSnippet() {
     return noiseGLSL;
   },
+  getRandomFragmentShaderSnippet() {
+    return randomGLSL;
+  },
+  getRandomVertexShaderSnippet() {
+    return randomVertGLSL;
+  },
   getTypeName(baseType, dimension) {
     const primitiveTypeName = TypeNames[baseType + dimension]
     if (!primitiveTypeName) {