jit.fpsgui Reference

FPS meter

jit.fpsgui

Description

Reports timing and matrix information. Currently available reports: fps (frames per second), ms (milliseconds between incoming data), matrix type, dimensions, planecount, and name.

Examples

Arguments

None.

Attributes

bgcolor [4 floats]

Sets the RGBA values for the data background color of the jit.fpsgui object's display.

bgcolor2 [4 floats]

Sets the RGBA values for the mode background color of the jit.fpsgui object's display. The bgcolor2 attribute is mapped to the elementcolor style color.

dim [32 ints]

g/s(get)

Displays the current dimensions of the incoming matrices.

fps [float]

g/s(get)

Displays the current fps (frames per second) rate of the incoming matrices.

interval [int]

The sampling period, in milliseconds, used when calculating fps and ms (default = 100)

mode [int] (default: 0)

Sets the display mode (default = 0 (fps))
0 = fps
1 = ms
2 = matrix type
3 = matrix dimensions
4 = matrix planecount
5 = matrix name

Possible values:

0 = 'fps'
1 = 'ms'
2 = 'type'
3 = 'dim'
4 = 'planes'
5 = 'name'

ms [float]

g/s(get)

Displays the number of milliseconds elapsed between incoming data.

name [symbol]

g/s(get)

Displays the current name of the incoming matrices.

planecount [int]

g/s(get)

Displays the current planecount of the incoming matrices.

style [symbol] (default: )7.0.0

Sets the style to be applied to the object. Styles can be set using the Format palette.

textcolor [4 floats]

Sets the RGBA values for the data text color of the jit.fpsgui object's display. The textcolor attribute is mapped to the textcolor_inverse style color.

timeout [int]

The time interval, in milliseconds, after which the timer resets (default = 2000)

type [symbol]

g/s(get)

Displays the current data type of the incoming matrices.

usetimeout [int]

Sets the timeout flag (default = 1). When the flag is set, use of the timeout attribute is enabled.

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

anything

Arguments

any-message [list]
Any message sent to the object causes it to calculate fps and ms. The matrix attribute displays show n/a .

getstate

Sends a sequence of lists describing the incoming matrix's state out the object's right outlet, one line per attribute. Each line listing line takes the form attribute-name attribute-value1 attribute-value2 ... attribute-valueN .

jit_gl_texture

Arguments

name [symbol]
Causes the object to calculate fps and ms. The name attribute shows the texture name.

(mouse)

Clicking with the mouse lets you select the jit.fpsgui object's display mode.

See Also

Name Description
Working with Video in Jitter Working with Video in Jitter
jit.matrixinfo Report matrix planecount, type, dimensions