jit.window

Display data in a Window

Description

The jit.window object is a good place to draw things. It reports mouse position along with button and modifier key info so your patch can enable user interaction. It also supports objects like the jit.gl.handle object to provide built-in UI services.

The jit.window object takes an optional name argument followed by an optional rect argument. If the window has a title bar, the name will be displayed in it. If no name is specified for a window, Jitter will invent a name like "u420003924".

Messages

(mouse) Double-clicking on a jit.window object ends the display window to front.
front Sends the window to front.
getname Sends the name of the window out the right outlet of the object.
name instance-name [symbol]
Sets the instance name to instance-name . If instance-name is not present, a new and unique name will be generated, replacing the previous name.
sendtexture The word sendtexture, followed by a message or attribute list, will forward those messages and attributes to the internal texture object (e.g. sendtexture colormode uyvy).

Attributes

Name Type g/s Description
border int Window border flag (default = 1) When the flag is set, the window is displayed with a border.
clamp int Matrix clamping flag (default = 1) When the flag is set, matrix conversion into the window is clamped.
colormode symbol Color mode (default = argb). Possible values are argb or uyvy.
depthbuffer int Depth buffer flag (default = 0) When the flag is set, a depth buffer is allocated so that OpenGL contexts made with the jit.gl.render object can provide hidden-surface removal.
doublebuffer int Back buffer flag (default = 1) When the flag is set, a back buffer is allocated so that images can be drawn in multiple steps before viewing.
dstrect int The portion of the output matrix written to by the input frame (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 object's viewing area.
floating int Floating window flag (default = 0) When the flag is set, a floating window with unique style which will always remain on top of other windows is displayed.
flushlimit int Sets a non accelerated window flushing limit (25 ms default). This attribute is only relevant when the noaccel attribute is enabled.
fsaa int Full scene anti-aliasing flag (default = 0) When the flag is set, 3d graphics rendered into jit.window will use full scene antialiasing. Support for full scene anti-aliasing depends on your graphics card, current graphics card settings, and available VRAM. Please consult the documentation or technical specs for your graphics card for more information. By default, full scene anti-aliasing is turned off.
fsmenubar int "If fullscreen, menubar is visible" flag (default = 1) When the flag is set, the menubar will be visible in fullscreen mode. Otherwise it will be invisible.
fullscreen int Fullscreen mode flag (default = 0) Turning fullscreen mode on then off will restore window to original size.
grow int Grow region flag (default = 1) When the flag is set, the window can be resized by clicking and dragging in the lower right-hand corner.
idlemouse int Mouse on idle flag (default = 0) When the flag is set, mouse messages are sent on idle over window without the user clicking.
interp int Interpolation flag (default = 0) When the flag is set, the incoming matrix is interpolated when scaling to display.
mode symbol Drawing mode (default = auto). Possible values are auto, texture, drawpixels, or noaccel.
noaccel int OpenGL acceleration disable flag (default = 0)
planemap int Input plane to output plane mapping (default = 0 1 2 3 ...)
pos int The window position (default = 100 100)
Window position is specified in pixels by an x and y offset value in global coordinates from the upper left corner of the computer's display screen.
rect int The window rect (default = 100 100 420 340)
Window size is specified as left top right bottom . Values for the corners of the rectangle are relative to the top left corner of the computer's display screen.
size int The window size (width and height) (default = 320 240)
srcrect int 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 Toggles the stereoscopic context flag (default = 0/off).
sync int VBL sync flag (default = 1) When the flag is set and GL acceleration is active, the window is updated synchronous to the monitor's refresh in response to incoming matrices. When using in conjunction with the jit.gl.render object, the jit.gl.render object's sync attribute overrides this attribute.
usedstrect int Destination rect flag (default = 0) When the flag is set, the dstrect attributes are used when copying an input matrix to the internal matrix.
usesrcrect int Source rect flag (default = 0) When the flag is set, the srcrect attributes are used when copying an input matrix to the internal matrix.
visible int Window display flag (default = 1)

Information for box attributes common to all objects

Examples

See Also

Name Description
jit.gl.render Render Open GL
jit.pwindow In-Patcher Window
Tutorial 1: Playing a QuickTime Movie Tutorial 1: Playing a QuickTime Movie
Tutorial 31: Rendering Destinations Tutorial 31: Rendering Destinations
Tutorial 38: Basic Performance Setup Tutorial 38: Basic Performance Setup
Tutorial 47: Using Jitter Object Callbacks in JavaScript Tutorial 47: Using Jitter Object Callbacks in JavaScript
Tutorial 49: Colorspaces Tutorial 49: Colorspaces