jit.pwindow Reference

Display Jitter data and images

jit.pwindow

Description

Use jit.pwindow to draw pixels (jit_matrix data) or OpenGL 3D graphics scenes (jit_texture data) within a patcher. When it receives jit_matrix messages it displays them as pixel data and when it receives jit_texture messages it displays them using a passive OpenGL render context.

Examples

Arguments

None.

Attributes

border [float] (default: 0.)

Enable border drawing

bordercolor [4 floats] (default: 0. 0. 0. 1.)

Sets the Border Color in RGBA format. The Draw border flag must be set for the border to be visible.

colormode [symbol] (default: argb)

Matrix color mode

Possible values:

'argb' ( ARGB color )
Colors specified in ARGB format (default)

'uyvy' ( UYVY color )
Colors specified in UYVY format

depthbuffer [int]

Enable depth buffer

doublebuffer [int]

Enable double buffering

dstrect [4 ints] (default: 0 0 320 240)

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

fsaa [int]

Full scene anti-aliasing enable

idlemouse [int] (default: 0)

Mouse idle events enable

interp [int] (default: 0)

Matrix interpolation enable

name [symbol]

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

onscreen [int] (default: 1)

Draw direct to screen enable

pickray [int] (default: 0)

Pickray

planemap [4 ints] (default: 0 1 2 3)

The plane mapping from input matrix to output (default = 0 1 2 3).

shared [int] (default: 1)

Set the window as a shared context

size [2 ints]

Window size

srcrect [4 ints] (default: 0 0 320 240)

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 right bottom . All values are relative to the top left corner of the viewing area of the input matrix.

stereo [int]

Stereo buffer enable

sync [int]

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

usedstrect [int] (default: 0)

Enable destination rectangle

usesrcrect [int] (default: 0)

Enable source rectangle

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

Output the currently stored matrix

jit_gl_texture

Arguments

texture-name [symbol]
Draws the texture to screen using a passive OpenGL render context. In this mode, jit.pwindow is always drawn on the top-most patching layer and will obscure any other patcher elements occupying the same region of the patcher.

jit_matrix

Arguments

matrix-name [symbol]
Draws the matrix to screen as ARGB pixel data. In this mode, jit.pwindow can be layered anywhere in the Max patcher layer hierarchy, so text and objects can be seen on top of the incoming matrix data.

(mouse)

Mouse events

See Also

Name Description
Working with Video in Jitter Working with Video in Jitter
jit.gl.render Render Jitter OpenGL objects
jit.window Display data in a window
Tutorial 2: Create a Matrix Tutorial 2: Create a Matrix
Tutorial 31: Rendering Destinations Tutorial 31: Rendering Destinations
Tutorial 38: Basic Performance Setup Tutorial 38: Basic Performance Setup
Tutorial 39: Spatial Mapping Tutorial 39: Spatial Mapping
Tutorial 45: Introduction to using Jitter within JavaScript Tutorial 45: Introduction to using Jitter within JavaScript
Tutorial 49: Colorspaces Tutorial 49: Colorspaces