processing 0.5.33 → 0.5.34

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dab32bbed423946f694674083de28850917630c66d56ad2014a0697aa775174d
-  data.tar.gz: 7ea5a81282e81365a2be85bbfd94ae4ae7586c03996aa8fb65aee32352cc633d
+  metadata.gz: e54026be3e0523b71c57d18c46525a46dd0291fea20c916c9a77d06398735e15
+  data.tar.gz: 7c38db77660d2ddddaba759396e54ea6245b1bca132684292e25d306273e433e
 SHA512:
-  metadata.gz: 25ac561f378c41c152c7959390a1a971621fb8633c591bd9e30df6cd06f6c7012681b2c220f5b44f6b3b619147488a949197cdbfa1c2fd2d827d17066676f832
-  data.tar.gz: 42b75f23f7f0aed79df3298507d0c40b0b0cc9c32752268e0f853937938dc5b3eb06cc1467a5ea85d348f8655ef702611770a1359fd32a22e4b80f9ddc5a436c
+  metadata.gz: 7d2f9f2a261da953754a3476140069d6493b17d1d476bdc7907e35662ce1f9e7633339995f2613871fa3a0f3053cc1397300d1827382270e0783dad80b5f8640
+  data.tar.gz: 97c6eeff19b69a6874db4f1672bd0d140081fda349ca64850f5c10b7ecf343517e3a87e60bb5b5c5a2b005d89103a8ca1308ce460d55736507c33cb206c9a50f

data/ChangeLog.md

@@ -1,6 +1,12 @@
 # processing ChangeLog
 
 
+## [v0.5.34] - 2024-02-16
+
+- Add '@see' links to documents
+- Fix missing nil returning
+
+
 ## [v0.5.33] - 2024-02-07
 
 - Add curveDetail() and bezierDetail()
@@ -64,7 +70,7 @@
 - Add createShape(), shape(), shapeMode()
 - Add beginShape(), endShape(), and vertex(x, y)
 - Test with p5.rb
-- GraphicsContext#rotate() can take z parameter
+- GraphicsContext#scale() can take z parameter
 - Set default miter_limit to 10
 - Trigger github actions on all pull_request
 

data/VERSION

@@ -1 +1 @@
-0.5.33
+0.5.34

data/lib/processing/context.rb

@@ -180,6 +180,9 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://processing.org/reference/setup_.html
+    # @see https://p5js.org/reference/#/p5/setup
+    #
     def setup(&block)
       @window__.setup = block if block
       nil
@@ -210,6 +213,9 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://processing.org/reference/draw_.html
+    # @see https://p5js.org/reference/#/p5/draw
+    #
     def draw(&block)
       @drawBlock__ = block if block
       nil
@@ -219,6 +225,9 @@ module Processing
     #
     # @return [Boolean] is any key pressed or not
     #
+    # @see https://processing.org/reference/keyPressed_.html
+    # @see https://p5js.org/reference/#/p5/keyPressed
+    #
     def keyPressed(&block)
       @keyPressedBlock__ = block if block
       keyIsPressed
@@ -228,6 +237,9 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://processing.org/reference/keyReleased_.html
+    # @see https://p5js.org/reference/#/p5/keyReleased
+    #
     def keyReleased(&block)
       @keyReleasedBlock__ = block if block
       nil
@@ -237,6 +249,9 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://processing.org/reference/keyTyped_.html
+    # @see https://p5js.org/reference/#/p5/keyTyped
+    #
     def keyTyped(&block)
       @keyTypedBlock__ = block if block
       nil
@@ -246,6 +261,10 @@ module Processing
     #
     # @return [Boolean] is any mouse button pressed or not
     #
+    # @see https://processing.org/reference/mousePressed_.html
+    # @see https://processing.org/reference/mousePressed.html
+    # @see https://p5js.org/reference/#/p5/mousePressed
+    #
     def mousePressed(&block)
       @mousePressedBlock__ = block if block
       not @pointersPressed__.empty?
