Module: Processing::GraphicsContext

Included in:
Context, Graphics
Defined in:
lib/processing/graphics_context.rb

Overview

Drawing context

Constant Summary collapse

PI =

PI

Math::PI
HALF_PI =

PI / 2

PI / 2
QUARTER_PI =

PI / 4

PI / 4
TWO_PI =

PI * 2

PI * 2
TAU =

PI * 2

PI * 2
PROCESSING =

Processing mode for renderMode().

:processing
P5JS =

p5.js mode for renderMode().

:p5js
RGBA =

RGBA format for createImage().

:rgba
RGB =

RGB format for createImage, or RGB mode for colorMode().

:rgb
HSB =

HSB mode for colorMode().

:hsb
RADIANS =

Radian mode for angleMode().

:radians
DEGREES =

Degree mode for angleMode().

:degrees
CORNER =

Mode for rectMode(), ellipseMode(), imageMode(), and shapeMode().

:corner
CORNERS =

Mode for rectMode(), ellipseMode(), imageMode(), and shapeMode().

:corners
CENTER =

Mode for rectMode(), ellipseMode(), imageMode(), shapeMode(), and textAlign().

:center
RADIUS =

Mode for rectMode() and ellipseMode().

:radius
PROJECT =

Mode for strokeCap().

:square
MITER =

Mode for strokeJoin().

:miter
ROUND =

Mode for strokeCap() and strokeJoin().

:round
SQUARE =

Mode for strokeCap() and strokeJoin().

:butt
BLEND =

Mode for blendMode().

:normal
ADD =

Mode for blendMode().

:add
SUBTRACT =

Mode for blendMode().

:subtract
LIGHTEST =

Mode for blendMode().

:lightest
DARKEST =

Mode for blendMode().

:darkest
EXCLUSION =

Mode for blendMode().

:exclusion
MULTIPLY =

Mode for blendMode().

:multiply
SCREEN =

Mode for blendMode().

:screen
REPLACE =

Mode for blendMode().

:replace
LEFT =

Key code or Mode for textAlign().

:left
RIGHT =

Key code or Mode for textAlign().

:right
TOP =

Mode for textAlign().

:top
BOTTOM =

Mode for textAlign().

:bottom
BASELINE =

Mode for textAlign().

:baseline
IMAGE =

Mode for textureMode().

:image
NORMAL =

Mode for textureMode().

:normal
CLAMP =

Mode for textureWrap().

:clamp
REPEAT =

Mode for textureWrap().

:repeat
THRESHOLD =

Filter type for filter()

:threshold
GRAY =

Filter type for filter()

:gray
INVERT =

Filter type for filter()

:invert
BLUR =

Filter type for filter()

:blur
LINE =

Shape mode for createShape()

:line
RECT =

Shape mode for createShape()

:rect
ELLIPSE =

Shape mode for createShape()

:ellipse
ARC =

Shape mode for createShape()

:arc
TRIANGLE =

Shape mode for createShape()

:triangle
QUAD =

Shape mode for createShape()

:quad
GROUP =

Shape mode for createShape()

:group
POINTS =

Shape mode for beginShape()

:points
LINES =

Shape mode for beginShape()

:lines
TRIANGLES =

Shape mode for beginShape()

:triangles
TRIANGLE_FAN =

Shape mode for beginShape()

:triangle_fan
TRIANGLE_STRIP =

Shape mode for beginShape()

:triangle_strip
QUADS =

Shape mode for beginShape()

:quads
QUAD_STRIP =

Shape mode for beginShape()

:quad_strip
TESS =

Shape mode for beginShape()

:tess
OPEN =

OPEN flag for endShape()

:open
CLOSE =

CLOSE flag for endShape()

:close
ENTER =

Key codes.

:enter
SPACE = 
:space
TAB = 
:tab
DELETE = 
:delete
BACKSPACE = 
:backspace
ESC = 
:escape
HOME = 
:home
PAGEUP =

END = :end

:pageup
PAGEDOWN = 
:pagedown
CLEAR = 
:clear
SHIFT = 
:shift
CONTROL = 
:control
ALT = 
:alt
WIN = 
:win
COMMAND = 
:command
OPTION = 
:option
FUNCTION = 
:function
CAPSLOCK = 
:capslock
SECTION = 
:section
HELP = 
:help
F1 = 
:f1
F2 = 
:f2
F3 = 
:f3
F4 = 
:f4
F5 = 
:f5
F6 = 
:f6
F7 = 
:f7
F8 = 
:f8
F9 = 
:f9
F10 = 
:f10
F11 = 
:f11
F12 = 
:f12
F13 = 
:f13
F14 = 
:f14
F15 = 
:f15
F16 = 
:f16
F17 = 
:f17
F18 = 
:f18
F19 = 
:f19
F20 = 
:f20
F21 = 
:f21
F22 = 
:f22
F23 = 
:f23
F24 = 
:f24
UP = 
:up
DOWN = 
:down

Instance Method Summary collapse

Instance Method Details

#abs(value) ⇒ Numeric

Returns the absolute number of the value.

Parameters:

  • value (Numeric) —

    number

Returns:

  • (Numeric) —

    absolute number

See Also:



2322
2323
2324
 
# File 'lib/processing/graphics_context.rb', line 2322

def abs(value)
  value.abs
end

#acos(value) ⇒ Numeric

Returns the inverse of cos().

Parameters:

  • value (Numeric) —

    value for calculation

Returns:

  • (Numeric) —

    the arc cosine

See Also:



2693
2694
2695
 
# File 'lib/processing/graphics_context.rb', line 2693

def acos(value)
  Math.acos value
end

#alpha(color) ⇒ Numeric

Returns the red value of the color.

Parameters:

  • color (Numeric) —

    color value

Returns:

  • (Numeric) —

    the red value

See Also:



586
587
588
 
# File 'lib/processing/graphics_context.rb', line 586

def alpha(color)
  ((color >> 24) & 0xff) / 255.0 * @colorMaxes__[3]
end

#angleMode(mode = nil) ⇒ RADIANS, DEGREES

Sets angle mode.

Parameters:

Returns:

See Also:



682
683
684
685
686
687
688
689
690
691
692
693
 
# File 'lib/processing/graphics_context.rb', line 682

def angleMode(mode = nil)
  if mode != nil
    @angleMode__  = mode
    @toRad__, @toDeg__, @fromRad__, @fromDeg__ =
      case mode.downcase.to_sym
      when RADIANS then [1.0,      RAD2DEG__, 1.0,       DEG2RAD__]
      when DEGREES then [DEG2RAD__, 1.0,      RAD2DEG__, 1.0]
      else raise ArgumentError, "invalid angle mode: #{mode}"
      end
  end
  @angleMode__
end

#applyMatrix(array) ⇒ nil #applyMatrix(a, b, c, d, e, f) ⇒ nil #applyMatrix(a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p) ⇒ nil

Reset current transformation matrix with 2x3, or 4x4 matrix.

Parameters:

  • array (Array) —

    6 or 16 numbers which define the matrix

  • a (Numeric) —

    number which defines the matrix

  • b (Numeric) —

    number which defines the matrix

  • c (Numeric) —

    number which defines the matrix

  • d (Numeric) —

    number which defines the matrix

  • e (Numeric) —

    number which defines the matrix

  • f (Numeric) —

    number which defines the matrix

  • g (Numeric) —

    number which defines the matrix

  • h (Numeric) —

    number which defines the matrix

  • i (Numeric) —

    number which defines the matrix

  • j (Numeric) —

    number which defines the matrix

  • k (Numeric) —

    number which defines the matrix

  • l (Numeric) —

    number which defines the matrix

  • m (Numeric) —

    number which defines the matrix

  • n (Numeric) —

    number which defines the matrix

  • o (Numeric) —

    number which defines the matrix

  • p (Numeric) —

    number which defines the matrix

Returns:

  • (nil) —

    nil

Raises:

  • (ArgumentError)

See Also:



2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
 
# File 'lib/processing/graphics_context.rb', line 2123

def applyMatrix(*args)
  assertDrawing__
  args = args.first if args.first.kind_of?(Array)
  if args.size == 6
    a, b, c, d, e, f = args
    args = [
      a, b, 0, 0,
      c, d, 0, 0,
      0, 0, 1, 0,
      e, f, 0, 1
    ]
  end
  raise ArgumentError unless args.size == 16
  m = Rays::Matrix.new(*args)
  m.transpose! if @p5jsMode__
  @painter__.matrix *= m
  nil
end

#arc(a, b, c, d, start, stop) ⇒ nil Also known as: drawArc

Draws an arc.

The parameters a, b, c, and d are determined by ellipseMode().

Parameters:

  • a (Numeric) —

    horizontal position of the shape, by default

  • b (Numeric) —

    vertical position of the shape, by default

  • c (Numeric) —

    width of the shape, by default

  • d (Numeric) —

    height of the shape, by default

  • start (Numeric) —

    angle to start the arc

  • stop (Numeric) —

    angle to stop the arc

Returns:

  • (nil) —

    nil

See Also:



1436
1437
1438
1439
1440
1441
1442
 
# File 'lib/processing/graphics_context.rb', line 1436

def arc(a, b, c, d, start, stop)
  assertDrawing__
  x, y, w, h = toXYWH__ @ellipseMode__, a, b, c, d
  from, to   = toDegrees__(-start), toDegrees__(-stop)
  @painter__.ellipse x, y, w, h, from: from, to: to
  nil
end

#asin(value) ⇒ Numeric

Returns the inverse of sin().

Parameters:

  • value (Numeric) —

    value for calculation

Returns:

  • (Numeric) —

    the arc sine

See Also:



2680
2681
2682
 
# File 'lib/processing/graphics_context.rb', line 2680

def asin(value)
  Math.asin value
end

#atan(value) ⇒ Numeric

Returns the inverse of tan().

Parameters:

  • value (Numeric) —

    value for valculation

Returns:

  • (Numeric) —

    the arc tangent

See Also:



2706
2707
2708
 
# File 'lib/processing/graphics_context.rb', line 2706

def atan(value)
  Math.atan value
end

#atan2(y, x) ⇒ Numeric

Returns the angle from a specified point.

Parameters:

  • y (Numeric) —

    y of the point

  • x (Numeric) —

    x of the point

Returns:

  • (Numeric) —

    the angle in radians

See Also:



2720
2721
2722
 
# File 'lib/processing/graphics_context.rb', line 2720

def atan2(y, x)
  Math.atan2 y, x
end

#background(str) ⇒ nil #background(str, alpha) ⇒ nil #background(gray) ⇒ nil #background(gray, alpha) ⇒ nil #background(r, g, b) ⇒ nil #background(r, g, b, alpha) ⇒ nil

Clears screen.

