##### pygame-ce documentation

Pygame-ce Home || Help Contents || Reference Index

Most useful stuff: Color | display | draw | event | font | image | key | locals | mixer | mouse | Rect | Surface | time | music | pygame

Advanced stuff: cursors | joystick | mask | sprite | transform | BufferProxy | freetype | gfxdraw | midi | PixelArray | pixelcopy | sndarray | surfarray | math

Other: camera | controller | examples | scrap | system | tests | touch | typing | version | Window

pygame.Color
  Pygame object for color representations.
  Color(r, g, b, a=255) -> Color
  Color(rgbvalue) -> Color

  The `Color` class represents `RGBA` color values using a value range of 0 to 255 inclusive. It allows basic arithmetic operations — binary operations `+`, `-`, `*`, `//`, `%`, and unary operation `~`— 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 (fully opaque) when not given. The arithmetic operations and `correct_gamma()` method preserve subclasses. For the binary operators, the class of the returned color is that of the left hand color object of the operator.

  Color objects support swizzling for their `RGBA` attributes, which allows the creation of new color objects with the corresponding swizzled attributes as its `RGBA` attributes. For example, `color.bgra` provides a shortcut to doing `Color(color.b, color.g, color.r, color.a)`. Swizzling with other than 4 attributes will return a tuple consisting of the corresponding elements instead of a color object.

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

  Color objects export the C level array interface. The interface exports a read-only one dimensional unsigned byte array of the same assigned length as the color. The new buffer interface is also exported, with the same characteristics as the array interface.

  The floor division, `//`, and modulus, `%`, operators do not raise an exception for division by zero. Instead, if a color, or alpha, channel in the right hand color is 0, then the result is 0. For example:

      # These expressions are True
      Color(255, 255, 255, 255) // Color(0, 64, 64, 64) == Color(0, 3, 3, 3)
      Color(255, 255, 255, 255) % Color(64, 64, 64, 0) == Color(63, 63, 63, 0)

  Use `int(color)` to return the immutable integer value of the color, usable as a `dict` key. This integer value differs from the mapped pixel values of `pygame.Surface.get_at_mapped()`Get the mapped color value at a single pixel., `pygame.Surface.map_rgb()`Convert a color into a mapped color value. and `pygame.Surface.unmap_rgb()`Convert a mapped integer color value into a Color.. It can be passed as a `color_value` argument to `Color` (useful with sets).

  See Named Colors for samples of the available named colors.

  Parameters:

    - r (int) -- red value in the range of 0 to 255 inclusive

    - g (int) -- green value in the range of 0 to 255 inclusive

    - b (int) -- blue value in the range of 0 to 255 inclusive

    - a (int) -- (optional) alpha value in the range of 0 to 255 inclusive, default is 255

    - color_value (Color or str or int or tuple(int, int, int, [int]) or list(int, int, int, [int])) --

      color value (see note below for the supported formats)

      Note

      Supported `color_value` formats:

      - Color object: clones the given `Color` object
      - Color name: str: name of the color to use, e.g. `'red'` (all the supported name strings can be found in the Named Colors, with sample swatches)
      - HTML color format str: `'#rrggbbaa'` or `'#rrggbb'`, where rr, gg, bb, and aa are 2-digit hex numbers in the range of 0 to 0xFF inclusive, the aa (alpha) value defaults to 0xFF if not provided
      - hex number str: `'0xrrggbbaa'` or `'0xrrggbb'`, where rr, gg, bb, and aa are 2-digit hex numbers in the range of 0x00 to 0xFF inclusive, the aa (alpha) value defaults to 0xFF if not provided
      - int: int value of the color to use, using hex numbers can make this parameter more readable, e.g. `0xrrggbbaa`, where rr, gg, bb, and aa are 2-digit hex numbers in the range of 0x00 to 0xFF inclusive, note that the aa (alpha) value is not optional for the int format and must be provided
      - tuple/list of int color values: `(R, G, B, A)` or `(R, G, B)`, where R, G, B, and A are int values in the range of 0 to 255 inclusive, the A (alpha) value defaults to 255 if not provided
  Returns:

    a newly created `Color` object

  Return type:

    Color

  Changed in pygame-ce 2.5.6: `bytes(Color(...))` (assuming bytes is the built-in type) now returns a `bytes` object (of length 4) with the RGBA values of the color, as opposed to `Color` being interpreted as an integer (think `int(Color(...))`) causing it to return a `bytes` object filled with 0s the length of said integer.

  Changed in pygame 2.0.0: Support for tuples, lists, and `Color` objects when creating `Color` objects.

  Changed in pygame 1.9.2: Color objects export the C level array interface.

  Changed in pygame 1.9.0: Color objects support 4-element tuples of integers.

  Changed in pygame 1.8.1: New implementation of the class.

  r: int
    Gets or sets the red value of the Color.
    r -> int

    The red value of the Color.

  g: int
    Gets or sets the green value of the Color.
    g -> int

    The green value of the Color.

  b: int
    Gets or sets the blue value of the Color.
    b -> int

    The blue value of the Color.

  a: int
    Gets or sets the alpha value of the Color.
    a -> int

    The alpha value of the Color.

  cmy: tuple[float, float, float]
    Gets or sets the CMY representation of the Color.
    cmy -> tuple[float, float, float]

    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: tuple[float, float, float, float]
    Gets or sets the HSVA representation of the Color.
    hsva -> tuple[float, float, float, float]

    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: tuple[float, float, float, float]
    Gets or sets the HSLA representation of the Color.
    hsla -> tuple[float, float, float, float]

    The `HSLA` representation of the Color. The `HSLA` components are in the ranges `H` = [0, 360], `S` = [0, 100], `L` = [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: tuple[float, float, float]
    Gets or sets the I1I2I3 representation of the Color.
    i1i2i3 -> tuple[float, float, float]

    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.

  normalized: tuple[float, float, float, float]
    Gets or sets the normalized representation of the Color.
    normalized -> tuple[float, float, float, float]

    The `Normalized` representation of the Color. The components of the `Normalized` representation represent the basic `RGBA` values but normalized the ranges of the values are `r` = [0, 1], `g` = [0, 1], `b` = [0, 1] and `a` = [0, 1] respectively. Note that this will not return the absolutely exact `Normalized` values for the set `RGBA` values in all cases. Due to the `RGB` mapping from 0-255 and the `Normalized` mapping from 0-1 rounding errors may cause the `Normalized` values to differ slightly from what you might expect.

    New in pygame-ce 2.5.0.

  hex: str
    Gets or sets the stringified hexadecimal representation of the Color.
    hex -> str

    The stringified hexadecimal representation of the Color. The hexadecimal string is formatted as `"#rrggbbaa"` where rr, gg, bb, and aa are two digit hex numbers in the range from 0x00 to 0xff.

    Setting this property means changing the color channels in place. Both lowercase and uppercase letters are allowed, the alpha can be omitted (defaults to 0xff) and the string can start with either `#` or `0x`.

    New in pygame-ce 2.5.4.

  classmethod from_cmy()
    Returns a Color object from a CMY representation.
    from_cmy(object, /) -> Color
    from_cmy(c, m, y, /) -> Color

    Creates a Color object from the given CMY components. Refer to `Color.cmy` for more information.

    New in pygame-ce 2.3.1.

  classmethod from_hsva()
    Returns a Color object from an HSVA representation.
    from_hsva(object, /) -> Color
    from_hsva(h, s, v, a, /) -> Color

    Creates a Color object from the given HSVA components. Refer to `Color.hsva` for more information.

    New in pygame-ce 2.3.1.

  classmethod from_hsla()
    Returns a Color object from an HSLA representation.
    from_hsla(object, /) -> Color
    from_hsla(h, s, l, a, /) -> Color

    Creates a Color object from the given HSLA components. Refer to `Color.hsla` for more information.

    New in pygame-ce 2.3.1.

  classmethod from_i1i2i3()
    Returns a Color object from a I1I2I3 representation.
    from_i1i2i3(object, /) -> Color
    from_i1i2i3(i1, i2, i3, /) -> Color

    Creates a Color object from the given I1I2I3 components. Refer to `Color.i1i2i3` for more information.

    New in pygame-ce 2.3.1.

  classmethod from_normalized()
    Returns a Color object from a Normalized representation.
    from_normalized(object, /) -> Color
    from_normalized(r, g, b, a, /) -> Color

    Creates a Color object from the given Normalized components. Refer to `Color.normalized` for more information.

    New in pygame-ce 2.5.0.

  classmethod from_hex()
    Returns a Color object from a Hexadecimal representation.
    from_hex(hex, /) -> Color

    Creates a Color object from the given Hexadecimal components. Refer to `Color.hex` for more information.

    New in pygame-ce 2.5.6.

  normalize()
    Returns the normalized RGBA values of the Color.
    normalize() -> tuple[float, float, float, float]

    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(length, /) -> None

    DEPRECATED: You may unpack the values you need like so, `r, g, b, _ = pygame.Color(100, 100, 100)` If you only want r, g and b Or `r, g, *_ = pygame.Color(100, 100, 100)` if you only want r and g

    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)`.

    Deprecated since pygame-ce 2.1.3.

    New in pygame 1.9.0.

  grayscale()
    Returns the grayscale of a Color.
    grayscale() -> Color

    Returns a new Color object which represents the grayscaled version of self, using the luminosity formula, which weights red, green, and blue according to their relative contribution to perceived brightness.

    New in pygame-ce 2.1.4.

  lerp()
    Returns a linear interpolation to the given Color.
    lerp(color, amount) -> Color

    Returns a Color which is a linear interpolation between self and the given Color in RGBA space. The second parameter determines how far between self and other the result is going to be. It must be a value between 0 and 1 where 0 means self and 1 means other will be returned.

    New in pygame 2.0.1.

  premul_alpha()
    Returns a Color where the r,g,b components have been multiplied by the alpha.
    premul_alpha() -> Color

    Returns a new Color where each of the red, green and blue color channels have been multiplied by the alpha channel of the original color. The alpha channel remains unchanged.

    This is useful when working with the `BLEND_PREMULTIPLIED` blending mode flag for `pygame.Surface.blit()`Draw another Surface onto this one., which assumes that all surfaces using it are using pre-multiplied alpha colors.

    New in pygame 2.0.0.

  update()
    Sets the elements of the color.
    update(r, g, b, a=255, /) -> None
    update(rgbvalue, /) -> None

    Sets the elements of the color. See parameters for `pygame.Color()`Pygame object for color representations. for the parameters of this function. If the alpha value was not set it will not change.

    New in pygame 2.0.1.

Edit on GitHub