Color

class wpiutil.Color(*args, **kwargs)

Bases: pybind11_object

Represents colors that can be used with Addressable LEDs.

Limited to 12 bits of precision.

Overloaded function.

  1. __init__(self: wpiutil._wpiutil.Color) -> None

Constructs a default color (black).

  1. __init__(self: wpiutil._wpiutil.Color, red: typing.SupportsFloat | typing.SupportsIndex, green: typing.SupportsFloat | typing.SupportsIndex, blue: typing.SupportsFloat | typing.SupportsIndex) -> None

Constructs a Color from doubles (0-1).

Parameters:
  • red – Red value (0-1)

  • green – Green value (0-1)

  • blue – Blue value (0-1)

  1. __init__(self: wpiutil._wpiutil.Color, r: typing.SupportsInt | typing.SupportsIndex, g: typing.SupportsInt | typing.SupportsIndex, b: typing.SupportsInt | typing.SupportsIndex) -> None

Constructs a Color from ints (0-255).

Parameters:
  • r – Red value (0-255)

  • g – Green value (0-255)

  • b – Blue value (0-255)

ALICE_BLUE = Color(red=0.941406, green=0.972656, blue=1.000000)
ANTIQUE_WHITE = Color(red=0.980469, green=0.921631, blue=0.843262)
AQUA = Color(red=0.000000, green=1.000000, blue=1.000000)
AQUAMARINE = Color(red=0.498047, green=1.000000, blue=0.831543)
AZURE = Color(red=0.941406, green=1.000000, blue=1.000000)
BEIGE = Color(red=0.960938, green=0.960938, blue=0.862793)
BISQUE = Color(red=1.000000, green=0.894287, blue=0.768799)
BLACK = Color(red=0.000000, green=0.000000, blue=0.000000)
BLANCHED_ALMOND = Color(red=1.000000, green=0.921631, blue=0.803955)
BLUE = Color(red=0.000000, green=0.000000, blue=1.000000)
BLUE_VIOLET = Color(red=0.541260, green=0.168701, blue=0.886475)
BROWN = Color(red=0.647217, green=0.164795, blue=0.164795)
BURLYWOOD = Color(red=0.870605, green=0.721680, blue=0.529541)
CADET_BLUE = Color(red=0.372559, green=0.619629, blue=0.627686)
CHARTREUSE = Color(red=0.498047, green=1.000000, blue=0.000000)
CHOCOLATE = Color(red=0.823730, green=0.411865, blue=0.117676)
CORAL = Color(red=1.000000, green=0.498047, blue=0.313965)
CORNFLOWER_BLUE = Color(red=0.392334, green=0.584473, blue=0.929443)
CORNSILK = Color(red=1.000000, green=0.972656, blue=0.862793)
CRIMSON = Color(red=0.862793, green=0.078613, blue=0.235352)
CYAN = Color(red=0.000000, green=1.000000, blue=1.000000)
DARK_BLUE = Color(red=0.000000, green=0.000000, blue=0.545166)
DARK_CYAN = Color(red=0.000000, green=0.545166, blue=0.545166)
DARK_GOLDENROD = Color(red=0.721680, green=0.525635, blue=0.043213)
DARK_GRAY = Color(red=0.662842, green=0.662842, blue=0.662842)
DARK_GREEN = Color(red=0.000000, green=0.392334, blue=0.000000)
DARK_KHAKI = Color(red=0.741211, green=0.717773, blue=0.419678)
DARK_MAGENTA = Color(red=0.545166, green=0.000000, blue=0.545166)
DARK_OLIVE_GREEN = Color(red=0.333496, green=0.419678, blue=0.184326)
DARK_ORANGE = Color(red=1.000000, green=0.549072, blue=0.000000)
DARK_ORCHID = Color(red=0.600098, green=0.196289, blue=0.800049)
DARK_RED = Color(red=0.545166, green=0.000000, blue=0.000000)
DARK_SALMON = Color(red=0.913818, green=0.588379, blue=0.478516)
DARK_SEA_GREEN = Color(red=0.560791, green=0.737305, blue=0.560791)
DARK_SLATE_BLUE = Color(red=0.282471, green=0.239258, blue=0.545166)
DARK_SLATE_GRAY = Color(red=0.184326, green=0.309814, blue=0.309814)
DARK_TURQUOISE = Color(red=0.000000, green=0.807861, blue=0.819824)
DARK_VIOLET = Color(red=0.580566, green=0.000000, blue=0.827637)
DEEP_PINK = Color(red=1.000000, green=0.078613, blue=0.576660)
DEEP_SKY_BLUE = Color(red=0.000000, green=0.749023, blue=1.000000)
DENIM = Color(red=0.082520, green=0.376709, blue=0.741211)
DIM_GRAY = Color(red=0.411865, green=0.411865, blue=0.411865)
DODGER_BLUE = Color(red=0.117676, green=0.564941, blue=1.000000)
FIREBRICK = Color(red=0.698242, green=0.133545, blue=0.133545)
FIRST_BLUE = Color(red=0.000000, green=0.400146, blue=0.702148)
FIRST_RED = Color(red=0.929443, green=0.109863, blue=0.141357)
FLORAL_WHITE = Color(red=1.000000, green=0.980469, blue=0.941406)
FOREST_GREEN = Color(red=0.133545, green=0.545166, blue=0.133545)
FUCHSIA = Color(red=1.000000, green=0.000000, blue=1.000000)
GAINSBORO = Color(red=0.862793, green=0.862793, blue=0.862793)
GHOST_WHITE = Color(red=0.972656, green=0.972656, blue=1.000000)
GOLD = Color(red=1.000000, green=0.843262, blue=0.000000)
GOLDENROD = Color(red=0.854980, green=0.647217, blue=0.125732)
GRAY = Color(red=0.502197, green=0.502197, blue=0.502197)
GREEN = Color(red=0.000000, green=0.502197, blue=0.000000)
GREEN_YELLOW = Color(red=0.678467, green=1.000000, blue=0.184326)
HONEYDEW = Color(red=0.941406, green=1.000000, blue=0.941406)
HOT_PINK = Color(red=1.000000, green=0.411865, blue=0.706055)
INDIAN_RED = Color(red=0.803955, green=0.360840, blue=0.360840)
INDIGO = Color(red=0.294189, green=0.000000, blue=0.510010)
IVORY = Color(red=1.000000, green=1.000000, blue=0.941406)
KHAKI = Color(red=0.941406, green=0.902100, blue=0.549072)
LAVENDER = Color(red=0.902100, green=0.902100, blue=0.980469)
LAVENDER_BLUSH = Color(red=1.000000, green=0.941406, blue=0.960938)
LAWN_GREEN = Color(red=0.486328, green=0.988281, blue=0.000000)
LEMON_CHIFFON = Color(red=1.000000, green=0.980469, blue=0.803955)
LIGHT_BLUE = Color(red=0.678467, green=0.847168, blue=0.902100)
LIGHT_CORAL = Color(red=0.941406, green=0.502197, blue=0.502197)
LIGHT_CYAN = Color(red=0.878662, green=1.000000, blue=1.000000)
LIGHT_GOLDENROD_YELLOW = Color(red=0.980469, green=0.980469, blue=0.823730)
LIGHT_GRAY = Color(red=0.827637, green=0.827637, blue=0.827637)
LIGHT_GREEN = Color(red=0.564941, green=0.933350, blue=0.564941)
LIGHT_PINK = Color(red=1.000000, green=0.713867, blue=0.757080)
LIGHT_SALMON = Color(red=1.000000, green=0.627686, blue=0.478516)
LIGHT_SEA_GREEN = Color(red=0.125732, green=0.698242, blue=0.666748)
LIGHT_SKY_BLUE = Color(red=0.529541, green=0.807861, blue=0.980469)
LIGHT_SLATE_GRAY = Color(red=0.466797, green=0.533447, blue=0.600098)
LIGHT_STEEL_BLUE = Color(red=0.690430, green=0.768799, blue=0.870605)
LIGHT_YELLOW = Color(red=1.000000, green=1.000000, blue=0.878662)
LIME = Color(red=0.000000, green=1.000000, blue=0.000000)
LIME_GREEN = Color(red=0.196289, green=0.803955, blue=0.196289)
LINEN = Color(red=0.980469, green=0.941406, blue=0.902100)
MAGENTA = Color(red=1.000000, green=0.000000, blue=1.000000)
MAROON = Color(red=0.502197, green=0.000000, blue=0.000000)
MEDIUM_AQUAMARINE = Color(red=0.400146, green=0.803955, blue=0.666748)
MEDIUM_BLUE = Color(red=0.000000, green=0.000000, blue=0.803955)
MEDIUM_ORCHID = Color(red=0.729492, green=0.333496, blue=0.827637)
MEDIUM_PURPLE = Color(red=0.576660, green=0.439453, blue=0.858887)
MEDIUM_SEA_GREEN = Color(red=0.235352, green=0.702148, blue=0.443359)
MEDIUM_SLATE_BLUE = Color(red=0.482422, green=0.407959, blue=0.933350)
MEDIUM_SPRING_GREEN = Color(red=0.000000, green=0.980469, blue=0.604004)
MEDIUM_TURQUOISE = Color(red=0.282471, green=0.819824, blue=0.800049)
MEDIUM_VIOLET_RED = Color(red=0.780518, green=0.082520, blue=0.521729)
MIDNIGHT_BLUE = Color(red=0.098145, green=0.098145, blue=0.439453)
MINTCREAM = Color(red=0.960938, green=1.000000, blue=0.980469)
MISTY_ROSE = Color(red=1.000000, green=0.894287, blue=0.882568)
MOCCASIN = Color(red=1.000000, green=0.894287, blue=0.709961)
NAVAJO_WHITE = Color(red=1.000000, green=0.870605, blue=0.678467)
NAVY = Color(red=0.000000, green=0.000000, blue=0.502197)
OLD_LACE = Color(red=0.992188, green=0.960938, blue=0.902100)
OLIVE = Color(red=0.502197, green=0.502197, blue=0.000000)
OLIVE_DRAB = Color(red=0.419678, green=0.556885, blue=0.137451)
ORANGE = Color(red=1.000000, green=0.647217, blue=0.000000)
ORANGE_RED = Color(red=1.000000, green=0.270752, blue=0.000000)
ORCHID = Color(red=0.854980, green=0.439453, blue=0.839355)
PALE_GOLDENROD = Color(red=0.933350, green=0.909912, blue=0.666748)
PALE_GREEN = Color(red=0.596191, green=0.984375, blue=0.596191)
PALE_TURQUOISE = Color(red=0.686279, green=0.933350, blue=0.933350)
PALE_VIOLET_RED = Color(red=0.858887, green=0.439453, blue=0.576660)
PAPAYA_WHIP = Color(red=1.000000, green=0.937256, blue=0.835449)
PEACH_PUFF = Color(red=1.000000, green=0.854980, blue=0.725586)
PERU = Color(red=0.803955, green=0.521729, blue=0.247070)
PINK = Color(red=1.000000, green=0.753174, blue=0.796143)
PLUM = Color(red=0.866699, green=0.627686, blue=0.866699)
POWDER_BLUE = Color(red=0.690430, green=0.878662, blue=0.902100)
PURPLE = Color(red=0.502197, green=0.000000, blue=0.502197)
RED = Color(red=1.000000, green=0.000000, blue=0.000000)
ROSY_BROWN = Color(red=0.737305, green=0.560791, blue=0.560791)
ROYAL_BLUE = Color(red=0.255127, green=0.411865, blue=0.882568)
SADDLE_BROWN = Color(red=0.545166, green=0.270752, blue=0.074707)
SALMON = Color(red=0.980469, green=0.502197, blue=0.447266)
SANDY_BROWN = Color(red=0.957031, green=0.643311, blue=0.376709)
SEASHELL = Color(red=1.000000, green=0.960938, blue=0.933350)
SEA_GREEN = Color(red=0.180420, green=0.545166, blue=0.341309)
SIENNA = Color(red=0.627686, green=0.321777, blue=0.176514)
SILVER = Color(red=0.753174, green=0.753174, blue=0.753174)
SKY_BLUE = Color(red=0.529541, green=0.807861, blue=0.921631)
SLATE_BLUE = Color(red=0.415771, green=0.353027, blue=0.803955)
SLATE_GRAY = Color(red=0.439453, green=0.502197, blue=0.564941)
SNOW = Color(red=1.000000, green=0.980469, blue=0.980469)
SPRING_GREEN = Color(red=0.000000, green=1.000000, blue=0.498047)
STEEL_BLUE = Color(red=0.274658, green=0.510010, blue=0.706055)
TAN = Color(red=0.823730, green=0.706055, blue=0.549072)
TEAL = Color(red=0.000000, green=0.502197, blue=0.502197)
THISTLE = Color(red=0.847168, green=0.749023, blue=0.847168)
TOMATO = Color(red=1.000000, green=0.388428, blue=0.278564)
TURQUOISE = Color(red=0.251221, green=0.878662, blue=0.815918)
VIOLET = Color(red=0.933350, green=0.510010, blue=0.933350)
WHEAT = Color(red=0.960938, green=0.870605, blue=0.702148)
WHITE = Color(red=1.000000, green=1.000000, blue=1.000000)
WHITE_SMOKE = Color(red=0.960938, green=0.960938, blue=0.960938)
YELLOW = Color(red=1.000000, green=1.000000, blue=0.000000)
YELLOW_GREEN = Color(red=0.604004, green=0.803955, blue=0.196289)
static fromHSV(h: SupportsInt | SupportsIndex, s: SupportsInt | SupportsIndex, v: SupportsInt | SupportsIndex) wpiutil._wpiutil.Color

Creates a Color from HSV values.

Parameters:
  • h – The h value [0-180)

  • s – The s value [0-255]

  • v – The v value [0-255]

Returns:

The color

static fromString(str: str) wpiutil._wpiutil.Color

Makes a Color from a string.

Parameters:

str – a string of the format #RRGGBB or rgb(R, G, B)

Returns:

the Color @throws std::invalid_argument if the hex string is invalid.

hexString() str

Return this color represented as a hex string.

Returns:

a string of the format <tt>#RRGGBB</tt>