Parameters:

  • str (String) —

    color code like ‘#00AAFF’

  • gray (Integer) —

    gray value (0..255)

  • r (Integer) —

    red value (0..255)

  • g (Integer) —

    green value (0..255)

  • b (Integer) —

    blue value (0..255)

  • alpha (Integer) —

    alpha value (0..255)

Returns:

  • (nil) —

    nil

See Also:



1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
 
# File 'lib/processing/graphics_context.rb', line 1286

def background(*args)
  assertDrawing__
  rgba = toRGBA__(*args)
  if rgba[3] == 1
    @painter__.background(*rgba)
  else
    @painter__.push fill: rgba, stroke: :none do |_|
      @painter__.rect 0, 0, width, height
    end
  end
  nil
end

#beginContour ⇒ nil

Begins drawing a hole inside shape.

Examples:

beginShape
vertex 10, 10
vertex 10, 50
vertex 50, 50
vertex 90, 10
beginContour
vertex 20, 20
vertex 30, 20
vertex 30, 30
vertex 20, 30
endContour
endShape CLOSE

Returns:

  • (nil) —

    nil

See Also:



1736
1737
1738
1739
 
# File 'lib/processing/graphics_context.rb', line 1736

def beginContour()
  (@drawingShape__ or raise "beginContour() must be called after beginShape()")
    .beginContour
end

#beginShape(type = nil) ⇒ nil

Begins drawing complex shapes.

Examples:

# Draws polygon
beginShape
vertex 10, 10
vertex 10, 50
vertex 50, 50
vertex 90, 10
endShape CLOSE

# Draws triangles
beginShape TRIANGLES
vertex 10, 10
vertex 10, 50
vertex 50, 50
endShape

Parameters:

Returns:

  • (nil) —

    nil

See Also:



1690
1691
1692
1693
1694
 
# File 'lib/processing/graphics_context.rb', line 1690

def beginShape(type = nil)
  raise "beginShape() cannot be called twice" if @drawingShape__
  @drawingShape__ = createShape
  @drawingShape__.beginShape type
end

#bezier(x1, y1, cx1, cy1, cx2, cy2, x2, y2) ⇒ nil Also known as: drawBezier

Draws a Bezier spline curve.

Parameters:

  • x1 (Numeric) —

    horizontal position of first point

  • y1 (Numeric) —

    vertical position of first point

  • cx1 (Numeric) —

    horizontal position of first control point

  • cy1 (Numeric) —

    vertical position of first control point

  • cx2 (Numeric) —

    horizontal position of second control point

  • cy2 (Numeric) —

    vertical position of second control point

  • x2 (Numeric) —

    horizontal position of second point

  • y2 (Numeric) —

    vertical position of second point

Returns:

  • (nil) —

    nil

See Also:



1551
1552
1553
1554
1555
1556
1557
 
# File 'lib/processing/graphics_context.rb', line 1551

def bezier(x1, y1, cx1, cy1, cx2, cy2, x2, y2)
  assertDrawing__
  @painter__.nsegment = @bezierDetail__
  @painter__.bezier x1, y1, cx1, cy1, cx2, cy2, x2, y2
  @painter__.nsegment = 0
  nil
end

#bezierDetail(detail) ⇒ nil

Sets the resolution at which Bezier’s curve is displayed. The default value is 20.

Parameters:

  • detail (Numeric) —

    resolution of the curves

Returns:

  • (nil) —

    nil

See Also:



975
976
977
978
979
 
# File 'lib/processing/graphics_context.rb', line 975

def bezierDetail(detail)
  detail = 1 if detail < 1
  @bezierDetail__ = detail
  nil
end

#bezierPoint(a, b, c, d, t) ⇒ Numeric

Evaluates the Bezier at point t for points a, b, c, d.

Parameters:

  • a (Numeric) —

    coordinate of first point on the curve

  • b (Numeric) —

    coordinate of first control point

  • c (Numeric) —

    coordinate of second control point

  • d (Numeric) —

    coordinate of second point on the curve

  • t (Numeric) —

    value between 0.0 and 1.0

Returns:

  • (Numeric) —

    interpolated value

See Also:



2785
2786
2787
2788
2789
2790
2791
 
# File 'lib/processing/graphics_context.rb', line 2785

def bezierPoint(a, b, c, d, t)
  tt = 1.0 - t
  tt ** 3.0 * a +
  tt ** 2.0 * b * 3.0 * t +
  t  ** 2.0 * c * 3.0 * tt +
  t  ** 3.0 * d
end

#bezierTangent(a, b, c, d, t) ⇒ Numeric

Calculates the tangent of a point on a Bezier curve.

Parameters:

  • a (Numeric) —

    coordinate of first point on the curve

  • b (Numeric) —

    coordinate of first control point

  • c (Numeric) —

    coordinate of second control point

  • d (Numeric) —

    coordinate of second point on the curve

  • t (Numeric) —

    value between 0.0 and 1.0

Returns:

  • (Numeric) —

    tangent value

See Also:



2806
2807
2808
2809
2810
2811
2812
2813
2814
 
# File 'lib/processing/graphics_context.rb', line 2806

def bezierTangent(a, b, c, d, t)
  tt = 1.0 - t
  3.0 * d * t  ** 2.0 -
  3.0 * c * t  ** 2.0 +
  6.0 * c * tt *  t   -
  6.0 * b * tt *  t   +
  3.0 * b * tt ** 2.0 -
  3.0 * a * tt ** 2.0
end

#bezierVertex(x2, y2, x3, y3, x4, y4) ⇒ nil

Append bezier vertex for shape polygon.

Parameters:

  • x (Numeric) —

    x position of vertex

  • y (Numeric) —

    y position of vertex

Returns:

  • (nil) —

    nil

See Also:



1798
1799
1800
1801
 
# File 'lib/processing/graphics_context.rb', line 1798

def bezierVertex(x2, y2, x3, y3, x4, y4)
  (@drawingShape__ or raise "bezierVertex() must be called after beginShape()")
    .bezierVertex x2, y2, x3, y3, x4, y4
end

#blend(sx, sy, sw, sh, dx, dy, dw, dh, mode) ⇒ nil #blend(img, sx, sy, sw, sh, dx, dy, dw, dh, mode) ⇒ nil

Blends image.

Parameters:

  • img (Image) (defaults to: nil) —

    image for blend source

  • sx (Numrtic) —

    x position of source region

  • sy (Numrtic) —

    y position of source region

  • sw (Numrtic) —

    width of source region

  • sh (Numrtic) —

    height of source region

  • dx (Numrtic) —

    x position of destination region

  • dy (Numrtic) —

    y position of destination region

  • dw (Numrtic) —

    width of destination region

  • dh (Numrtic) —

    height of destination region

  • mode (BLEND, ADD, SUBTRACT, LIGHTEST, DARKEST, EXCLUSION, MULTIPLY, SCREEN, REPLACE) —

    blend mode

Returns:

  • (nil) —

    nil

See Also:



1863
1864
1865
1866
1867
1868
 
# File 'lib/processing/graphics_context.rb', line 1863

def blend(img = nil, sx, sy, sw, sh, dx, dy, dw, dh, mode)
  assertDrawing__
  (img || self).drawImage__(
    @painter__, sx, sy, sw, sh, dx, dy, dw, dh,
    fill: getTint__, stroke: :none, blend_mode: mode)
end

#blendMode(mode = nil) ⇒ nil

Sets blend mode. Default is BLEND.

Parameters:

Returns:

  • (nil) —

    nil

See Also:



804
805
806
807
808
809
810
 
# File 'lib/processing/graphics_context.rb', line 804

def blendMode(mode = nil)
  if mode != nil
    @blendMode__          = mode
    @painter__.blend_mode = mode
  end
  @blendMode__
end

#blue(color) ⇒ Numeric

Returns the blue value of the color.

Parameters:

  • color (Numeric) —

    color value

Returns:

  • (Numeric) —

    the blue value

See Also:



573
574
575
 
# File 'lib/processing/graphics_context.rb', line 573

def blue(color)
  (color & 0xff) / 255.0 * @colorMaxes__[2]
end

#brightness(color) ⇒ Numeric

Returns the brightness value of the color.

Parameters:

  • color (Numeric) —

    color value

Returns:

  • (Numeric) —

    the brightness value

See Also:



627
628
629
630
 
# File 'lib/processing/graphics_context.rb', line 627

def brightness(color)
  _, _, b = toRawColor__(color).to_hsv
  b * (@hsbColor__ ? @colorMaxes__[2] : 1)
end

#ceil(value) ⇒ Numeric

Returns the closest integer number greater than or equal to the value.

Parameters:

  • value (Numeric) —

    number

Returns:

  • (Numeric) —

    rounded up number

See Also:



2335
2336
2337
 
# File 'lib/processing/graphics_context.rb', line 2335

def ceil(value)
  value.ceil
end

#circle(x, y, extent) ⇒ nil Also known as: drawCircle

Draws a circle.

Parameters:

  • x (Numeric) —

    horizontal position of the shape

  • y (Numeric) —

    vertical position of the shape

  • extent (Numeric) —

    width and height of the shape

Returns:

  • (nil) —

    nil

See Also:



1414
1415
1416
 
# File 'lib/processing/graphics_context.rb', line 1414

def circle(x, y, extent)
  ellipse x, y, extent, extent
end

#clear ⇒ Object 



1299
1300
1301
1302
1303
 
# File 'lib/processing/graphics_context.rb', line 1299

def clear()
  assertDrawing__
  @painter__.background 0, 0
  nil
end

#clip(a, b, c, d) ⇒ nil

Limits the drawable rectangle.

The parameters a, b, c, and d are determined by rectMode().

Parameters:

  • a (Numeric) —

    horizontal position of the drawable area, by default

  • b (Numeric) —

    vertical position of the drawable area, by default

  • c (Numeric) —

    width of the drawable area, by default

  • d (Numeric) —

    height of the drawable area, by default

Returns:

  • (nil) —

    nil

See Also:



1037
1038
1039
1040
1041
 
# File 'lib/processing/graphics_context.rb', line 1037

def clip(a, b, c, d)
  x, y, w, h = toXYWH__ @imageMode__, a, b, c, d
  @painter__.clip x, y, w, h
  nil
end

#color(gray) ⇒ Integer #color(gray, alpha) ⇒ Integer #color(v1, v2, v3) ⇒ Integer #color(v1, v2, v3, alpha) ⇒ Integer

Creates color value.

Parameters:

  • gray (Numeric) —

    the value for gray

  • alpha (Numeric) —

    the value for alpha

  • v1 (Numeric) —

    the value for red or hue

  • v2 (Numeric) —

    the value for green or saturation

  • v3 (Numeric) —

    the value for blue or brightness

Returns:

  • (Integer) —

    the rgba color value

See Also:



