processing 0.5.33 → 0.5.34

data/lib/processing/image.rb

@@ -3,6 +3,9 @@ module Processing
 
   # Image object.
   #
+  # @see https://processing.org/reference/PImage.html
+  # @see https://p5js.org/reference/#/p5.Image
+  #
   class Image
 
     include Xot::Inspectable
@@ -17,6 +20,9 @@ module Processing
     #
     # @return [Numeric] width of image
     #
+    # @see https://processing.org/reference/PImage_width.html
+    # @see https://p5js.org/reference/#/p5.Image/width
+    #
     def width()
       @image&.width || (@error ? -1 : 0)
     end
@@ -25,6 +31,9 @@ module Processing
     #
     # @return [Numeric] height of image
     #
+    # @see https://processing.org/reference/PImage_height.html
+    # @see https://p5js.org/reference/#/p5.Image/height
+    #
     def height()
       @image&.height || (@error ? -1 : 0)
     end
@@ -48,6 +57,9 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://processing.org/reference/PImage_set_.html
+    # @see https://p5js.org/reference/#/p5.Image/set
+    #
     def set(x, y, c)
       getInternal__.bitmap(true)[x, y] = self.class.fromColor__(c).map {|n| n / 255.0}
       nil
@@ -57,6 +69,9 @@ module Processing
     #
     # @return [Integer] color value (0xAARRGGBB)
     #
+    # @see https://processing.org/reference/PImage_get_.html
+    # @see https://p5js.org/reference/#/p5.Image/get
+    #
     def get(x, y)
       getInternal__.bitmap[x, y]
         .map {|n| (n * 255).to_i.clamp 0, 255}
@@ -67,6 +82,9 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://processing.org/reference/PImage_loadPixels_.html
+    # @see https://p5js.org/reference/#/p5.Image/loadPixels
+    #
     def loadPixels()
       @pixels = getInternal__.pixels
     end
@@ -75,6 +93,9 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://processing.org/reference/PImage_updatePixels_.html
+    # @see https://p5js.org/reference/#/p5.Image/updatePixels
+    #
     def updatePixels()
       return unless @pixels
       getInternal__.pixels = @pixels
@@ -84,6 +105,11 @@ module Processing
     # An array of all pixels.
     # Call loadPixels() before accessing the array.
     #
+    # @return [Array] color array
+    #
+    # @see https://processing.org/reference/PImage_pixels.html
+    # @see https://p5js.org/reference/#/p5.Image/pixels
+    #
     attr_reader :pixels
 
     # Applies an image filter.
@@ -96,6 +122,9 @@ module Processing
     # @param type   [THRESHOLD, GRAY, INVERT, BLUR] filter type
     # @param param  [Numeric] a parameter for each filter
     #
+    # @see https://processing.org/reference/PImage_filter_.html
+    # @see https://p5js.org/reference/#/p5.Image/filter
+    #
     def filter(*args)
       @filter = Shader.createFilter__(*args)
     end
@@ -107,6 +136,9 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://processing.org/reference/PImage_resize_.html
+    # @see https://p5js.org/reference/#/p5.Image/resize
+    #
     def resize(width, height)
       @image = Rays::Image.new(width, height).paint do |painter|
         painter.image getInternal__, 0, 0, width, height
@@ -131,10 +163,18 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://processing.org/reference/PImage_copy_.html
+    # @see https://p5js.org/reference/#/p5.Image/copy
+    #
     def copy(img = nil, sx, sy, sw, sh, dx, dy, dw, dh)
       blend img, sx, sy, sw, sh, dx, dy, dw, dh, :normal
     end
 
+    # @private
+    def mask__()
+      raise NotImplementedError
+    end
+
     # Blends image.
     #
     # @overload blend(sx, sy, sw, sh, dx, dy, dw, dh, mode)
@@ -153,6 +193,9 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://processing.org/reference/PImage_blend_.html
+    # @see https://p5js.org/reference/#/p5.Image/blend
+    #
     def blend(img = nil, sx, sy, sw, sh, dx, dy, dw, dh, mode)
       img ||= self
       getInternal__.paint do |painter|
@@ -161,12 +204,60 @@ module Processing
       nil
     end
 
+    # @private
+    def blendColor__()
+      raise NotImplementedError
+    end
+
+    # @private
+    def reset__()
+      raise NotImplementedError
+    end
+
+    # @private
+    def setFrame__()
+      raise NotImplementedError
+    end
+
+    # @private
+    def getCurrentFrame__()
+      raise NotImplementedError
+    end
+
+    # @private
+    def setFrame__()
+      raise NotImplementedError
+    end
+
+    # @private
+    def numFrames__()
+      raise NotImplementedError
+    end
+
+    # @private
+    def play__()
+      raise NotImplementedError
+    end
+
+    # @private
+    def pause__()
+      raise NotImplementedError
+    end
+
+    # @private
+    def delay__()
+      raise NotImplementedError
+    end
+
     # Saves image to file.
     #
     # @param filename [String] file name to save image
     #
     # @return [nil] nil
     #
