Skip to content

Color

Represent a color as red, green, and blue components, with optional transparency.

Use red, green, and blue to build a color directly. Leave any of the three out and a color-selection dialog opens for you to pick one instead.

Ready-made constants are also available:

Color.BLACK,  Color.BLUE,   Color.CYAN,       Color.DARK_GRAY,
Color.GRAY,   Color.GREEN,  Color.LIGHT_GRAY, Color.MAGENTA,
Color.ORANGE, Color.PINK,   Color.PURPLE,     Color.RED,
Color.WHITE,  Color.YELLOW, Color.CLEAR

All GUI Shapes and many other GUI objects use functions like setColor() and getColor() with Color objects.

Creating a Color

You can create a Color using the following functions:

Color()
Color(red, green, blue)
Color(red, green, blue, alpha)
Parameter Type Default Description
red int None The red component, from 0 to 255. If omitted, a color-selection dialog opens.
green int None The green component, from 0 to 255. If omitted, a color-selection dialog opens.
blue int None The blue component, from 0 to 255. If omitted, a color-selection dialog opens.
alpha int 255 The opacity, from 0 (fully transparent) to 255 (fully opaque).

For example,

color1 = Color(255, 255, 255)        # same as Color.WHITE
color2 = Color(255, 255, 255, 150)   # same as Color.WHITE, but semi-transparent

Functions

Once a Color color has been created, the following functions are available:

Function Description
color.getRed() Return the red component of the color.
color.getGreen() Return the green component of the color.
color.getBlue() Return the blue component of the color.
color.getAlpha() Return the alpha (transparency) component of the color.
color.getRGB() Return the color's red, green, and blue components together.
color.getRGBA() Return the color's red, green, blue, and alpha components together.
color.setRed(red) Set the red component of the color.
color.setGreen(green) Set the green component of the color.
color.setBlue(blue) Set the blue component of the color.
color.setAlpha(alpha) Set the alpha (transparency) component of the color.
color.brighter() Return a brighter version of the color.
color.darker() Return a darker version of the color.

Static Functions

Color has static functions as well - you don't need to create a Color object to use them. Call these functions on the class itself (for example, Color.gradient()).

Function Description
Color.select() Open a color-selection dialog and return the RGB values the user picks.
Color.gradient(startColor, endColor, steps) Create a smooth run of colors blending from one color to another.
Color.getHSBColor(hue, saturation, brightness) Create a Color from HSB (hue, saturation, brightness) values.
Color.HSBtoRGB(hue, saturation, brightness) Convert a color from HSB (hue, saturation, brightness) to RGB.
Color.RGBtoHSB(red, green, blue) Convert a color from RGB to HSB (hue, saturation, brightness).
Color.getHexColor(hex) Create a Color from a hex color string.
Color.HextoRGB(hex) Convert a hex color string to RGB.
Color.RGBtoHex(red, green, blue) Convert red, green, and blue values to a hex color string.