bgcolor

Set background color

Description

Set the background color of the patcher window. The bgcolor object's functionality is equivalent to a brgb message sent to thispatcher.

Examples

Arguments

red [int]

Optional

A number in the range 0-255 sets the red value for the background color of the patcher.

green [int]

Optional

A number in the range 0-255 sets the green value for the background color of the patcher.

blue [int]

Optional

A number in the range 0-255 sets the blue value for the background color of the patcher.

Attributes

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

bang will reset the patcher's background to the RGB values most currently received by bgcolor.

int

Arguments

red [int]
A number in the range 0-255 sets the red value of the patcher background color.

  (inlet1)

Arguments

green [int]
A number in the range 0-255 sets the green value of the patcher background color.

  (inlet2)

Arguments

blue [int]
A number in the range 0-255 sets the blue value of the patcher background color.

list

Arguments

red [int]
green [int]
blue [int]
A list of three numbers in the range 0-255 sets the background color of the patcher in RGB format.

set

Arguments

red [int]
green [int]
blue [int]
The word set followed by a list of three numbers in the range 0-255 sets the background color of the patcher in RGB format.

Output

(Visual)

The background color of the patcher is set.

See Also

Name Description
thispatcher Send messages to a patcher