Merge pull request #8036 from processing/fix/noise

Fix noise() getting overridden; add tests

Author: ksen0

src/webgl/ShaderGenerator.js

@@ -33,7 +33,11 @@ function shadergenerator(p5, fn) {
         const transpiledSource = escodegen.generate(ast);
         const scopeKeys = Object.keys(scope);
         const internalGeneratorFunction = new Function(
-          'p5',
+          // Create a parameter called __p5, not just p5, because users of instance mode
+          // may pass in a variable called p5 as a scope variable. If we rely on a variable called
+          // p5, then the scope variable called p5 might accidentally override internal function
+          // calls to p5 static methods.
+          '__p5',
           ...scopeKeys,
           transpiledSource
           .slice(
@@ -100,7 +104,7 @@ function shadergenerator(p5, fn) {
           node.type = 'CallExpression'
           node.callee = {
             type: 'Identifier',
-            name: 'p5.unaryNode',
+            name: '__p5.unaryNode',
           }
           node.arguments = [node.argument, signNode]
       }
@@ -123,7 +127,7 @@ function shadergenerator(p5, fn) {
             type: 'CallExpression',
             callee: {
               type: 'Identifier',
-              name: 'p5.unaryNode'
+              name: '__p5.unaryNode'
             },
             arguments: [node.argument.object, signNode],
           };
@@ -188,7 +192,7 @@ function shadergenerator(p5, fn) {
       node.type = 'CallExpression';
       node.callee = {
         type: 'Identifier',
-        name: 'p5.dynamicNode',
+        name: '__p5.dynamicNode',
       };
       node.arguments = [original];
     },
@@ -242,7 +246,7 @@ function shadergenerator(p5, fn) {
           type: 'CallExpression',
           callee: {
             type: 'Identifier',
-            name: 'p5.dynamicNode',
+            name: '__p5.dynamicNode',
           },
           arguments: [node.left]
         }
@@ -1608,7 +1612,6 @@ function shadergenerator(p5, fn) {
     ],
     'sqrt': { args: ['genType'], returnType: 'genType', isp5Function: true},
     'step': { args: ['genType', 'genType'], returnType: 'genType', isp5Function: false},
-    'noise': { args: ['vec2'], returnType: 'float', isp5Function: false },
     'trunc': { args: ['genType'], returnType: 'genType', isp5Function: false},
 
     ////////// Vector //////////
@@ -1675,7 +1678,7 @@ function shadergenerator(p5, fn) {
     } else {
       nodeArgs = args;
     }
-    
+
     return fnNodeConstructor('noise', nodeArgs, {
       args: ['vec2'],
       returnType: 'float'

test/unit/visual/cases/noise.js

@@ -0,0 +1,31 @@
+import { visualSuite, visualTest } from '../visualTest';
+
+visualSuite('Noise', function() {
+  visualTest('Drawn as values', function(p5, screenshot) {
+    p5.createCanvas(50, 50);
+    p5.background(255);
+    p5.strokeWeight(2);
+    p5.noFill();
+    p5.noiseSeed(0);
+    p5.beginShape();
+    for (let x = 0; x <= p5.width; x += 2) {
+      p5.vertex(x, p5.noise(x * 0.1) * p5.height);
+    }
+    p5.endShape();
+    screenshot();
+  });
+
+  visualTest('Drawn in a shader', function(p5, screenshot) {
+    p5.createCanvas(50, 50, p5.WEBGL);
+    const shader = p5.baseFilterShader().modify(() => {
+      p5.getColor((inputs) => {
+        const value = p5.clamp(p5.noise(inputs.texCoord * 4) * 2, 0, 1);
+        return [value, value, value, 1];
+      });
+    }, { p5 });
+    p5.filter(shader);
+    screenshot();
+  }, { skip: true });
+  // TODO(dave): Figure out why the noise shader looks different on CI and
+  // re-enable this test
+});

test/unit/visual/screenshots/Noise/Drawn as values/000.png

@@ -0,0 +1,3 @@
+{
+  "numScreenshots": 1
+}

test/unit/visual/screenshots/Noise/Drawn as values/metadata.json

@@ -0,0 +1,3 @@
+{
+  "numScreenshots": 1
+}