532
533
534
535
536
 
# File 'lib/processing/graphics_context.rb', line 532

def color(*args)
  toRGBA__(*args)
    .map {|n| (n * 255).to_i.clamp 0, 255}
    .then {|r, g, b, a| Image.toColor__ r, g, b, a}
end

#colorMode(mode) ⇒ RGB, HSB #colorMode(mode, max) ⇒ RGB, HSB #colorMode(mode, max1, max2, max3) ⇒ RGB, HSB #colorMode(mode, max1, max2, max3, maxA) ⇒ RGB, HSB

Sets color mode and max color values.

Parameters:

  • mode (RGB, HSB) (defaults to: nil) —

    RGB or HSB

  • max (Numeric) —

    max values for all color values

  • max1 (Numeric) —

    max value for red or hue

  • max2 (Numeric) —

    max value for green or saturation

  • max3 (Numeric) —

    max value for blue or brightness

  • maxA (Numeric) —

    max value for alpha

Returns:

See Also:



498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/processing/graphics_context.rb', line 498

def colorMode(mode = nil, *maxes)
  if mode != nil
    mode = mode.downcase.to_sym
    raise ArgumentError, "invalid color mode: #{mode}" unless [RGB, HSB].include?(mode)
    raise ArgumentError unless [0, 1, 3, 4].include?(maxes.size)

    @colorMode__ = mode
    @hsbColor__  = mode == HSB
    case maxes.size
    when 1    then @colorMaxes__                 = [maxes.first.to_f] * 4
    when 3, 4 then @colorMaxes__[0...maxes.size] = maxes.map &:to_f
    end
  end
  @colorMode__
end

#constrain(value, min, max) ⇒ Numeric

Constrains the number between min..max.

Parameters:

  • value (Numeric) —

    number to be constrained

  • min (Numeric) —

    lower bound of the range

  • max (Numeric) —

    upper bound of the range

Returns:

  • (Numeric) —

    constrained number

See Also:



2602
2603
2604
 
# File 'lib/processing/graphics_context.rb', line 2602

def constrain(value, min, max)
  value < min ? min : (value > max ? max : value)
end

#copy(sx, sy, sw, sh, dx, dy, dw, dh) ⇒ nil #copy(img, sx, sy, sw, sh, dx, dy, dw, dh) ⇒ nil

Copies image.

Parameters:

  • img (Image) (defaults to: nil) —

    image for copy source

  • sx (Numrtic) —

    x position of source region

  • sy (Numrtic) —

    y position of source region

  • sw (Numrtic) —

    width of source region

  • sh (Numrtic) —

    height of source region

  • dx (Numrtic) —

    x position of destination region

  • dy (Numrtic) —

    y position of destination region

  • dw (Numrtic) —

    width of destination region

  • dh (Numrtic) —

    height of destination region

Returns:

  • (nil) —

    nil

See Also:



1838
1839
1840
 
# File 'lib/processing/graphics_context.rb', line 1838

def copy(img = nil, sx, sy, sw, sh, dx, dy, dw, dh)
  blend img, sx, sy, sw, sh, dx, dy, dw, dh, BLEND
end

#cos(angle) ⇒ Numeric

Returns the cosine of an angle.

Parameters:

  • angle (Numeric) —

    angle in radians

Returns:

  • (Numeric) —

    the cosine

See Also:



2654
2655
2656
 
# File 'lib/processing/graphics_context.rb', line 2654

def cos(angle)
  Math.cos angle
end

#createCapture(*args) ⇒ Capture

Creates a camera object as a video input device.

Returns:



3116
3117
3118
 
# File 'lib/processing/graphics_context.rb', line 3116

def createCapture(*args)
  Capture.new(*args)
end

#createFont(name, size) ⇒ Font

Creates a new font object.

Parameters:

  • name (String) —

    font name

  • size (Numeric) —

    font size (max 256)

Returns:

  • (Font) —

    new font

See Also:



2967
2968
2969
2970
 
# File 'lib/processing/graphics_context.rb', line 2967

def createFont(name, size)
  size = FONT_SIZE_MAX__ if size && size > FONT_SIZE_MAX__
  Font.new Rays::Font.new(name, size || FONT_SIZE_DEFAULT__)
end

#createGraphics(width, height, pixelDensity = 1) ⇒ Graphics

Creates a new off-screen graphics context object.

Parameters:

  • width (Numeric) —

    width of graphics image

  • height (Numeric) —

    height of graphics image

  • pixelDensity (Numeric) (defaults to: 1) —

    pixel density of graphics image

Returns:

See Also:



3068
3069
3070
 
# File 'lib/processing/graphics_context.rb', line 3068

def createGraphics(width, height, pixelDensity = 1)
  Graphics.new width, height, pixelDensity
end

#createImage(w, h) ⇒ Image #createImage(w, h, format) ⇒ Image

Creates a new image object.

Parameters:

  • w (Numeric) —

    width of new image

  • h (Numeric) —

    height of new image

  • format (RGB, RGBA) (defaults to: RGBA) —

    image format

Returns:

Raises:

  • (ArgumentError)

See Also:



2986
2987
2988
2989
2990
 
# File 'lib/processing/graphics_context.rb', line 2986

def createImage(w, h, format = RGBA)
  colorspace = {RGB => Rays::RGB, RGBA => Rays::RGBA}[format]
  raise ArgumentError, "Unknown image format" unless colorspace
  Image.new Rays::Image.new(w, h, colorspace).paint {background 0, 0}
end

#createShader(vertPath, fragPath) ⇒ Shader #createShader(vertSource, fragSource) ⇒ Shader

Creates a shader object.

Passing nil for a vertex shader parameter causes the following default vertex shader to be used. “‘ attribute vec3 position; attribute vec3 texCoord; attribute vec4 color; varying vec4 vertPosition; varying vec4 vertTexCoord; varying vec4 vertColor; uniform mat4 transform; uniform mat4 texMatrix; void main () 

vec4 pos__   = vec4(position, 1.0);
vertPosition = pos__;
vertTexCoord = texMatrix * vec4(texCoord, 1.0);
vertColor    = color;
gl_Position  = transform * pos__;

“‘

Parameters:

  • vertPath (String) —

    vertex shader file path

  • fragPath (String) —

    fragment shader file path

  • vertSource (String) —

    vertex shader source

  • fragSource (String) —

    fragment shader source

Returns:

See Also:



3106
3107
3108
3109
3110
 
# File 'lib/processing/graphics_context.rb', line 3106

def createShader(vert, frag)
  vert = File.read if vert && File.exist?(vert)
  frag = File.read if frag && File.exist?(frag)
  Shader.new vert, frag
end

#createShape ⇒ Shape #createShape(LINE, x1, y1, x2, y2) ⇒ Shape #createShape(RECT, a, b, c, d) ⇒ Shape #createShape(ELLIPSE, a, b, c, d) ⇒ Shape #createShape(ARC, a, b, c, d, start, stop) ⇒ Shape #createShape(TRIANGLE, x1, y1, x2, y2, x3, y3) ⇒ Shape #createShape(QUAD, x1, y1, x2, y2, x3, y3, x4, y4) ⇒ Shape #createShape(GROUP) ⇒ Shape

Creates a new shape object.

Parameters:

Returns:

See Also:



3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
 
# File 'lib/processing/graphics_context.rb', line 3009

def createShape(kind = nil, *args)
  case kind
  when LINE     then createLineShape__(    *args)
  when RECT     then createRectShape__(    *args)
  when ELLIPSE  then createEllipseShape__( *args)
  when ARC      then createArcShape__(     *args)
  when TRIANGLE then createTriangleShape__(*args)
  when QUAD     then createQuadShape__(    *args)
  when GROUP    then Shape.new nil, [], context: self
  when nil      then Shape.new context: self
  else raise ArgumentError, "Unknown shape kind '#{kind}'"
  end
end

#createVector ⇒ Vector #createVector(x, y) ⇒ Vector #createVector(x, y, z) ⇒ Vector

Creates a new vector object.

Parameters:

  • x (Numeric) —

    x of new vector

  • y (Numeric) —

    y of new vector

  • z (Numeric) —

    z of new vector

Returns:

See Also:



2954
2955
2956
 
# File 'lib/processing/graphics_context.rb', line 2954

def createVector(*args)
  Vector.new(*args, context: self)
end

#curve(cx1, cy1, x1, y1, x2, y2, cx2, cy2) ⇒ nil Also known as: drawCurve

Draws a Catmull-Rom spline curve.

Parameters:

  • cx1 (Numeric) —

    horizontal position of beginning control point

  • cy1 (Numeric) —

    vertical position of beginning control point

  • x1 (Numeric) —

    horizontal position of first point

  • y1 (Numeric) —

    vertical position of first point

  • x2 (Numeric) —

    horizontal position of second point

  • y2 (Numeric) —

    vertical position of second point

  • cx2 (Numeric) —

    horizontal position of ending control point

  • cy2 (Numeric) —

    vertical position of ending control point

Returns:

  • (nil) —

    nil

See Also:



1525
1526
1527
1528
1529
1530
1531
 
# File 'lib/processing/graphics_context.rb', line 1525

def curve(cx1, cy1, x1, y1, x2, y2, cx2, cy2)
  assertDrawing__
  @painter__.nsegment = @curveDetail__
  @painter__.curve cx1, cy1, x1, y1, x2, y2, cx2, cy2
  @painter__.nsegment = 0
  nil
end

#curveDetail(detail) ⇒ nil

Sets the resolution at which curves display. The default value is 20 while the minimum value is 3.

Parameters:

  • detail (Numeric) —

    resolution of the curves

Returns:

  • (nil) —

    nil

See Also:



945
946
947
948
949
 
# File 'lib/processing/graphics_context.rb', line 945

def curveDetail(detail)
  detail = 3 if detail < 3
  @curveDetail__ = detail
  nil
end

#curvePoint(a, b, c, d, t) ⇒ Numeric

Evaluates the curve at point t for points a, b, c, d.

Parameters:

  • a (Numeric) —

    coordinate of first control point

  • b (Numeric) —

    coordinate of first point on the curve

  • c (Numeric) —

    coordinate of second point on the curve

  • d (Numeric) —

    coordinate of second control point

  • t (Numeric) —

    value between 0.0 and 1.0

Returns:

  • (Numeric) —

    interpolated value

See Also:



2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
 
# File 'lib/processing/graphics_context.rb', line 2737

def curvePoint(a, b, c, d, t)
  s  = @curveTightness__
  t3 = t * t * t
  t2 = t * t
  f1 = ( s - 1.0) / 2.0 * t3 + ( 1.0 - s)       * t2 + (s - 1.0) / 2.0 * t
  f2 = ( s + 3.0) / 2.0 * t3 + (-5.0 - s) / 2.0 * t2 +  1.0
  f3 = (-3.0 - s) / 2.0 * t3 + ( s + 2.0)       * t2 + (1.0 - s) / 2.0 * t
  f4 = ( 1.0 - s) / 2.0 * t3 + ( s - 1.0) / 2.0 * t2
  a * f1 + b * f2 + c * f3 + d * f4
