gen.codebox
Generate native audio signal processing routines
Description
The gen.codebox~ object is a UI object for display and editing of GenExpr code to be converted into signal processing routines of optimized native machine code.
Arguments
None.
Attributes
bgcolor[4 floats]
Sets the color for the object's background frame.
linenumbers[int]: 1
Show lefthand column containing line numbers for non empty lines.
linenumberwidth[int32]: 20
Set the width of lefthand line number column in pixels.
margin[int32]: 4
Set the width of the left and righthand margin in pixels
style[symbol]:
Style
textcolor[4 floats]
The default textcolor (typically overridden by syntax coloring)
autoexport[int]: 1
Automatically export code on edit. Equivalent to sending the exportcode message every time an edit is made. Please note that in order for this to work properly, the following must be true: audio must be on, a previous manual export must have occurred, and a valid value for the exportfolder attribute must be set.
cpu[float]
Reports cpu usage as a fraction of available compute time, if cpumeasure is enabled.
cpumeasure[int]
CPU monitoring must be enabled for cpu to work.
gen[symbol]
Gen patcher name to load from disk
dumpoutlet[int]: 0
Enables an additional "dump" outlet for diagnostics, such as reading the cpu attribute.
exportfolder[symbol]:
Folder to export code into. Used by the exportcode message to determine what directory to write source files into.
title[symbol]
Set patcher title.
nocache[int]: 0
The nocache attribute, with an argument of 1, recompiles the Gen patcher regardless of whether another instance of Gen has already compiled it. When set to 0 (default), Gen caches previous compiles to save on load time.
poll[int]: 0
Enable attribute polling
exportscriptargs[symbol]:
Post export script arguments
exportscript[symbol]:
Post export script
exportnotifier[symbol]:
Receive object name to receive export notification
exportname[symbol]:
Export Filename
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]: 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'
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]: 0
Toggles whether an object ignores mouse clicks in a locked patcher.
jspainterfile[symbol]
You can override the default appearance of a user interface object by assigning a JavaScript file with code for painting the object. The file must be in the search path.
patching_rect[4 floats]: 0. 0. 100. 0.
Sets the position and size of the object in the patcher window.
position[2 floats]
write-only
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]: 0
Sets whether an object belongs to the patcher's presentation.
presentation_rect[4 floats]: 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]
write-only
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]
write-only
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[4 floats]
Sets the color for the object's text in RGBA format.
textjustification[int]
Sets the justification for the object's text.
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
reset_param
Resets a specific param, history or buffer object to the default initial value.
- name
[symbol]
reset
Reset all parameters to defaults (including history values and buffer object associations).
wclose
Close the view of the Gen patcher.
reload
Reload the Gen patcher.
float
Set input value (if signal is not attached).
- value
[float]
int
Set input value (if signal is not attached).
- value
[int]
signal
Send signals to the Gen patcher.
open
View the Gen patcher.
exportcode
Export a gen patcher as C++ code.
(mouse)
Double-click to open the Gen patcher.
See Also
| Name | Description |
|---|---|
| gen~ | Generate native audio signal processing routines |
| gen | Generate native audio event processing routines |
| gen.codebox |