Package Jitter

jit.gl.pix.codebox

Generates pixel processing shaders from GenExpr code

Description

The jit.gl.pix.codebox object generates new pixel processing shaders from GenExpr code. jit.gl.pix.codebox is essentially a jit.gl.slab object whose shader files are generated from GenExpr code.

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)

title[symbol]

Gen patcher title

t[symbol]

Gen patcher title

dirty[int]
read-only

Gen patcher dirty flag

type[symbol]

The output texture data type (default = auto). When type is auto the type is set by the input texture or matrix type. Possible values:

'auto' ( Adapt to input data type )
'char' ( 8bit unsigned byte )
'long' ( 32bit integer )
'half' ( 16bit float )
'float' ( 32bit float )
'float16' ( 16bit float )
'float32' ( 32bit float )

thru[int]

Enable thru mode (default = 1). When the flag is set, texture output is sent whenever input is received.

texrect[4 floats]

Texture rectangle mapping values (default = 0 0 1 1...). The four values represent texture mapping coordinates for the left, bottom, right and top sides of the geometry rectangle, and can be used to easily crop the input image. There are four values for each texture input.

rectangle[long]

Enable texture rectangle mode on internal texture objects(default = 1). When enabled the internal GL texture is treated as a rectangular texture, and must be referenced using sampler2DRect and sampled using texture2DRect when sampled from a GLSL shader. When disabled the texture dimensions are upsampled to the nearest power of two value, and must be referenced and sampled using sampler2D and texture2D. Certain texture attributes and GLSL effects require rectangle mode disabled.

rect[4 floats]

Geometry rectangle (default = 0 0 1 1). The four values represent normalized coordinates for the left, bottom, right and top sides of the geometry rectangle. To flip the image horizontally use rect 1 0 0 1 or to flip vertically use rect 0 1 1 0 .

outputs[int]
7.0.0

Number of texture outputs (default = 1). Texture outputs correspond to gen patcher outs.

out_name[symbol]
read-only

Output texture name

inputs[int]

Input count (default = 2)

gen[symbol]

The name of the gen patcher to use.

exportfolder[symbol]

Sets the folder to export gen patchers into when using the exportcode message.

dimscale[2 floats]

The output dimension scaling factor of the output (default = 1 1). Useful for upsampling or downsampling texture output.
output.dim = input.dim*dimscale

dim[2 ints]

The texture output dimensions when adapt is disabled (default = 256 256)

depth[float]

The depth or z-offset for the slab geometry. (default = 0.0)

colormode[symbol]

Texture color mode (default = argb) Possible values:

'argb'
'uyvy'

adapt[long]

Enable adapt to input (default = 1). When enabled the texture output dimensions will match the input dimensions.

activeinput[int]

The current input used for texture and matrix messages (default = 0). Useful when calling input messages from Java or JavaScript.

OB3D Attributes

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]

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

anything

Set parameter values in the Gen patcher

(drag)

Drag and drop a .genjit Gen patcher

(mouse)

Double-click to open gen patcher window

exportcode

Export a gen patcher as shader code. With no arguments, jit.gl.pix will export a standard Jitter JXS shader file with GLSL code. The optional arguments can be either 'jxs' or 'webgl' or 'isf'.

In the 'webgl' case, jit.gl.pix will export an .html file suitable for loading in a WebGL context . The code uses TWGL as a helper library and requires the twgl-full.min.js file be in the same directory as the exported html file.

In the 'isf' case, jit.gl.pix will export a .fs fragment shader suitable for loading in a ISF (Interactive Shader Format) context

Arguments:
  • target [symbol]

full_source_code

Opens an editor window with the generated source code formatted as a JXS file.

getparamdefault

Sends the default data values for the indicated shader parameter for the internal jit.gl.shader object out the right-most outlet.

getparamlist

Sends the names of all the internal jit.gl.shader object shader parameters out the right-most outlet.

getparamtype

Sends the name of the datatype for the indicated shader parameter for the internal jit.gl.shader object out the right-most outlet.

getparamval

Sends the data values for the indicated shader parameter for the internal jit.gl.shader object out the right-most outlet.

open

Open the Gen patcher window

param

Sets the given shader parameter with the given atom values as defined in a JXS (Jitter shader) file.

sendinput

Sends an input jit.gl.texture a message. If the first arg is an int, it specifies the texture index to send the message, otherwise all input textures receive the message.

Arguments:
  • index [int]
  • message [symbol]
  • values [list]

sendoutput

Sends the output jit.gl.texture objects a message.

Arguments:
  • message [symbol]
  • values [list]

sendshader

Sends the internal jit.gl.shader object a message

Arguments:
  • message [symbol]
  • values [list]

wclose

Close the Gen patcher

compile

Compile the Gen patcher

getparamdescription

Get a parameter description

OB3D Messages

See Also

Name Description
jit.gen Generate new Jitter MOP objects
jit.pix Generates Jitter mop pixel processing objects from a patcher.
jit.gl.pix Generates pixel processing shaders from a gen patcher
jit.gen.codebox Generate new Jitter MOP objects
jit.pix.codebox Generate Jitter MOP pixel processing objects