Description
Creates a click-able area that returns an RGB color, or can accept any screen coordinates to get the RGB values of that pixel.
Examples
Discussion
Note -- while [cmd]-clicking on the suckah when the patch is unlocked, the suckah sees itself.
Arguments
None.
Attributes
boundmode [int] (default: 0)
When enabled, the suckah object will only output color values within the bounds of the object's box. Coordinates outside of the object's bounds will be ignored.
compatibility [int] (default: 0)
Toggles the output of the suckah object in old-style integer values in the range 0-255 (0) or 0.-1.0 floating-point values (1).
outputalpha [int] (default: 1)
Toggles the output of 3-element RGB lists (0) or 4-element RGBA lists that include alpha channel values (1).
Common Box Attributes
annotation [symbol]
Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.
background [int] (default: 0)
Adds or removes the object from the patcher's background layer. background 1 adds the object to the background layer, background 0 removes it. Objects in the background layer are shown behind all objects in the default foreground layer.
color [4 floats]
Sets the color for the object box outline.
fontface [int]
Sets the type style used by the object. The options are:
plain
bold
italic
bold italic
Possible values:
0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'
fontname [symbol]
Sets the object's font.
fontsize [float]
Sets the object's font size (in points).
Possible values:
'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'
hidden [int] (default: 0)
Toggles whether an object is hidden when the patcher is locked.
hint [symbol]
Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.
ignoreclick [int] (default: 0)
Toggles whether an object ignores mouse clicks in a locked patcher.
patching_rect [4 floats] (default: 0. 0. 100. 0.)
Sets the position and size of the object in the patcher window.
position [2 floats]
Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.
presentation [int] (default: 0)
Sets whether an object belongs to the patcher's presentation.
presentation_rect [4 floats] (default: 0. 0. 0. 0.)
Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.
rect [4 floats]
Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).
size [2 floats]
Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.
textcolor [float]
Sets the color for the object's text in RGBA format.
textjustification [int]
Text Justification
Possible values:
0 = 'left'
1 = 'center'
2 = 'right'
varname [symbol]
Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.
Messages
list
Arguments
screen-y [int]
(mouse)
Output
list
A list of three ints corresponding to the RGB value of the pixel selected by using the mouse or in response to a list of x and y offsets will be sent out the suckah object's outlet.
See Also
| Name | Description |
|---|---|
| route | Select outlet based on input matching |
| sprintf | Format a message of words and numbers |
| zl | Process lists in many ways |
| Tutorial 10: Chromakeying | Tutorial 10: Chromakeying |