end

#curveTangent(a, b, c, d, t) ⇒ Numeric

Calculates the tangent of a point on a curve.

Parameters:

  • a (Numeric) —

    coordinate of first control point

  • b (Numeric) —

    coordinate of first point on the curve

  • c (Numeric) —

    coordinate of second point on the curve

  • d (Numeric) —

    coordinate of second control point

  • t (Numeric) —

    value between 0.0 and 1.0

Returns:

  • (Numeric) —

    tangent value

See Also:



2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
 
# File 'lib/processing/graphics_context.rb', line 2761

def curveTangent(a, b, c, d, t)
  s = @curveTightness__
  tt3 = t * t * 3.0
  t2  = t * 2.0
  f1  = ( s - 1.0) / 2.0 * tt3 + ( 1.0 - s)       * t2 + (s - 1.0) / 2.0
  f2  = ( s + 3.0) / 2.0 * tt3 + (-5.0 - s) / 2.0 * t2
  f3  = (-3.0 - s) / 2.0 * tt3 + ( s + 2.0)       * t2 + (1.0 - s) / 2.0
  f4  = ( 1.0 - s) / 2.0 * tt3 + ( s - 1.0) / 2.0 * t2
  a * f1 + b * f2 + c * f3 + d * f4
end

#curveTightness(tightness) ⇒ nil

Sets the quality of curve forms.

Parameters:

  • tightness (Numeric) —

    determines how the curve fits to the vertex points

Returns:

  • (nil) —

    nil

See Also:



960
961
962
963
 
# File 'lib/processing/graphics_context.rb', line 960

def curveTightness(tightness)
  @curveTightness__ = tightness
  nil
end

#curveVertex(x, y) ⇒ nil

Append curve vertex for shape polygon.

Parameters:

  • x (Numeric) —

    x position of vertex

  • y (Numeric) —

    y position of vertex

Returns:

  • (nil) —

    nil

See Also:



1783
1784
1785
1786
 
# File 'lib/processing/graphics_context.rb', line 1783

def curveVertex(x, y)
  (@drawingShape__ or raise "curveVertex() must be called after beginShape()")
    .curveVertex x, y
end

#degrees(radian) ⇒ Numeric

Converts radian to degree.

Parameters:

  • radian (Numeric) —

    radian to convert

Returns:

  • (Numeric) —

    degree

See Also:



2628
2629
2630
 
# File 'lib/processing/graphics_context.rb', line 2628

def degrees(radian)
  radian * RAD2DEG__
end

#dist(x1, y1, x2, y2) ⇒ Numeric #dist(x1, y1, z1, x2, y2, z2) ⇒ Numeric

Returns distance between 2 points.

Parameters:

  • x1 (Numeric) —

    x of first point

  • y1 (Numeric) —

    y of first point

  • z1 (Numeric) —

    z of first point

  • x2 (Numeric) —

    x of second point

  • y2 (Numeric) —

    y of second point

  • z2 (Numeric) —

    z of second point

Returns:

  • (Numeric) —

    distance between 2 points

See Also:



2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
 
# File 'lib/processing/graphics_context.rb', line 2471

def dist(*args)
  case args.size
  when 4
    x1, y1, x2, y2 = *args
    xx, yy = x2 - x1, y2 - y1
    Math.sqrt xx * xx + yy * yy
  when 3
    x1, y1, z1, x2, y2, z2 = *args
    xx, yy, zz = x2 - x1, y2 - y1, z2 - z1
    Math.sqrt xx * xx + yy * yy + zz * zz
  else raise ArgumentError
  end
end

#ellipse(a, b, c, d) ⇒ nil Also known as: drawEllipse

Draws an ellipse.

The parameters a, b, c, and d are determined by ellipseMode().

Parameters:

  • a (Numeric) —

    horizontal position of the shape, by default

  • b (Numeric) —

    vertical position of the shape, by default

  • c (Numeric) —

    width of the shape, by default

  • d (Numeric) —

    height of the shape, by default

Returns:

  • (nil) —

    nil

See Also:



1394
1395
1396
1397
1398
1399
 
# File 'lib/processing/graphics_context.rb', line 1394

def ellipse(a, b, c, d)
  assertDrawing__
  x, y, w, h = toXYWH__ @ellipseMode__, a, b, c, d
  @painter__.ellipse x, y, w, h
  nil
end

#ellipseMode(mode) ⇒ nil

Sets ellipse mode. Default is CENTER.

CORNER -> ellipse(left, top, width, height) CORNERS -> ellipse(left, top, right, bottom) CENTER -> ellipse(centerX, centerY, width, height) RADIUS -> ellipse(centerX, centerY, radiusH, radiusV)

Parameters:

Returns:

  • (nil) —

    nil

See Also:



747
748
749
 
# File 'lib/processing/graphics_context.rb', line 747

def ellipseMode(mode)
  @ellipseMode__ = mode
end

#endContour ⇒ nil

Ends drawing a hole.

Returns:

  • (nil) —

    nil

See Also:



1748
1749
1750
1751
 
# File 'lib/processing/graphics_context.rb', line 1748

def endContour()
  (@drawingShape__ or raise "endContour() must be called after beginShape()")
    .endContour
end

#endShape ⇒ nil #endShape(CLOSE) ⇒ nil

Ends drawing complex shapes.

Parameters:

  • mode (CLOSE) (defaults to: nil) —

    Use CLOSE to create looped polygon

Returns:

  • (nil) —

    nil

See Also:



1707
1708
1709
1710
1711
1712
1713
 
# File 'lib/processing/graphics_context.rb', line 1707

def endShape(mode = nil)
  s = @drawingShape__ or raise "endShape() must be called after beginShape()"
  s.endShape mode
  shape s
  @drawingShape__ = nil
  nil
end

#exp(n) ⇒ Numeric

Returns Euler’s number e raised to the power of value.

Parameters:

  • value (Numeric) —

    number

Returns:

  • (Numeric) —

    result number

See Also:



2387
2388
2389
 
# File 'lib/processing/graphics_context.rb', line 2387

def exp(n)
  Math.exp n
end

#fill(rgb) ⇒ nil #fill(rgb, alpha) ⇒ nil #fill(gray) ⇒ nil #fill(gray, alpha) ⇒ nil #fill(r, g, b) ⇒ nil #fill(r, g, b, alpha) ⇒ nil

Sets fill color.

Parameters:

  • rgb (String) —

    color code like ‘#00AAFF’

  • gray (Integer) —

    gray value (0..255)

  • r (Integer) —

    red value (0..255)

  • g (Integer) —

    green value (0..255)

  • b (Integer) —

    blue value (0..255)

  • alpha (Integer) —

    alpha value (0..255)

Returns:

  • (nil) —

    nil

See Also:



833
834
835
836
 
# File 'lib/processing/graphics_context.rb', line 833

def fill(*args)
  @painter__.fill(*toRGBA__(*args))
  nil
end

#filter(*args) ⇒ nil

Applies an image filter to screen.

overload filter(shader) overload filter(type) overload filter(type, param)

Parameters:

Returns:

  • (nil) —

    nil

See Also:



1260
1261
1262
1263
 
# File 'lib/processing/graphics_context.rb', line 1260

def filter(*args)
  @filter__ = Shader.createFilter__(*args)
  nil
end

#floor(value) ⇒ Numeric

Returns the closest integer number less than or equal to the value.

Parameters:

  • value (Numeric) —

    number

Returns:

  • (Numeric) —

    rounded down number

See Also:



2348
2349
2350
 
# File 'lib/processing/graphics_context.rb', line 2348

def floor(value)
  value.floor
end

#green(color) ⇒ Numeric

Returns the green value of the color.

Parameters:

  • color (Numeric) —

    color value

Returns:

  • (Numeric) —

    the green value

See Also:



560
561
562
 
# File 'lib/processing/graphics_context.rb', line 560

def green(color)
  ((color >> 8) & 0xff) / 255.0 * @colorMaxes__[1]
end

#height ⇒ Numeric

Returns the height of the graphics object.

Returns:

  • (Numeric) —

    height

See Also:



430
431
432
 
# File 'lib/processing/graphics_context.rb', line 430

def height()
  getInternal__.height
end

#hue(color) ⇒ Numeric

Returns the hue value of the color.

Parameters:

  • color (Numeric) —

    color value

Returns:

  • (Numeric) —

    the hue value

See Also:



599
600
601
602
 
# File 'lib/processing/graphics_context.rb', line 599

def hue(color)
  h, = toRawColor__(color).to_hsv
  h * (@hsbColor__ ? @colorMaxes__[0] : 1)
end

#image(img, a, b) ⇒ nil #image(img, a, b, c, d) ⇒ nil Also known as: drawImage

Draws an image.

The parameters a, b, c, and d are determined by imageMode().

Parameters:

  • img (Image) —

    image to draw

  • a (Numeric) —

    horizontal position of the image, by default

  • b (Numeric) —

    vertical position of the image, by default

  • c (Numeric) (defaults to: nil) —

    width of the image, by default

  • d (Numeric) (defaults to: nil) —

    height of the image, by default

Returns:

  • (nil) —

    nil

See Also:



1623
1624
1625
1626
1627
1628
 
# File 'lib/processing/graphics_context.rb', line 1623

def image(img, a, b, c = nil, d = nil)
  assertDrawing__
  x, y, w, h = toXYWH__ @imageMode__, a, b, c || img.width, d || img.height
  img.drawImage__ @painter__, x, y, w, h, fill: getTint__, stroke: :none
  nil
end

#imageMode(mode) ⇒ nil

Sets image mode. Default is CORNER.

CORNER -> image(img, left, top, width, height) CORNERS -> image(img, left, top, right, bottom) CENTER -> image(img, centerX, centerY, width, height)

Parameters:

Returns:

  • (nil) —

    nil

See Also:



764
765
766
 
# File 'lib/processing/graphics_context.rb', line 764

def imageMode(mode)
  @imageMode__ = mode
end

#lerp(start, stop, amount) ⇒ Numeric

Returns the interpolated number between range start..stop.

Parameters:

  • start (Numeric) —

    lower bound of the range

  • stop (Numeric) —

    upper bound of the range

  • amount (Numeric) —

    amount to interpolate

Returns:

  • (Numeric) —

    interporated number

See Also:



2511
2512
2513
 
# File 'lib/processing/graphics_context.rb', line 2511

def lerp(start, stop, amount)
  start + (stop - start) * amount
end

