A newer version of Max is available. Click here to access the latest version of the documentation

jit.displays

Set and query monitor attributes

Description

Senses additional display hardware attached to your computer and allows you to use standard Jitter get* and set* messages to enumerate the number and coordinates of any and all monitors. The object remembers the original state of your system's display settings when the object is instantiated, which can be easily recalled, and you can also use the object to enable display mirroring.
Typically, the jit.displays object is saved as a portion of a performance patch setup to automatically determine the exact position of your attached hardware and move your output window as needed.

Examples

Arguments

None.

Attributes

resetmode [int]

Macintosh only
Display mode flag (default = 1)
Enables or disables reset when the object is freed The jit.displays object remembers the original state of your system's display settings when the object is instantiated (display settings can also be saved using the snapshot message. A resetmode 1 will cause the original display settings to be restored when the patch is closed or the object is otherwise freed.

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.

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 [float]

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

Equivalent to the count message. Sends a count of the attached displays out the object's outlet in the form count number-of-displays .

coords

Arguments

display-index [int]
Sends the display screen coordinates for the display whose index is specified out the object's right outlet as a list in the form coords display-index left top bottom right . Displays are counted from 0 (0 is the primary display).

count

Sends a count of the attached displays out the object's outlet in the form count number-of-displays .

currentstate

Arguments

display-index [int]
Sends the current state of the display out the object's outlet as a list in the form currentstate display-index width height color-bit-depth refresh-rate . Note that LCD displays report a refresh rate of 0.

getmode

Arguments

display-index [int]
Sends available display modes for display specified by display-index out the right outlet as a sequence of lists, one display per line. Each display is described by a list in the form mode display-index mode-index width height color-bit-depth refresh-rate . Note: LCD displays have a refresh rate of 0.

manual

Arguments

display-index [int]
width [int]
height [int]
bit-depth [int]
Macintosh only
Sets the display to a configuration which provides the closest match for the ideal configuration specified by the arguments.

mirror

Arguments

src-display-index [int]
dst-display-index [int]
Macintosh only
Enables video mirroring of the display whose number is specified by src-display-index to the display whose number is specified by dst-display-index.

move

Arguments

display-index [int]
newxtop [int]
newytop [int]
Changes the logical screen location of the display whose number is specified by src-display-index. Two additional arguments specify the new screen location. If a location is chosen which overlaps with the location of another display, a new non-overlapping location will be automatically assigned. The final position of the display after a move can be verified using the coords message.

reset

Return displays to their snapshot state (see the snapshot method). Note that reset does not have any affect on video mirroring settings, which must be maintained manually.

setmode

Arguments

display-index [int]
mode-index [int]
Change the display mode. The two arguments specify the display index, and the mode index (derived from the getmode message).

snapshot

Saves the current display mode (on all active displays) for use with the reset and resetmode messages. A snapshot is automatically taken when the object is instantiated.

unmirror

Arguments

display-index [int]
Macintosh only
Disables video mirroring on the specified display.

See Also

Name Description
jit.desktop Copy the display into a matrix
screensize Output the monitor size
Tutorial 38: Basic Performance Setup Tutorial 38: Basic Performance Setup