+    # @see https://processing.org/reference/PImage_save_.html
+    # @see https://p5js.org/reference/#/p5.Image/save
+    #
     def save(filename)
       getInternal__.save filename
       nil

data/lib/processing/shader.rb

@@ -3,6 +3,9 @@ module Processing
 
   # Shader object.
   #
+  # @see https://processing.org/reference/PShader.html
+  # @see https://p5js.org/reference/#/p5.Shader
+  #
   class Shader
 
     include Xot::Inspectable
@@ -13,7 +16,7 @@ module Processing
     # @param fragSrc [String] fragment shader source
     #
     def initialize(vertSrc, fragSrc)
-      @shader = Rays::Shader.new modifyFragSource(fragSrc), vertSrc, ENV__
+      @shader = Rays::Shader.new modifyFragSource__(fragSrc), vertSrc, ENV__
     end
 
     # Sets uniform variables.
@@ -37,7 +40,10 @@ module Processing
     # @param ncoords [Integer] number of coordinates, max 4
     # @param tex     [Image]   texture image
     #
-    def setUniform(name, *args)
+    # @see https://processing.org/reference/PShader_set_.html
+    # @see https://p5js.org/reference/#/p5.Shader/setUniform
+    #
+    def set(name, *args)
       arg = args.first
       case
       when Array === arg
@@ -54,7 +60,7 @@ module Processing
       end
     end
 
-    alias set setUniform
+    alias setUniform set
 
     # @private
     def getInternal__()
@@ -83,13 +89,13 @@ module Processing
       when Shader
         arg
       when :threshold
-        self.new(nil, THRESHOLD_SOURCE).tap {|sh| sh.set :threshold, (args.shift || 0.5)}
+        self.new(nil, THRESHOLD_SOURCE__).tap {|sh| sh.set :threshold, (args.shift || 0.5)}
       when :gray
-        self.new nil, GRAY_SOURCE
+        self.new nil, GRAY_SOURCE__
       when :invert
-        self.new nil, INVERT_SOURCE
+        self.new nil, INVERT_SOURCE__
       when :blur
-        self.new(nil, BLUR_SOURCE).tap {|sh| sh.set :radius, (args.shift || 1).to_f}
+        self.new(nil, BLUR_SOURCE__).tap {|sh| sh.set :radius, (args.shift || 1).to_f}
       else
         nil
       end
@@ -97,7 +103,8 @@ module Processing
 
     private
 
-    THRESHOLD_SOURCE = <<~END
+    # @private
+    THRESHOLD_SOURCE__ = <<~END
       uniform float threshold;
       uniform sampler2D texMap;
       varying vec4 vertTexCoord;
@@ -109,7 +116,8 @@ module Processing
       }
     END
 
-    GRAY_SOURCE = <<~END
+    # @private
+    GRAY_SOURCE__ = <<~END
       uniform sampler2D texMap;
       varying vec4 vertTexCoord;
       varying vec4 vertColor;
@@ -120,7 +128,8 @@ module Processing
       }
     END
 
-    INVERT_SOURCE = <<~END
+    # @private
+    INVERT_SOURCE__ = <<~END
       uniform sampler2D texMap;
       varying vec4 vertTexCoord;
       varying vec4 vertColor;
@@ -130,7 +139,8 @@ module Processing
       }
     END
 
-    BLUR_SOURCE = <<~END
+    # @private
+    BLUR_SOURCE__ = <<~END
       #define PI 3.1415926538
       uniform float radius;
       uniform sampler2D texMap;
@@ -163,9 +173,10 @@ module Processing
       }
     END
 
-    def modifyFragSource(source)
+    # @private
+    def modifyFragSource__(source)
       return nil unless source
-      if hasShadertoyMainImage?(source) && source !~ /void\s+main\s*\(/
+      if hasShadertoyMainImage__?(source) && source !~ /void\s+main\s*\(/
         source += <<~END
           varying vec4 vertTexCoord;
           void main() {
@@ -178,7 +189,7 @@ module Processing
         iResolution: :vec2,
         iMouse:      :vec2
       }.each do |uniformName, type|
-        if needsUniformDeclaration type, uniformName, source
+        if needsUniformDeclaration__ type, uniformName, source
           source = <<~END + source
             uniform #{type} #{uniformName};
           END
@@ -187,11 +198,13 @@ module Processing
       source
     end
 
-    def hasShadertoyMainImage?(source)
+    # @private
+    def hasShadertoyMainImage__?(source)
       source =~ /void\s+mainImage\s*\(\s*out\s+vec4\s+\w+\s*,\s*in\s+vec2\s+\w+\s*\)/
     end
 
-    def needsUniformDeclaration(type, uniformName, source)
+    # @private
+    def needsUniformDeclaration__(type, uniformName, source)
       source.include?(uniformName.to_s) &&
         source !~ /uniform\s+#{type}\s+#{uniformName}/
     end