#lerpColor(color1, color2, amount) ⇒ Integer

Returns the interpolated color between color1 and color2.

Parameters:

  • color1 (Integer) —

    the 1st color for interpolation

  • color2 (Integer) —

    the 2nd color for interpolation

  • amount (Numeric) —

    amount to interpolate

Returns:

  • (Integer) —

    interporated color

See Also:



2526
2527
2528
2529
2530
2531
2532
 
# File 'lib/processing/graphics_context.rb', line 2526

def lerpColor(color1, color2, amount)
  color(
    lerp(red(  color1), red(  color2), amount),
    lerp(green(color1), green(color2), amount),
    lerp(blue( color1), blue( color2), amount),
    lerp(alpha(color1), alpha(color2), amount))
end

#line(x1, y1, x2, y2) ⇒ nil Also known as: drawLine

Draws a line.

Parameters:

  • x1 (Numeric) —

    horizontal position of first point

  • y1 (Numeric) —

    vertical position of first point

  • x2 (Numeric) —

    horizontal position of second point

  • y2 (Numeric) —

    vertical position of second point

Returns:

  • (nil) —

    nil

See Also:



1335
1336
1337
1338
1339
 
# File 'lib/processing/graphics_context.rb', line 1335

def line(x1, y1, x2, y2)
  assertDrawing__
  @painter__.line x1, y1, x2, y2
  nil
end

#loadFont(filename) ⇒ Font

Loads font from file.

Parameters:

  • filename (String) —

    file name to load font file

Returns:

  • (Font) —

    loaded font object

See Also:



3129
3130
3131
3132
3133
3134
3135
 
# File 'lib/processing/graphics_context.rb', line 3129

def loadFont(filename)
  ext = File.extname filename
  raise "unsupported font type -- '#{ext}'" unless ext =~ /^\.?(ttf|otf)$/i

  filename = httpGet__ filename, ext if filename =~ %r|^https?://|
  Font.new Rays::Font.load filename
end

#loadImage(filename, extension = nil) ⇒ Image

Loads image.

Parameters:

  • filename (String) —

    file name to load image

  • extension (String) (defaults to: nil) —

    type of image to load (ex. ‘png’)

Returns:

  • (Image) —

    loaded image object

See Also:



3147
3148
3149
3150
3151
3152
3153
 
# File 'lib/processing/graphics_context.rb', line 3147

def loadImage(filename, extension = nil)
  ext = extension || File.extname(filename)
  raise "unsupported image type -- '#{ext}'" unless ext =~ /^\.?(png|jpg|gif)$/i

  filename = httpGet__ filename, ext if filename =~ %r|^https?://|
  Image.new Rays::Image.load filename
end

#loadPixels ⇒ nil

Loads all pixels to the ‘pixels’ array.

Returns:

  • (nil) —

    nil

See Also:



1877
1878
1879
 
# File 'lib/processing/graphics_context.rb', line 1877

def loadPixels()
  @pixels__ = getInternal__.pixels
end

#loadShader(fragPath) ⇒ Shader #loadShader(fragPath, vertPath) ⇒ Shader

Loads shader file.

Parameters:

  • fragPath (String) —

    fragment shader file path

  • vertPath (String) (defaults to: nil) —

    vertex shader file path

Returns:

  • (Shader) —

    loaded shader object

See Also:



3190
3191
3192
 
# File 'lib/processing/graphics_context.rb', line 3190

def loadShader(fragPath, vertPath = nil)
  createShader vertPath, fragPath
end

#log(n) ⇒ Numeric

Returns the natural logarithm (the base-e logarithm) of a number.

Parameters:

  • value (Numeric) —

    number (> 0.0)

Returns:

  • (Numeric) —

    result number

See Also:



2374
2375
2376
 
# File 'lib/processing/graphics_context.rb', line 2374

def log(n)
  Math.log n
end

#mag(x, y) ⇒ Numeric #mag(x, y, z) ⇒ Numeric

Returns the magnitude (or length) of a vector.

Parameters:

  • x (Numeric) —

    x of point

  • y (Numeric) —

    y of point

  • z (Numeric) —

    z of point

Returns:

  • (Numeric) —

    magnitude

See Also:



2445
2446
2447
2448
2449
2450
2451
2452
 
# File 'lib/processing/graphics_context.rb', line 2445

def mag(*args)
  x, y, z = *args
  case args.size
  when 2 then Math.sqrt x * x + y * y
  when 3 then Math.sqrt x * x + y * y + z * z
  else raise ArgumentError
  end
end

#map(value, start1, stop1, start2, stop2) ⇒ Numeric

Maps a number from range start1..stop1 to range start2..stop2.

Parameters:

  • value (Numeric) —

    number to be mapped

  • start1 (Numeric) —

    lower bound of the range1

  • stop1 (Numeric) —

    upper bound of the range1

  • start2 (Numeric) —

    lower bound of the range2

  • stop2 (Numeric) —

    upper bound of the range2

Returns:

  • (Numeric) —

    mapped number

See Also:



2547
2548
2549
 
# File 'lib/processing/graphics_context.rb', line 2547

def map(value, start1, stop1, start2, stop2)
  lerp start2, stop2, norm(value, start1, stop1)
end

#max(a, b) ⇒ Numeric #max(a, b, c) ⇒ Numeric #max(array) ⇒ Numeric

Returns maximum value.

Parameters:

  • a (Numeric) —

    value to compare

  • b (Numeric) —

    value to compare

  • c (Numeric) —

    value to compare

  • array (Numeric) —

    values to compare

Returns:

  • (Numeric) —

    maximum value

See Also:



2587
2588
2589
 
# File 'lib/processing/graphics_context.rb', line 2587

def max(*args)
  args.flatten.max
end

#min(a, b) ⇒ Numeric #min(a, b, c) ⇒ Numeric #min(array) ⇒ Numeric

Returns minimum value.

Parameters:

  • a (Numeric) —

    value to compare

  • b (Numeric) —

    value to compare

  • c (Numeric) —

    value to compare

  • array (Numeric) —

    values to compare

Returns:

  • (Numeric) —

    minimum value

See Also:



2567
2568
2569
 
# File 'lib/processing/graphics_context.rb', line 2567

def min(*args)
  args.flatten.min
end

#noClip ⇒ nil

Disables clipping.

Returns:

  • (nil) —

    nil

See Also:



1049
1050
1051
1052
 
# File 'lib/processing/graphics_context.rb', line 1049

def noClip()
  @painter__.no_clip
  nil
end

#noFill ⇒ nil

Disables filling.

Returns:

  • (nil) —

    nil

See Also:



850
851
852
853
 
# File 'lib/processing/graphics_context.rb', line 850

def noFill()
  @painter__.fill nil
  nil
end

#noise(x) ⇒ Numeric #noise(x, y) ⇒ Numeric #noise(x, y, z) ⇒ Numeric

Returns the perlin noise value.

Parameters:

  • x (Numeric) —

    horizontal point in noise space

  • y (Numeric) (defaults to: 0) —

    vertical point in noise space

  • z (Numeric) (defaults to: 0) —

    depth point in noise space

Returns:

  • (Numeric) —

    noise value (0.0..1.0)

See Also:



2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
 
# File 'lib/processing/graphics_context.rb', line 2831

def noise(x, y = 0, z = 0)
  seed, falloff = @noiseSeed__, @noiseFallOff__
  amp           = 0.5
  @noiseOctaves__.times.reduce(0) do |sum|
    value = (Rays.perlin(x, y, z, seed) / 2.0 + 0.5) * amp
    x    *= 2
    y    *= 2
    z    *= 2
    amp  *= falloff
    sum + value
  end
end

#noiseDetail(lod, falloff = nil) ⇒ nil

Adjusts the character and level of detail produced by the Perlin noise function.

Parameters:

  • lod (Numeric) —

    number of octaves to be used by the noise

  • falloff (Numeric) (defaults to: nil) —

    falloff factor for each octave

Returns:

  • (nil) —

    nil

See Also:



2867
2868
2869
2870
 
# File 'lib/processing/graphics_context.rb', line 2867

def noiseDetail(lod, falloff = nil)
  @noiseOctaves__ = lod     if lod     && lod > 0
  @noiseFallOff__ = falloff if falloff && falloff > 0
end

#noiseSeed(seed) ⇒ nil

Sets the seed value for noise()

Parameters:

  • seed (Numeric) —

    seed value

Returns:

  • (nil) —

    nil

See Also:



2853
2854
2855
 
# File 'lib/processing/graphics_context.rb', line 2853

def noiseSeed(seed)
  @noiseSeed__ = Random.new(seed).rand 0.0..1.0
end

#norm(value, start, stop) ⇒ Numeric

Normalize the value from range start..stop into 0..1.

Parameters:

  • value (Numeric) —

    number to be normalized

  • start (Numeric) —

    lower bound of the range

  • stop (Numeric) —

    upper bound of the range

Returns:

  • (Numeric) —

    normalized value between 0..1

See Also:



2496
2497
2498
 
# File 'lib/processing/graphics_context.rb', line 2496

def norm(value, start, stop)
  (value.to_f - start.to_f) / (stop.to_f - start.to_f)
end

#noStroke ⇒ nil

Disables drawing stroke.

Returns:

  • (nil) —

    nil

See Also:



888
889
890
891
 
# File 'lib/processing/graphics_context.rb', line 888

def noStroke()
  @painter__.stroke nil
  nil
end

#noTint ⇒ nil

Resets tint color.

Returns:

  • (nil) —

    nil

See Also:



1014
1015
1016
 
# File 'lib/processing/graphics_context.rb', line 1014

def noTint()
  @tint__ = nil
end

#pixelDensity ⇒ Numeric

Returns the pixel density of the graphics object.

Returns:

  • (Numeric) —

    pixel density

See Also:



461
462
463
 
# File 'lib/processing/graphics_context.rb', line 461

def pixelDensity()
  @painter__.pixel_density
end

#pixelHeight ⇒ Numeric

Returns the height of the graphics object in pixels.

Returns:

  • (Numeric) —

    height

See Also:



450
451
452
 
# File 'lib/processing/graphics_context.rb', line 450

def pixelHeight()
  height * pixelDensity
end

#pixels ⇒ Array

An array of all pixels. Call loadPixels() before accessing the array.

Returns:

  • (Array) —

    color array

See Also:



1909
1910
1911
 
# File 'lib/processing/graphics_context.rb', line 1909

def pixels()
  @pixels__
end

#pixelWidth ⇒ Numeric

Returns the width of the graphics object in pixels.

Returns:

  • (Numeric) —

    width

See Also:



440
441
442
 
# File 'lib/processing/graphics_context.rb', line 440

def pixelWidth()
  width * pixelDensity
end

#point(x, y) ⇒ nil Also known as: drawPoint