@@ -255,6 +274,9 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://processing.org/reference/mouseReleased_.html
+    # @see https://p5js.org/reference/#/p5/mouseReleased
+    #
     def mouseReleased(&block)
       @mouseReleasedBlock__ = block if block
       nil
@@ -264,6 +286,9 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://processing.org/reference/mouseMoved_.html
+    # @see https://p5js.org/reference/#/p5/mouseMoved
+    #
     def mouseMoved(&block)
       @mouseMovedBlock__ = block if block
       nil
@@ -273,6 +298,9 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://processing.org/reference/mouseDragged_.html
+    # @see https://p5js.org/reference/#/p5/mouseDragged
+    #
     def mouseDragged(&block)
       @mouseDraggedBlock__ = block if block
       nil
@@ -282,6 +310,9 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://processing.org/reference/mouseClicked_.html
+    # @see https://p5js.org/reference/#/p5/mouseClicked
+    #
     def mouseClicked(&block)
       @mouseClickedBlock__ = block if block
       nil
@@ -291,6 +322,8 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://p5js.org/reference/#/p5/doubleClicked
+    #
     def doubleClicked(&block)
       @doubleClickedBlock__ = block if block
       nil
@@ -300,6 +333,9 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://processing.org/reference/mouseWheel_.html
+    # @see https://p5js.org/reference/#/p5/mouseWheel
+    #
     def mouseWheel(&block)
       @mouseWheelBlock__ = block if block
       nil
@@ -309,6 +345,8 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://p5js.org/reference/#/p5/touchStarted
+    #
     def touchStarted(&block)
       @touchStartedBlock__ = block if block
       nil
@@ -318,6 +356,8 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://p5js.org/reference/#/p5/touchEnded
+    #
     def touchEnded(&block)
       @touchEndedBlock__ = block if block
       nil
@@ -327,6 +367,8 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://p5js.org/reference/#/p5/touchMoved
+    #
     def touchMoved(&block)
       @touchMovedBlock__ = block if block
       nil
@@ -336,6 +378,8 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://processing.org/reference/windowMoved_.html
+    #
     def windowMoved(&block)
       @windowMovedBlock__ = block if block
       nil
@@ -345,6 +389,9 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://processing.org/reference/windowResized_.html
+    # @see https://p5js.org/reference/#/p5/windowResized
+    #
     def windowResized(&block)
       @windowResizedBlock__ = block if block
       nil
@@ -367,6 +414,8 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://processing.org/reference/size_.html
+    #
     def size(width, height, pixelDensity: self.pixelDensity)
       windowResize width, height
       resizeCanvas__ width, height, pixelDensity
@@ -381,6 +430,8 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://p5js.org/reference/#/p5/createCanvas
+    #
     def createCanvas(width, height, pixelDensity: self.pixelDensity)
       windowResize width, height
       resizeCanvas__ width, height, pixelDensity
@@ -393,6 +444,8 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://processing.org/reference/setTitle_.html
+    #
     def setTitle(title)
       @window__.title = title
       nil
@@ -404,6 +457,9 @@ module Processing
     #
     # @return [Numeric] current pixel density
     #
+    # @see https://processing.org/reference/pixelDensity_.html
+    # @see https://p5js.org/reference/#/p5/pixelDensity
+    #
     def pixelDensity(density = nil)
       resizeCanvas__ width, height, density if density
       @window__.canvas.pixel_density
@@ -430,6 +486,9 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://processing.org/reference/smooth_.html
+    # @see https://p5js.org/reference/#/p5/smooth
+    #
     def smooth()
       @smooth__ = true
       resizeCanvas__ width, height, pixelDensity
@@ -440,6 +499,9 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://processing.org/reference/noSmooth_.html
+    # @see https://p5js.org/reference/#/p5/noSmooth
+    #
     def noSmooth()
       @smooth__ = false
       resizeCanvas__ width, height, pixelDensity
@@ -455,6 +517,9 @@ module Processing
     #
     # @return [Numeric] width
     #
+    # @see https://processing.org/reference/displayWidth.html
+    # @see https://p5js.org/reference/#/p5/displayWidth
+    #
     def displayWidth()
       @window__.screen.width
     end
