Package Jitter FX

jit.fx.bitcrush

Bitcrushes an incoming texture

Description

Applies bitcrushing to an incoming texture and reduces its color depth.

Attributes

bypass[int]

Bypass effect processing flag (default = 0). When enabled the input is passed through to the output without processing.

adapt[int]: 1

Adapt output dims to input (default = 1). When enabled the output dimensions will match the leftmost input dimensions.

color_levels[int]

The number of distinct color shades (default = 256).

dim[2 ints]

The output texture dimensions. When adapt is enabled this will be set automatically to the leftmost input.

dithering[int]

Select different dithering algorithms (default = none). These are used to soften the harsh edges of color quantization and reduce banding, resulting in a smoother image.
Possible dithering algorithms:
0 = Uniform
1 = Interleaved
Vlachos (col)
Vlachos TrianglePDF
Triangle Noise

OB3D Attributes

drawto[symbol]

The named drawing context in which to draw (default = none) A named drawing context is a named instance of a jit.window, jit.pwindow, or jit.matrix object that has an instance of the jit.gl.render object associated with it.

enable[int]

Enable flag (default = 1) When the flag is set, drawing is enabled.

Common Box Attributes

Below is a list of attributes shared by all objects. If you want to change one of these attributes for an object based on the object box, you need to place the word sendbox in front of the attribute name, or use the object's Inspector.

annotation[symbol]

Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.

background[int]: 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]: 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]: 0

Toggles whether an object ignores mouse clicks in a locked patcher.

jspainterfile[symbol]

You can override the default appearance of a user interface object by assigning a JavaScript file with code for painting the object. The file must be in the search path.

patching_rect[4 floats]: 0. 0. 100. 0.

Sets the position and size of the object in the patcher window.

position[2 floats]
write-only

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]: 0

Sets whether an object belongs to the patcher's presentation.

presentation_rect[4 floats]: 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]
write-only

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]
write-only

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

OB3D Messages

bang

Equivalent to the draw message.

draw

Draws the object in the named drawing destination. If the matrixoutput attribute is supported and set to 1, the geometry matrices are sent out the object's left outlet.

drawraw

Equivalent to draw with the inherit_all attribute set to 1.

drawimmediate

Equivalent to draw but ignoring any potential renderer setup

jit_gl_texture

Binds the texture specified by texture-name to this object. Equivalent to setting the texture attribute to texture-name .

Arguments:
  • texture-name [symbol]

See Also

Name Description
jit.fx.altern
jit.fx.ameba
jit.fx.bitcrush
jit.fx.blur
jit.fx.brass
jit.fx.brcosa
jit.fx.conway
jit.fx.delay
jit.fx.eclipse
jit.fx.grain
jit.fx.hue
jit.fx.pixelsorting
jit.fx.repos
jit.fx.rota
jit.fx.slide
jit.fx.sobel
jit.fx.threshold
jit.fx.wake