Draws a point.

Parameters:

  • x (Numeric) —

    horizontal position

  • y (Numeric) —

    vertical position

Returns:

  • (nil) —

    nil

See Also:



1315
1316
1317
1318
1319
 
# File 'lib/processing/graphics_context.rb', line 1315

def point(x, y)
  assertDrawing__
  @painter__.point x, y
  nil
end

#pop ⇒ nil

Restore styles and transformations from stack.

Returns:

  • (nil) —

    nil

See Also:



2286
2287
2288
2289
 
# File 'lib/processing/graphics_context.rb', line 2286

def pop()
  popMatrix
  popStyle
end

#popMatrix ⇒ nil

Pops the current transformation matrix from stack.

Returns:

  • (nil) —

    nil

See Also:



2087
2088
2089
2090
2091
2092
 
# File 'lib/processing/graphics_context.rb', line 2087

def popMatrix()
  assertDrawing__
  raise "matrix stack underflow" if @matrixStack__.empty?
  @painter__.matrix = @matrixStack__.pop
  nil
end

#popStyle ⇒ nil

Restore style values from the style stack.

Returns:

  • (nil) —

    nil

See Also:



2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
 
# File 'lib/processing/graphics_context.rb', line 2223

def popStyle()
  assertDrawing__
  raise "style stack underflow" if @styleStack__.empty?
  @painter__.fill,
  @painter__.stroke,
  @painter__.stroke_width,
  @painter__.stroke_cap,
  @painter__.stroke_join,
  @painter__.miter_limit,
  @painter__.line_height,
  @painter__.clip,
  @painter__.blend_mode,
  @painter__.font,
  @painter__.texture,
  @painter__.texcoord_mode,
  @painter__.texcoord_wrap,
  @painter__.shader,
  @colorMode__,
  @hsbColor__,
  @colorMaxes__,
  @angleMode__,
  @toRad__,
  @toDeg__,
  @fromRad__,
  @fromDeg__,
  @rectMode__,
  @ellipseMode__,
  @imageMode__,
  @shapeMode__,
  @blendMode__,
  @curveDetail__,
  @curveTightness__,
  @bezierDetail__,
  @textAlignH__,
  @textAlignV__,
  @textFont__,
  @tint__ = @styleStack__.pop
  @textFont__.setSize__ @painter__.font.size
  nil
end

#pow(value, exponent) ⇒ Numeric

Returns value raised to the power of exponent.

Parameters:

  • value (Numeric) —

    base number

  • exponent (Numeric) —

    exponent number

Returns:

  • (Numeric) —

    value ** exponent

See Also:



2401
2402
2403
 
# File 'lib/processing/graphics_context.rb', line 2401

def pow(value, exponent)
  value ** exponent
end

#printMatrix ⇒ nil

Prints matrix elements to console.

Returns:

  • (nil) —

    nil

See Also:



2161
2162
2163
2164
2165
2166
 
# File 'lib/processing/graphics_context.rb', line 2161

def printMatrix()
  m = @painter__.matrix
  m.transpose! if @p5jsMode__
  print "%f %f %f %f\n%f %f %f %f\n%f %f %f %f\n%f %f %f %f\n" % m.to_a
  nil
end

#push(&block) ⇒ Object

Save current styles and transformations to stack.

Returns:

  • (Object) —

    result of the expression at the end of the block

See Also:



2271
2272
2273
2274
2275
2276
2277
 
# File 'lib/processing/graphics_context.rb', line 2271

def push(&block)
  pushMatrix
  pushStyle
  block.call if block
ensure
  pop if block
end

#pushMatrix(&block) ⇒ Object

Pushes the current transformation matrix to stack.

Returns:

  • (Object) —

    result of the expression at the end of the block

See Also:



2073
2074
2075
2076
2077
2078
2079
 
# File 'lib/processing/graphics_context.rb', line 2073

def pushMatrix(&block)
  assertDrawing__
  @matrixStack__.push @painter__.matrix
  block.call if block
ensure
  popMatrix if block
end

#pushStyle(&block) ⇒ Object

Save current style values to the style stack.

Returns:

  • (Object) —

    result of the expression at the end of the block

See Also:



2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
 
# File 'lib/processing/graphics_context.rb', line 2174

def pushStyle(&block)
  assertDrawing__
  @styleStack__.push [
    @painter__.fill,
    @painter__.stroke,
    @painter__.stroke_width,
    @painter__.stroke_cap,
    @painter__.stroke_join,
    @painter__.miter_limit,
    @painter__.line_height!,
    @painter__.clip,
    @painter__.blend_mode,
    @painter__.font,
    @painter__.texture,
    @painter__.texcoord_mode,
    @painter__.texcoord_wrap,
    @painter__.shader,
    @colorMode__,
    @hsbColor__,
    @colorMaxes__,
    @angleMode__,
    @toRad__,
    @toDeg__,
    @fromRad__,
    @fromDeg__,
    @rectMode__,
    @ellipseMode__,
    @imageMode__,
    @shapeMode__,
    @blendMode__,
    @curveDetail__,
    @curveTightness__,
    @bezierDetail__,
    @textAlignH__,
    @textAlignV__,
    @textFont__,
    @tint__,
  ]
  block.call if block
ensure
  popStyle if block
end

#quad(x1, y1, x2, y2, x3, y3, x4, y4) ⇒ nil Also known as: drawQuad

Draws a quad.

Parameters:

  • x1 (Numeric) —

    horizontal position of first point

  • y1 (Numeric) —

    vertical position of first point

  • x2 (Numeric) —

    horizontal position of second point

  • y2 (Numeric) —

    vertical position of second point

  • x3 (Numeric) —

    horizontal position of third point

  • y3 (Numeric) —

    vertical position of third point

  • x4 (Numeric) —

    horizontal position of fourth point

  • y4 (Numeric) —

    vertical position of fourth point

Returns:

  • (nil) —

    nil

See Also:



1501
1502
1503
1504
1505
 
# File 'lib/processing/graphics_context.rb', line 1501

def quad(x1, y1, x2, y2, x3, y3, x4, y4)
  assertDrawing__
  @painter__.line x1, y1, x2, y2, x3, y3, x4, y4, loop: true
  nil
end

#quadraticVertex(cx, cy, x3, y3) ⇒ nil

Append quadratic vertex for shape polygon.

Parameters:

  • x (Numeric) —

    x position of vertex

  • y (Numeric) —

    y position of vertex

Returns:

  • (nil) —

    nil

See Also:



1813
1814
1815
1816
 
# File 'lib/processing/graphics_context.rb', line 1813

def quadraticVertex(cx, cy, x3, y3)
  (@drawingShape__ or raise "quadraticVertex() must be called after beginShape()")
    .quadraticVertex cx, cy, x3, y3
end

#radians(degree) ⇒ Numeric

Converts degree to radian.

Parameters:

  • degree (Numeric) —

    degree to convert

Returns:

  • (Numeric) —

    radian

See Also:



2615
2616
2617
 
# File 'lib/processing/graphics_context.rb', line 2615

def radians(degree)
  degree * DEG2RAD__
end

#random(high) ⇒ Float #random(low, high) ⇒ Float #random(choices) ⇒ Float

Returns a random number in range low…high

Parameters:

  • low (Numeric) —

    lower limit

  • high (Numeric) —

    upper limit

  • choices (Array) —

    array to choose from

Returns:

  • (Float) —

    random number

See Also:



2887
2888
2889
2890
2891
2892
2893
2894
2895
 
# File 'lib/processing/graphics_context.rb', line 2887

def random(*args)
  if args.first.kind_of? Array
    a = args.first
    a.empty? ? nil : a[@random__.rand a.size]
  else
    high, low = args.reverse
    @random__.rand (low || 0).to_f...(high || 1).to_f
  end
end

#randomGaussian(mean = 0, sd = 1) ⇒ Float

Returns a random number fitting a Gaussian, or normal, distribution.

Parameters:

  • mean (Numeric) (defaults to: 0) —

    mean

  • sd (Numeric) (defaults to: 1) —

    standard deviation

Returns:

  • (Float) —

    random number

See Also:



2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
 
# File 'lib/processing/graphics_context.rb', line 2921

def randomGaussian(mean = 0, sd = 1)
  value =
    if @nextGaussian__
      x, @nextGaussian__ = @nextGaussian__, nil
      x
    else
      a, b, w = 0, 0, 1
      until w < 1
        a = random(2) - 1
        b = random(2) - 1
        w = a ** 2 + b ** 2
      end
      w = Math.sqrt(-2 * Math.log(w) / w)
      @randomGaussian__ = a * w
      b * w
    end
  value * sd + mean
end

#randomSeed(seed) ⇒ nil

Sets the seed value for random()

Parameters:

  • seed (Numeric) —

    seed value

Returns:

  • (nil) —

    nil

See Also:



2906
2907
2908
2909
 
# File 'lib/processing/graphics_context.rb', line 2906

def randomSeed(seed)
  @random__       = Random.new seed
  @nextGaussian__ = nil
end

#rect(a, b, c, d) ⇒ nil #rect(a, b, c, d, r) ⇒ nil #rect(a, b, c, d, tl, tr, br, bl) ⇒ nil Also known as: drawRect

Draws a rectangle.

The parameters a, b, c, and d are determined by rectMode().

Parameters:

  • a (Numeric) —

    horizontal position of the shape, by default

  • b (Numeric) —

    vertical position of the shape, by default

  • c (Numeric) —

    width of the shape, by default

  • d (Numeric) —

    height of the shape, by default

  • r (Numeric) —

    radius for all corners

  • tl (Numeric) —

    radius for top-left corner

  • tr (Numeric) —

    radius for top-right corner

  • br (Numeric) —

    radius for bottom-right corner

  • bl (Numeric) —

    radius for bottom-left corner

Returns:

  • (nil) —

    nil

See Also:



1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
 
# File 'lib/processing/graphics_context.rb', line 1366

def rect(a, b, c, d, *args)
  assertDrawing__
  x, y, w, h = toXYWH__ @rectMode__, a, b, c, d
  case args.size
  when 0 then @painter__.rect x, y, w, h
  when 1 then @painter__.rect x, y, w, h, round: args[0]
  when 4 then @painter__.rect x, y, w, h, lt: args[0], rt: args[1], rb: args[2], lb: args[3]
  else raise ArgumentError # ToDo: refine error message
  end
  nil
end

#rectMode(mode) ⇒ nil

Sets rect mode. Default is CORNER.

CORNER -> rect(left, top, width, height) CORNERS -> rect(left, top, right, bottom) CENTER -> rect(centerX, centerY, width, height) RADIUS -> rect(centerX, centerY, radiusH, radiusV)

Parameters:

Returns:

  • (nil) —

    nil

See Also:



729
730
731
 
