gen Reference

Generate native audio event processing routines

gen

Description

The gen object turns an embedded Gen patcher into event processing routines analagous to what the gen~ object does for audio signals. The Gen patcher can be built from a wide set of low-level Gen operator objects as well as embedded code expressions.

Arguments

patcher-name [symbol]

Optional

The first argument, if given, specifies the name of a .gendsp patcher to be loaded which already exists and is in the Max search path. The patcher can also be specified using the gen attribute. If no Gen patcher is specified by argument or gen attribute, an embedded Gen patcher is created instead.

Attributes

active [int] (default: 0)

The gen object contains an internal metro controlled by the active and interval attributes. When you change @interval the sample rate is updated (and currently the patch is recompiled); for an interval of 250 the sample rate is 4 samples per second. This permits oscillators etc. to work at any resolution in the event domain.

autoexport [int] (default: 1)

Automaticall export code on edit. Equivalent to sending the exportcode message every time an edit is made.

cpu [float]

g/s(get)

Reports cpu usage as a fraction of available compute time, if cpumeasure is enabled.

cpumeasure [int] (default: 0)

CPU monitoring must be enabled for cpu to work.

dumpoutlet [int] (default: 0)

Enables an additional "dump" outlet for diagnostics, such as reading the cpu attribute.

exportfolder [symbol] (default: )

Folder to export code into. Used by the exportcode message to determine what directory to write source files into.

exportname [symbol] (default: )

Export Filename

exportnotifier [symbol] (default: )

Receive object name to receive export notification

exportscript [symbol] (default: )

Post export script

exportscriptargs [symbol] (default: )

Post export script arguments

gen [symbol] (default: )

Gen patcher name to load from disk

hot [int] (default: 0)

Any inlet will trigger output when >hot is on. Otherwise the standard behavior of only the left inlet triggering output will be used.

interval [float] (default: 5.)

The gen object contains an internal metro controlled by the active and interval attributes. When you change @interval the sample rate is updated (and currently the patch is recompiled); for an interval of 250 the sample rate is 4 samples per second. This permits oscillators etc. to work at any resolution in the event domain.

nocache [int] (default: 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] (default: 0)

Enable attribute polling

title [symbol]

Set patcher title.

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.

jspainterfile [symbol]

JS Painter File

patching_rect [4 floats] (default: 0. 0. 100. 0.)

Sets the position and size of the object in the patcher window.

position [2 floats]

g/s(set)

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]

g/s(set)

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]

g/s(set)

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

bang

Execute a calculation of the gen patcher or expression.

int

Arguments

value [int]
Set input value (if signal is not attached).

float

Arguments

value [float]
Set input value (if signal is not attached).

(mouse)

Double-click to open the Gen patcher.

exportcode

Export a gen patcher as C++ code.

open

View the Gen patcher.

reload

Reload the Gen patcher.

reset

Reset all parameters to defaults (including history values and buffer object associations).

reset_param

Arguments

name [symbol]
Resets a specific param, history or buffer object to the default initial value.

wclose

Close the view of the Gen patcher.

See Also

Name Description
Working with Video in Jitter Working with Video in Jitter
MC MC
Gen Gen
gen~ Generate native audio signal processing routines
Gen Overview Gen Overview
Gen Common Operators Gen Common Operators
gen~ Operators gen~ Operators