jit.pworld Reference

Display a Jitter GL context

jit.pworld

Description

Use jit.pworld to draw pixels or graphics within a patcher - it displays jit.matrix data as well as OpenGL 3D graphics.

Discussion

This object functions the same as a jit.pwindow and jit.gl.render combination. This allows you to display HD video using only a video object and jit.pworld, which reduces patching complexity. An internal jit.gl.videoplane object is used to display texture/matrix input without a matrix readback, which increases efficiency. It instantiates as enabled at 30fps, with a black "erase" color.

Arguments

None.

Attributes

depthbuffer [int]

Enable depth buffer

doublebuffer [int]

Enable double buffering

enable [int]

Enable automatic rendering (default = 1). When enabled, rendering is performed automatically.

fps [float]

The frames per second of automatic rendering (default = 30). Requires enable 1. If sync is enabled, the frame rate will be clamped at the display refresh rate.

fsaa [int]

Full scene anti-aliasing enable

idlemouse [int] (default: 0)

Mouse idle events enable

name [symbol]

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

pickray [int] (default: 0)

Pickray

shared [int] (default: 1)

Set the window as a shared context

size [2 ints]

Window size

stereo [int]

Stereo buffer enable

sync [int]

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

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

Draw and update all automatic clients and animations. Only used if enable is 0.

int

Set the enable attribute. When enabled frame updates are handled automatically.

jit_gl_texture

Arguments

texture-name [symbol]
Draw the texture to screen by first reading back the texture into a matrix.

jit_matrix

Arguments

matrix-name [symbol]
Draw the matrix to screen

(mouse)

Mouse events

sendrender

Arguments

message [symbol]
values [list]
Send messages to the internal jit.gl.render object.

sendvideoplane

Arguments

message [symbol]
values [list]
Send messages to the internal jit.gl.videoplane object.

See Also

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