# File 'lib/processing/graphics_context.rb', line 729

def rectMode(mode)
  @rectMode__ = mode
end

#red(color) ⇒ Numeric

Returns the red value of the color.

Parameters:

  • color (Numeric) —

    color value

Returns:

  • (Numeric) —

    the red value

See Also:



547
548
549
 
# File 'lib/processing/graphics_context.rb', line 547

def red(color)
  ((color >> 16) & 0xff) / 255.0 * @colorMaxes__[0]
end

#renderMode(mode = nil) ⇒ PROCESSING, P5JS

Sets render mode.

Parameters:

  • mode (PROCESSING, P5JS) (defaults to: nil) —

    compatible to Processing or p5.js

Returns:



471
472
473
474
475
476
477
 
# File 'lib/processing/graphics_context.rb', line 471

def renderMode(mode = nil)
  if mode
    @renderMode__ = mode
    @p5jsMode__   = mode == P5JS
  end
  @renderMode__
end

#requestImage(filename, extension = nil) ⇒ Image

Loads image on a new thread. When the image is loading, its width and height will be 0. If an error occurs while loading the image, its width and height wil be -1.

Parameters:

  • filename (String) —

    file name to load image

  • extension (String) (defaults to: nil) —

    type of image to load (ex. ‘png’)

Returns:

  • (Image) —

    loading image object

See Also:



3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
 
# File 'lib/processing/graphics_context.rb', line 3166

def requestImage(filename, extension = nil)
  img = Image.new nil
  Thread.new filename, extension do |fn, ext|
    loaded = loadImage(fn, ext) or raise
    img.setInternal__ loaded.getInternal__
  rescue
    img.setInternal__ nil, true
  end
  img
end

#resetMatrix ⇒ nil

Reset current transformation matrix with identity matrix.

Returns:

  • (nil) —

    nil

See Also:



2149
2150
2151
2152
2153
 
# File 'lib/processing/graphics_context.rb', line 2149

def resetMatrix()
  assertDrawing__
  @painter__.matrix = 1
  nil
end

#resetShader ⇒ nil

Resets shader.

Returns:

  • (nil) —

    nil

See Also:



1240
1241
1242
1243
 
# File 'lib/processing/graphics_context.rb', line 1240

def resetShader()
  @painter__.no_shader
  nil
end

#rotate(angle) ⇒ nil

Applies rotation matrix to current transformation matrix.

Parameters:

  • angle (Numeric) —

    angle for rotation

Returns:

  • (nil) —

    nil

See Also:



1978
1979
1980
1981
1982
 
# File 'lib/processing/graphics_context.rb', line 1978

def rotate(angle)
  assertDrawing__
  @painter__.rotate toDegrees__ angle
  nil
end

#rotateX(angle) ⇒ nil

Applies rotation around the x-axis.

Parameters:

  • angle (Numeric) —

    angle for rotation

Returns:

  • (nil) —

    nil

See Also:



1993
1994
1995
1996
1997
 
# File 'lib/processing/graphics_context.rb', line 1993

def rotateX(angle)
  assertDrawing__
  @painter__.rotate toDegrees__(angle), 1, 0, 0
  nil
end

#rotateY(angle) ⇒ nil

Applies rotation around the y-axis.

Parameters:

  • angle (Numeric) —

    angle for rotation

Returns:

  • (nil) —

    nil

See Also:



2008
2009
2010
2011
2012
 
# File 'lib/processing/graphics_context.rb', line 2008

def rotateY(angle)
  assertDrawing__
  @painter__.rotate toDegrees__(angle), 0, 1, 0
  nil
end

#rotateZ(angle) ⇒ nil

Applies rotation around the z-axis.

Parameters:

  • angle (Numeric) —

    angle for rotation

Returns:

  • (nil) —

    nil

See Also:



2023
2024
2025
2026
2027
 
# File 'lib/processing/graphics_context.rb', line 2023

def rotateZ(angle)
  assertDrawing__
  @painter__.rotate toDegrees__(angle), 0, 0, 1
  nil
end

#round(value) ⇒ Numeric

Returns the closest integer number.

Parameters:

  • value (Numeric) —

    number

Returns:

  • (Numeric) —

    rounded number

See Also:



2361
2362
2363
 
# File 'lib/processing/graphics_context.rb', line 2361

def round(value)
  value.round
end

#saturation(color) ⇒ Numeric

Returns the saturation value of the color.

Parameters:

  • color (Numeric) —

    color value

Returns:

  • (Numeric) —

    the saturation value

See Also:



613
614
615
616
 
# File 'lib/processing/graphics_context.rb', line 613

def saturation(color)
  _, s, = toRawColor__(color).to_hsv
  s * (@hsbColor__ ? @colorMaxes__[1] : 1)
end

#save(filename) ⇒ nil

Saves screen image to file.

Parameters:

  • filename (String) —

    file name to save image

Returns:

  • (nil) —

    nil

See Also:



1922
1923
1924
1925
 
# File 'lib/processing/graphics_context.rb', line 1922

def save(filename)
  getInternal__.save filename
  nil
end

#scale(s) ⇒ nil #scale(x, y) ⇒ nil #scale(x, y, z) ⇒ nil

Applies scale matrix to current transformation matrix.

Parameters:

  • s (Numeric) —

    horizontal and vertical scale

  • x (Numeric) —

    horizontal scale

  • y (Numeric) (defaults to: nil) —

    vertical scale

  • z (Numeric) (defaults to: 1) —

    depth scale

Returns:

  • (nil) —

    nil

See Also:



1963
1964
1965
1966
1967
 
# File 'lib/processing/graphics_context.rb', line 1963

def scale(x, y = nil, z = 1)
  assertDrawing__
  @painter__.scale x, (y || x), z
  nil
end

#shader(shader) ⇒ nil

Sets shader.

Parameters:

  • shader (Shader) —

    a shader to apply

Returns:

  • (nil) —

    nil

See Also:



1228
1229
1230
1231
 
# File 'lib/processing/graphics_context.rb', line 1228

def shader(shader)
  @painter__.shader shader&.getInternal__
  nil
end

#shape(img, a, b) ⇒ nil #shape(img, a, b, c, d) ⇒ nil Also known as: drawShape

Draws a shape.

The parameters a, b, c, and d are determined by shapeMode().

Parameters:

  • shp (Shape) —

    shape to draw

  • a (Numeric) (defaults to: 0) —

    horizontal position of the shape, by default

  • b (Numeric) (defaults to: 0) —

    vertical position of the shape, by default

  • c (Numeric) (defaults to: nil) —

    width of the shape, by default

  • d (Numeric) (defaults to: nil) —

    height of the shape, by default

Returns:

  • (nil) —

    nil

See Also:



1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
 
# File 'lib/processing/graphics_context.rb', line 1649

def shape(shp, a = 0, b = 0, c = nil, d = nil)
  assertDrawing__
  return nil unless shp.isVisible

  drawWithTexture__ do |_|
    if c || d || @shapeMode__ != CORNER
      x, y, w, h = toXYWH__ @shapeMode__, a, b, c || shp.width, d || shp.height
      shp.draw__ @painter__, x, y, w, h
    else
      shp.draw__ @painter__, a, b
    end
  end
  nil
end

#shapeMode(mode) ⇒ nil

Sets shape mode. Default is CORNER.

CORNER -> shape(shp, left, top, width, height) CORNERS -> shape(shp, left, top, right, bottom) CENTER -> shape(shp, centerX, centerY, width, height)

Parameters:

Returns:

  • (nil) —

    nil

See Also:



780
781
782
 
# File 'lib/processing/graphics_context.rb', line 780

def shapeMode(mode)
  @shapeMode__ = mode
end

#shearX(angle) ⇒ nil

Applies shear around the x-axis.

Parameters:

  • angle (Numeric) —

    angle for shearing

Returns:

  • (nil) —

    nil

See Also:



2038
2039
2040
2041
2042
2043
2044
2045
2046
 
# File 'lib/processing/graphics_context.rb', line 2038

def shearX(angle)
  t = Math.tan toRadians__(angle)
  @painter__.matrix *= Rays::Matrix.new(
    1, t, 0, 0,
    0, 1, 0, 0,
    0, 0, 1, 0,
    0, 0, 0, 1)
  nil
end

#shearY(angle) ⇒ nil

Applies shear around the y-axis.

Parameters:

  • angle (Numeric) —

    angle for shearing

Returns:

  • (nil) —

    nil

See Also:



2057
2058
2059
2060
2061
2062
2063
2064
2065
 
# File 'lib/processing/graphics_context.rb', line 2057

def shearY(angle)
  t = Math.tan toRadians__(angle)
  @painter__.matrix *= Rays::Matrix.new(
    1, 0, 0, 0,
    t, 1, 0, 0,
    0, 0, 1, 0,
    0, 0, 0, 1)
  nil
end

#sin(angle) ⇒ Numeric

Returns the sine of an angle.

Parameters:

  • angle (Numeric) —

    angle in radians

Returns:

  • (Numeric) —

    the sine

See Also:



2641
2642
2643
 
# File 'lib/processing/graphics_context.rb', line 2641

def sin(angle)
  Math.sin angle
end

#sq(value) ⇒ Numeric

Returns squared value.

Parameters:

  • value (Numeric) —

    number

Returns:

  • (Numeric) —

    squared value

See Also:



2414
2415
2416
 
# File 'lib/processing/graphics_context.rb', line 2414

def sq(value)
  value * value
end

#sqrt(value) ⇒ Numeric

Returns squared value.

Parameters:

  • value (Numeric) —

    number

Returns:

  • (Numeric) —

    squared value

See Also:



2427
2428
2429
 
# File 'lib/processing/graphics_context.rb', line 2427

def sqrt(value)
  Math.sqrt value
end

#square(x, y, extent) ⇒ nil Also known as: drawSquare

Draws a square.

Parameters:

  • x (Numeric) —

    horizontal position of the shape

  • y (Numeric) —

    vertical position of the shape

  • extent (Numeric) —

    width and height of the shape

Returns:

  • (nil) —

    nil

See Also:



1457
1458
1459
 
# File 'lib/processing/graphics_context.rb', line 1457

def square(x, y, extent)
  rect x, y, extent, extent
end

#stroke(rgb) ⇒ nil #stroke(rgb, alpha) ⇒ nil #stroke(gray) ⇒ nil #stroke(gray, alpha) ⇒ nil #stroke(r, g, b) ⇒ nil #stroke(r, g, b, alpha) ⇒ nil

Sets stroke color.

Parameters:

  • rgb (String) —

    color code like ‘#00AAFF’

  • gray (Integer) —

    gray value (0..255)

  • r (Integer) —

    red value (0..255)

  • g (Integer) —

    green value (0..255)

  • b (Integer) —

    blue value (0..255)

  • alpha (Integer) —

    alpha value (0..255)