@@ -463,6 +528,9 @@ module Processing
     #
     # @return [Numeric] height
     #
+    # @see https://processing.org/reference/displayHeight.html
+    # @see https://p5js.org/reference/#/p5/displayHeight
+    #
     def displayHeight()
       @window__.screen.height
     end
@@ -471,6 +539,9 @@ module Processing
     #
     # @return [Numeric] pixel density
     #
+    # @see https://processing.org/reference/displayDensity_.html
+    # @see https://p5js.org/reference/#/p5/displayDensity
+    #
     def displayDensity()
       @window__.painter.pixel_density
     end
@@ -482,6 +553,8 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://processing.org/reference/windowMove_.html
+    #
     def windowMove(x, y)
       @window__.pos = [x, y]
       nil
@@ -494,6 +567,8 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://processing.org/reference/windowResize_.html
+    #
     def windowResize(width, height)
       @window__.size = [width, height]
       nil
@@ -505,6 +580,8 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://processing.org/reference/windowResizable_.html
+    #
     def windowResizable(resizable)
       @window__.resizable = resizable
       nil
@@ -516,6 +593,7 @@ module Processing
     #
     # @return [nil] nil
     #
+    #
     def windowOrientation(*orientations)
       @window__.orientations = orientations.flatten.uniq
     end
@@ -540,6 +618,8 @@ module Processing
     #
     # @return [Numeric] window width
     #
+    # @see https://p5js.org/reference/#/p5/windowWidth
+    #
     def windowWidth()
       @window__.width
     end
@@ -548,6 +628,8 @@ module Processing
     #
     # @return [Numeric] window height
     #
+    # @see https://p5js.org/reference/#/p5/windowHeight
+    #
     def windowHeight()
       @window__.height
     end
@@ -556,6 +638,9 @@ module Processing
     #
     # @return [Boolean] active or not
     #
+    # @see https://processing.org/reference/focused.html
+    # @see https://p5js.org/reference/#/p5/focused
+    #
     def focused()
       @window__.active?
     end
@@ -564,6 +649,9 @@ module Processing
     #
     # @return [Integer] total number of frames
     #
+    # @see https://processing.org/reference/frameCount.html
+    # @see https://p5js.org/reference/#/p5/frameCount
+    #
     def frameCount()
       @frameCount__
     end
@@ -572,6 +660,9 @@ module Processing
     #
     # @return [Float] frames per second
     #
+    # @see https://processing.org/reference/frameRate.html
+    # @see https://p5js.org/reference/#/p5/frameRate
+    #
     def frameRate()
       @window__.event.fps
     end
@@ -580,6 +671,8 @@ module Processing
     #
     # @return [Float] elapsed time in milliseconds
     #
+    # @see https://p5js.org/reference/#/p5/deltaTime
+    #
     def deltaTime()
       @window__.event.dt * 1000
     end
@@ -588,6 +681,9 @@ module Processing
     #
     # @return [String] last key
     #
+    # @see https://processing.org/reference/key.html
+    # @see https://p5js.org/reference/#/p5/key
+    #
     def key()
       @key__
     end
@@ -596,6 +692,9 @@ module Processing
     #
     # @return [Symbol] last key code
     #
+    # @see https://processing.org/reference/keyCode.html
+    # @see https://p5js.org/reference/#/p5/keyCode
+    #
     def keyCode()
       @keyCode__
     end
@@ -604,6 +703,8 @@ module Processing
     #
     # @return [Boolean] is any key pressed or not
     #
+    # @see https://p5js.org/reference/#/p5/keyIsPressed
+    #
     def keyIsPressed()
       not @keysPressed__.empty?
     end
@@ -614,6 +715,8 @@ module Processing
     #
     # @return [Boolean] is the key pressed or not
     #
+    # @see https://p5js.org/reference/#/p5/keyIsDown
+    #
     def keyIsDown(keyCode)
       @keysPressed__.include? keyCode
     end
@@ -622,6 +725,9 @@ module Processing
     #
     # @return [Numeric] horizontal position of mouse
     #
