class pygame.Color

pygame object for color representations

Color(name) -> Color

Color(r, g, b, a) -> Color

Color(rgbvalue) -> Color

pygame.Color.r	—	Gets or sets the red value of the Color.
pygame.Color.g	—	Gets or sets the green value of the Color.
pygame.Color.b	—	Gets or sets the blue value of the Color.
pygame.Color.a	—	Gets or sets the alpha value of the Color.
pygame.Color.cmy	—	Gets or sets the CMY representation of the Color.
pygame.Color.hsva	—	Gets or sets the HSVA representation of the Color.
pygame.Color.hsla	—	Gets or sets the HSLA representation of the Color.
pygame.Color.i1i2i3	—	Gets or sets the I1I2I3 representation of the Color.
pygame.Color.normalize	—	Returns the normalized RGBA values of the Color.
pygame.Color.correct_gamma	—	Applies a certain gamma value to the Color.
pygame.Color.set_length	—	Set the number of elements in the Color to 1,2,3, or 4.

The Color class represents RGBA color values using a value range of 0-255. It allows basic arithmetic operations to create new colors, supports conversions to other color spaces such as HSV or HSL and lets you adjust single color channels. Alpha defaults to 255 when not given.

‘rgbvalue’ can be either a color name, an HTML color format string, a hex number string, or an integer pixel value. The HTML format is ‘#rrggbbaa’, where rr, gg, bb, and aa are 2 digit hex numbers. The alpha aa is optional. A hex number string has the form ‘0xrrggbbaa’, where aa is optional.

Color objects support equality comparison with other color objects and 3 or 4 element tuples of integers (New in 1.9.0). There was a bug in pygame 1.8.1 where the default alpha was 0, not 255 like previously.

New implementation of Color was done in pygame 1.8.1.

r

Gets or sets the red value of the Color.

r -> int

The red value of the Color.

g

Gets or sets the green value of the Color.

g -> int

The green value of the Color.

b

Gets or sets the blue value of the Color.

b -> int

The blue value of the Color.

a

Gets or sets the alpha value of the Color.

a -> int

The alpha value of the Color.

cmy

Gets or sets the CMY representation of the Color.

cmy -> tuple

The CMY representation of the Color. The CMY components are in the ranges C = [0, 1], M = [0, 1], Y = [0, 1]. Note that this will not return the absolutely exact CMY values for the set RGB values in all cases. Due to the RGB mapping from 0-255 and the CMY mapping from 0-1 rounding errors may cause the CMY values to differ slightly from what you might expect.

hsva

Gets or sets the HSVA representation of the Color.

hsva -> tuple

The HSVA representation of the Color. The HSVA components are in the ranges H = [0, 360], S = [0, 100], V = [0, 100], A = [0, 100]. Note that this will not return the absolutely exact HSV values for the set RGB values in all cases. Due to the RGB mapping from 0-255 and the HSV mapping from 0-100 and 0-360 rounding errors may cause the HSV values to differ slightly from what you might expect.

hsla

Gets or sets the HSLA representation of the Color.

hsla -> tuple

The HSLA representation of the Color. The HSLA components are in the ranges H = [0, 360], S = [0, 100], V = [0, 100], A = [0, 100]. Note that this will not return the absolutely exact HSL values for the set RGB values in all cases. Due to the RGB mapping from 0-255 and the HSL mapping from 0-100 and 0-360 rounding errors may cause the HSL values to differ slightly from what you might expect.

i1i2i3

Gets or sets the I1I2I3 representation of the Color.

i1i2i3 -> tuple

The I1I2I3 representation of the Color. The I1I2I3 components are in the ranges I1 = [0, 1], I2 = [-0.5, 0.5], I3 = [-0.5, 0.5]. Note that this will not return the absolutely exact I1I2I3 values for the set RGB values in all cases. Due to the RGB mapping from 0-255 and the I1I2I3 mapping from 0-1 rounding errors may cause the I1I2I3 values to differ slightly from what you might expect.

normalize()

Returns the normalized RGBA values of the Color.

normalize() -> tuple

Returns the normalized RGBA values of the Color as floating point values.

correct_gamma()

Applies a certain gamma value to the Color.

correct_gamma (gamma) -> Color

Applies a certain gamma value to the Color and returns a new Color with the adjusted RGBA values.

set_length()

Set the number of elements in the Color to 1,2,3, or 4.

set_length(len) -> None

The default Color length is 4. Colors can have lengths 1,2,3 or 4. This is useful if you want to unpack to r,g,b and not r,g,b,a. If you want to get the length of a Color do len(acolor).

New in pygame 1.9.0.