Returns:

  • (nil) —

    nil

See Also:



876
877
878
879
 
# File 'lib/processing/graphics_context.rb', line 876

def stroke(*args)
  @painter__.stroke(*toRGBA__(*args))
  nil
end

#strokeCap(cap) ⇒ nil

Sets stroke cap mode.

Parameters:

Returns:

  • (nil) —

    nil

See Also:



916
917
918
919
 
# File 'lib/processing/graphics_context.rb', line 916

def strokeCap(cap)
  @painter__.stroke_cap cap
  nil
end

#strokeJoin(join) ⇒ nil

Sets stroke join mode.

Parameters:

Returns:

  • (nil) —

    nil

See Also:



930
931
932
933
 
# File 'lib/processing/graphics_context.rb', line 930

def strokeJoin(join)
  @painter__.stroke_join join
  nil
end

#strokeWeight(weight) ⇒ nil

Sets stroke weight.

Parameters:

  • weight (Numeric) —

    width of stroke

Returns:

  • (nil) —

    nil

See Also:



902
903
904
905
 
# File 'lib/processing/graphics_context.rb', line 902

def strokeWeight(weight)
  @painter__.stroke_width weight
  nil
end

#tan(angle) ⇒ Numeric

Returns the ratio of the sine and cosine of an angle.

Parameters:

  • angle (Numeric) —

    angle in radians

Returns:

  • (Numeric) —

    the tangent

See Also:



2667
2668
2669
 
# File 'lib/processing/graphics_context.rb', line 2667

def tan(angle)
  Math.tan angle
end

#text(str) ⇒ nil #text(str, x, y) ⇒ nil #text(str, a, b, c, d) ⇒ nil Also known as: drawText

Draws a text.

The parameters a, b, c, and d are determined by rectMode().

Parameters:

  • str (String) —

    text to draw

  • x (Numeric) —

    horizontal position of the text

  • y (Numeric) —

    vertical position of the text

  • a (Numeric) —

    horizontal position of the text, by default

  • b (Numeric) —

    vertical position of the text, by default

  • c (Numeric) —

    width of the text, by default

  • d (Numeric) —

    height of the text, by default

Returns:

  • (nil) —

    nil

See Also:



1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
 
# File 'lib/processing/graphics_context.rb', line 1582

def text(str, x, y, x2 = nil, y2 = nil)
  assertDrawing__
  if x2
    raise ArgumentError, "missing y2 parameter" unless y2
    x, y, w, h = toXYWH__ @rectMode__, x, y, x2, y2
    case @textAlignH__
    when RIGHT  then x +=  w - @painter__.font.width(str)
    when CENTER then x += (w - @painter__.font.width(str)) / 2
    end
    case @textAlignV__
    when BOTTOM then y +=  h - @painter__.font.height
    when CENTER then y += (h - @painter__.font.height) / 2
    else
    end
  else
    y -= @painter__.font.ascent
  end
  @painter__.text str, x, y
  nil
end

#textAlign(horizontal, vertical = BASELINE) ⇒ nil

Sets the alignment for drawing text.

Parameters:

Returns:

  • (nil) —

    nil

See Also:



1145
1146
1147
1148
1149
 
# File 'lib/processing/graphics_context.rb', line 1145

def textAlign(horizontal, vertical = BASELINE)
  @textAlignH__ = horizontal
  @textAlignV__ = vertical
  nil
end

#textAscent ⇒ Numeric

Returns ascent of the current font at its current size.

Returns:

  • (Numeric) —

    ascent

See Also:



1120
1121
1122
 
# File 'lib/processing/graphics_context.rb', line 1120

def textAscent()
  @painter__.font.ascent
end

#textDescent ⇒ Numeric

Returns descent of the current font at its current size.

Returns:

  • (Numeric) —

    descent

See Also:



1131
1132
1133
 
# File 'lib/processing/graphics_context.rb', line 1131

def textDescent()
  @painter__.font.descent
end

#textFont ⇒ Font #textFont(font) ⇒ Font #textFont(name) ⇒ Font #textFont(font, size) ⇒ Font #textFont(name, size) ⇒ Font

Sets text font. (Passing a font name as the first parameter is deprecated)

Parameters:

  • font (Font) (defaults to: nil) —

    font

  • name (String) —

    font name

  • size (Numeric) (defaults to: nil) —

    font size (max 256)

Returns:

  • (Font) —

    current font

See Also:



1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
 
# File 'lib/processing/graphics_context.rb', line 1072

def textFont(font = nil, size = nil)
  if font != nil || size != nil
    size = FONT_SIZE_MAX__ if size && size > FONT_SIZE_MAX__
    if font.nil? || font.kind_of?(String)
      font = createFont font, size
    elsif size
      font.setSize__ size
    end
    @painter__.font = font.getInternal__
    @textFont__     = font
  end
  @textFont__
end

#textLeading ⇒ Numeric #textLeading(leading) ⇒ Numeric

Sets the spacing between lines of text in units of pixels.

Parameters:

  • leading (Numeric) (defaults to: nil) —

    the size in pixels for spacing between lines

Returns:

  • (Numeric) —

    current spacing

See Also:



1163
1164
1165
1166
 
# File 'lib/processing/graphics_context.rb', line 1163

def textLeading(leading = nil)
  @painter__.line_height = leading if leading
  @painter__.line_height
end

#textSize(size) ⇒ nil

Sets text size.

Parameters:

  • size (Numeric) —

    font size (max 256)

Returns:

  • (nil) —

    nil

See Also:



1095
1096
1097
1098
 
# File 'lib/processing/graphics_context.rb', line 1095

def textSize(size)
  textFont @textFont__, size
  nil
end

#texture(image) ⇒ nil

Sets texture.

Parameters:

  • image (Image) —

    texture image

Returns:

  • (nil) —

    nil

See Also:



1177
1178
1179
1180
 
# File 'lib/processing/graphics_context.rb', line 1177

def texture(image)
  @painter__.texture image&.getInternal__
  nil
end

#textureMode(mode) ⇒ nil

Sets the coordinate space for texture mapping.

Parameters:

  • mode (IMAGE, NORMAL) —

    image coordinate, or normalized coordinate

Returns:

  • (nil) —

    nil

See Also:



1200
1201
1202
1203
 
# File 'lib/processing/graphics_context.rb', line 1200

def textureMode(mode)
  @painter__.texcoord_mode = mode
  nil
end

#textureWrap(wrap) ⇒ nil

Sets the texture wrapping mode.

Parameters:

  • wrap (CLAMP, REPEAT) —

    how texutres behave when go outside of the range

Returns:

  • (nil) —

    nil

See Also:



1214
1215
1216
1217
 
# File 'lib/processing/graphics_context.rb', line 1214

def textureWrap(wrap)
  @painter__.texcoord_wrap = wrap
  nil
end

#textWidth(str) ⇒ Numeric

Returns the width of the text.

Parameters:

  • str (String) —

    text string

Returns:

  • (Numeric) —

    width of the text

See Also:



1109
1110
1111
 
# File 'lib/processing/graphics_context.rb', line 1109

def textWidth(str)
  @painter__.font.width str
end

#tint(rgb) ⇒ nil #tint(rgb, alpha) ⇒ nil #tint(gray) ⇒ nil #tint(gray, alpha) ⇒ nil #tint(r, g, b) ⇒ nil #tint(r, g, b, alpha) ⇒ nil

Sets fill color for drawing images.

Parameters:

  • rgb (String) —

    color code like ‘#00AAFF’

  • gray (Integer) —

    gray value (0..255)

  • r (Integer) —

    red value (0..255)

  • g (Integer) —

    green value (0..255)

  • b (Integer) —

    blue value (0..255)

  • alpha (Integer) —

    alpha value (0..255)

Returns:

  • (nil) —

    nil

See Also:



1002
1003
1004
1005
 
# File 'lib/processing/graphics_context.rb', line 1002

def tint(*args)
  @tint__ = args
  nil
end

#translate(x, y) ⇒ nil #translate(x, y, z) ⇒ nil

Applies translation matrix to current transformation matrix.

Parameters:

  • x (Numeric) —

    left/right translation

  • y (Numeric) —

    up/down translation

  • z (Numeric) (defaults to: 0) —

    forward/backward translation

Returns:

  • (nil) —

    nil

See Also:



1941
1942
1943
1944
1945
 
# File 'lib/processing/graphics_context.rb', line 1941

def translate(x, y, z = 0)
  assertDrawing__
  @painter__.translate x, y, z
  nil
end

#triangle(x1, y1, x2, y2, x3, y3) ⇒ nil Also known as: drawTriangle

Draws a triangle.

Parameters:

  • x1 (Numeric) —

    horizontal position of first point

  • y1 (Numeric) —

    vertical position of first point

  • x2 (Numeric) —

    horizontal position of second point

  • y2 (Numeric) —

    vertical position of second point

  • x3 (Numeric) —

    horizontal position of third point

  • y3 (Numeric) —

    vertical position of third point

Returns:

  • (nil) —

    nil

See Also:



1477
1478
1479
1480
1481
 
# File 'lib/processing/graphics_context.rb', line 1477

def triangle(x1, y1, x2, y2, x3, y3)
  assertDrawing__
  @painter__.line x1, y1, x2, y2, x3, y3, loop: true
  nil
end

#updatePixels(&block) ⇒ nil

Update the image pixels with the ‘pixels’ array.

Returns:

  • (nil) —

    nil

See Also:



1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
 
# File 'lib/processing/graphics_context.rb', line 1888

def updatePixels(&block)
  return if !block && !@pixels__
  if block
    loadPixels
    block.call pixels
  end
  getInternal__.tap do |img|
    img.pixels = @pixels__
    img.paint {} # update texture and set modifiied
  end
  @pixels__ = nil
end

#vertex(x, y) ⇒ nil #vertex(x, y, u, v) ⇒ nil

Append vertex for shape polygon.

Parameters:

  • x (Numeric) —

    x position of vertex

  • y (Numeric) —

    y position of vertex

  • u (Numeric) (defaults to: nil) —

    u texture coordinate of vertex

  • v (Numeric) (defaults to: nil) —

    v texture coordinate of vertex

Returns:

  • (nil) —

    nil

See Also:



1768
1769
1770
1771
 
# File 'lib/processing/graphics_context.rb', line 1768

def vertex(x, y, u = nil, v = nil)
  (@drawingShape__ or raise "vertex() must be called after beginShape()")
    .vertex x, y, u, v
end

#width ⇒ Numeric

Returns the width of the graphics object.

Returns:

  • (Numeric) —

    width

See Also:



419
420
421
 
# File 'lib/processing/graphics_context.rb', line 419

def width()
  getInternal__.width
end