Package Jitter

jit.window

Display data in a window

Description

Use the jit.window object to draw pixels or graphics to a window. jit.window displays jit.matrix data as well as OpenGL 3D graphics.

Attributes

border[int]

Show window border

clamp[int]

Clamp matrix values

colormode[symbol]

Matrix color mode Possible values:

'argb' ( Use ARGB color )
'uyvy' ( Use UYVY color. On windows requires noaccel 1 for matrix input )

depthbuffer[int]

Enable depth buffer

doublebuffer[int]

Enable back buffer

dstrect[4 ints]

The matrix destination rectangle is given by coordinates left, top, bottom, right. All values are relative to the top left corner of the window.

floating[int]

Enable floating window style

fsaa[int]

Enable full scene anti-aliasing

fullscreen[int]

Enable fullscreen

grow[int]

Enable the mouse grow region for the window. When the flag is set, the window can be resized by clicking and dragging in the lower right-hand corner.

idlemouse[int]

Enable mouse idle events

interp[int]

Enable matrix interpolation

mousewheel[int]

Enable mousewheel messages

name[symbol]

The name of the window. Jitter OpenGL objects attach to a rendering context through the window's name.

noaccel[int]

Disable OpenGL hardware acceleration

pickray[int]

Enable output of picking ray

planemap[4 ints]

Maps input planes to output planes (default = 0 1 2 3 ...)

pos[2 ints]

Window position is specified in pixels by an x and y offset value in global coordinates from the upper left corner of the screen.

rect[4 ints]

The window rectangle is specified in pixels giving the left, top, right, and bottom coordinates of the window from the upper left corner.

shared[int]

Sets the window as a shared context.

size[2 ints]

Window size

srcrect[4 ints]

The portion of the input matrix used when copying an input matrix to the internal matrix. (default = 0 0 (matrix width) (matrix height)) The proportions of the rectangle are expressed in the form left, top, bottom, right. All values are relative to the top left corner of the viewing area of the input matrix.

stereo[int]

Enable stereo buffers

sync[int]

The vertical sync flag sets the window to update synchronous to the monitor's refresh.

title[symbol]

The window title. If not title is set, the title of the window will be set to the name of the window.

usedstrect[int]

Enables destination rectangle

usesrcrect[int]

Enables source rectangle

visible[int]

Enable window visibility

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.

Messages

(mouse)

Double-click to bring the jit.window to front

front

Bring the window to front

sendtexture

Send a message to the internal texture

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

See Also

Name Description
jit.gl.render Render Jitter OpenGL objects
jit.pwindow Display Jitter data and images