+    # @see https://processing.org/reference/mouseX.html
+    # @see https://p5js.org/reference/#/p5/mouseX
+    #
     def mouseX()
       @pointer__&.x || 0
     end
@@ -630,6 +736,9 @@ module Processing
     #
     # @return [Numeric] vertical position of mouse
     #
+    # @see https://processing.org/reference/mouseY.html
+    # @see https://p5js.org/reference/#/p5/mouseY
+    #
     def mouseY()
       @pointer__&.y || 0
     end
@@ -638,6 +747,9 @@ module Processing
     #
     # @return [Numeric] horizontal position of mouse
     #
+    # @see https://processing.org/reference/pmouseX.html
+    # @see https://p5js.org/reference/#/p5/pmouseX
+    #
     def pmouseX()
       @pointerPrev__&.x || 0
     end
@@ -646,6 +758,9 @@ module Processing
     #
     # @return [Numeric] vertical position of mouse
     #
+    # @see https://processing.org/reference/pmouseY.html
+    # @see https://p5js.org/reference/#/p5/pmouseY
+    #
     def pmouseY()
       @pointerPrev__&.y || 0
     end
@@ -654,6 +769,9 @@ module Processing
     #
     # @return [Numeric] LEFT, RIGHT, CENTER or 0
     #
+    # @see https://processing.org/reference/mouseButton.html
+    # @see https://p5js.org/reference/#/p5/mouseButton
+    #
     def mouseButton()
       ((@pointersPressed__ + @pointersReleased__) & [LEFT, RIGHT, CENTER]).last
     end
@@ -662,6 +780,8 @@ module Processing
     #
     # @return [Array] Touch objects
     #
+    # @see https://p5js.org/reference/#/p5/touches
+    #
     def touches()
       @touches__
     end
@@ -678,6 +798,9 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://processing.org/reference/loop_.html
+    # @see https://p5js.org/reference/#/p5/loop
+    #
     def loop()
       @loop__ = true
     end
@@ -686,6 +809,9 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://processing.org/reference/noLoop_.html
+    # @see https://p5js.org/reference/#/p5/noLoop
+    #
     def noLoop()
       @loop__ = false
     end
@@ -694,6 +820,9 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://processing.org/reference/redraw_.html
+    # @see https://p5js.org/reference/#/p5/redraw
+    #
     def redraw()
       @redraw__ = true
     end

data/lib/processing/font.rb

@@ -3,6 +3,9 @@ module Processing
 
   # Font object.
   #
+  # @see https://processing.org/reference/PFont.html
+  # @see https://p5js.org/reference/#/p5.Font
+  #
   class Font
 
     # @private
@@ -24,6 +27,8 @@ module Processing
     #
     # @return [TextBounds] bounding box for text
     #
+    # @see https://p5js.org/reference/#/p5.Font/textBounds
+    #
     def textBounds(str, x = 0, y = 0, fontSize = nil)
       font = getInternal__ fontSize
       TextBounds.new x, y, x + font.width(str), y + font.height

data/lib/processing/graphics.rb

@@ -3,6 +3,9 @@ module Processing
 
   # Draws graphics into an offscreen buffer
   #
+  # @see https://processing.org/reference/PGraphics.html
+  # @see https://p5js.org/reference/#/p5.Graphics
+  #
   class Graphics
 
     include Xot::Inspectable
@@ -10,6 +13,8 @@ module Processing
 
     # Initialize graphics object.
     #
+    # @see https://p5js.org/reference/#/p5.Graphics
+    #
     def initialize(width, height, pixelDensity = 1)
       image = Rays::Image.new width, height, Rays::RGBA, pixelDensity
       init__ image, image.painter
@@ -17,6 +22,8 @@ module Processing
 
     # Start drawing.
     #
+    # @see https://processing.org/reference/PGraphics_beginDraw_.html
+    #
     def beginDraw(&block)
       @painter__.__send__ :begin_paint
       beginDraw__
@@ -32,6 +39,8 @@ module Processing
 
     # End drawing.
     #
+    # @see https://processing.org/reference/PGraphics_endDraw_.html
+    #
     def endDraw()
       pop
       endDraw__