Package Gen

poke

Write values into a data/buffer object

Description

Write values into a data/buffer object. The first argument should be a name of a data or buffer object in the gen patcher. The second argument (or third inlet if omitted) specifies which channel to use. The first inlet specifies a value to write, while the second inlet specifies the sample index within the data/buffer. If the index is out of range, no value is written.

Constructors

  • { arguments={name, value, position, channel, overdub}, inlets={} }
  • { arguments={name, value, position, channel}, inlets={overdub} }
  • { arguments={name, position, channel}, inlets={value, overdub} }
  • { arguments={name, channel}, inlets={value, position, overdub} }
  • { arguments={name}, inlets={value, position, channel, overdub} }

Inlets

value[float]

value to write

position[float]

position to write (units depend on @index attribute)

channel[int]

channel to write (zero-based)

overdub[float]

overdub mix: amount of original signal to preserve

Attributes

boundmode[enum]: ignore
write-only

Handle out-of-range indices: "ignore" prevents writing, "wrap" wraps the indices back into the range of the buffer, "fold" and "mirror" wrap the indices back into range by alternating direction, "clip" and "clamp" constrain the indices to the buffer limits. Possible values:

0 = 'clamp'
1 = 'ignore'
2 = 'wrap'
3 = 'clip'
4 = 'fold'
5 = 'mirror'

channelmode[enum]: ignore
write-only

Handle invalid channel indices: "ignore" prevents writing, "wrap" wraps the indices back into channels of the buffer, "fold" and "mirror" wrap the indices back into range by alternating direction, "clip" and "clamp" constrain the indices to the channels available. Possible values:

0 = 'clamp'
1 = 'ignore'
2 = 'wrap'
3 = 'clip'
4 = 'fold'
5 = 'mirror'

index[enum]: samples
write-only

Specify how to index the buffer: "samples" indexes by sample offset into the buffer, "phase" converts a signal in the range of 0..1 to span the whole buffer, "lookup" or "signal" converts a signal in the range -1..1 to span the whole buffer. Possible values:

0 = 'samples'
1 = 'phase'
2 = 'lookup'
3 = 'signal'

overdubmode[enum]: accum
write-only

How overdubbing is applied: "mix" crossfades between current and new sample according to the overdub factor, "accum" scales the new sample by the overdub factor and adds it to the current sample. Possible values:

0 = 'accum'
1 = 'mix'

Common Box Attributes

Below is a list of attributes shared by all objects. If you want to change one of these attributes for an object based on the object box, you need to place the word sendbox in front of the attribute name, or use the object's Inspector.

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'

hidden[int]: 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]: 0

Toggles whether an object ignores mouse clicks in a locked patcher.

jspainterfile[symbol]

JS Painter File

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.

See Also

Name Description
buffer A reference to an external buffer~ object
channels The number of channels of a data/buffer object
cycle Sine / wavetable lookup oscillator
data A locally stored array of 64-bit values
dim The length (in samples) of a data/buffer object
lookup Index a data/buffer object using a signal, for waveshaping
nearest Multi-channel lookup a data/buffer object (no interpolation)
peek Read values from a data/buffer object
poke Write values into a data/buffer object
sample Linear interpolated multi-channel lookup of a data/buffer object
splat Mix values into a data/buffer object, with linear interpolated overdubbing
wave Wavetable synthesis using a data/buffer object