Gdk.RGBA

Fields

Name Type Access Description
alpha float r/w The opacity of the color from 0.0 for completely translucent to 1.0 for opaque
blue float r/w The intensity of the blue channel from 0.0 to 1.0 inclusive
green float r/w The intensity of the green channel from 0.0 to 1.0 inclusive
red float r/w The intensity of the red channel from 0.0 to 1.0 inclusive

Methods

class from_color (color)
  copy ()
  equal (p2)
  free ()
  hash ()
  parse (spec)
  to_color ()
  to_string ()

Details

class Gdk.RGBA(red=1.0, green=1.0, blue=1.0, alpha=1.0)

A Gdk.RGBA is used to represent a (possibly translucent) color, in a way that is compatible with cairo’s notion of color.

classmethod from_color(color)

Returns a new RGBA instance given a Color instance.

copy()[source]
Returns:A newly allocated Gdk.RGBA, with the same contents as self
Return type:Gdk.RGBA

Makes a copy of a Gdk.RGBA.

The result must be freed through Gdk.RGBA.free().

New in version 3.0.

equal(p2)[source]
Parameters:p2 (Gdk.RGBA) – another Gdk.RGBA pointer
Returns:True if the two colors compare equal
Return type:bool

Compares two RGBA colors.

New in version 3.0.

free()[source]

Frees a Gdk.RGBA created with Gdk.RGBA.copy()

New in version 3.0.

hash()[source]
Returns:The hash value for self
Return type:int

A hash function suitable for using for a hash table that stores Gdk.RGBAs.

New in version 3.0.

parse(spec)[source]
Parameters:spec (str) – the string specifying the color
Returns:True if the parsing succeeded
Return type:bool

Parses a textual representation of a color, filling in the red, green, blue and alpha fields of the self Gdk.RGBA.

The string can be either one of:

  • A standard name (Taken from the X11 rgb.txt file).
  • A hexadecimal value in the form “\#rgb”, “\#rrggbb”, “\#rrrgggbbb” or ”\#rrrrggggbbbb”
  • A RGB color in the form “rgb(r,g,b)” (In this case the color will have full opacity)
  • A RGBA color in the form “rgba(r,g,b,a)”

Where “r”, “g”, “b” and “a” are respectively the red, green, blue and alpha color values. In the last two cases, “r”, “g”, and “b” are either integers in the range 0 to 255 or percentage values in the range 0% to 100%, and a is a floating point value in the range 0 to 1.

New in version 3.0.

to_color()

Converts this RGBA into a Color instance which excludes alpha.

to_string()[source]
Returns:A newly allocated text string
Return type:str

Returns a textual specification of self in the form rgb(r,g,b) or rgba(r g,b,a), where “r”, “g”, “b” and “a” represent the red, green, blue and alpha values respectively. “r”, “g”, and “b” are represented as integers in the range 0 to 255, and “a” is represented as a floating point value in the range 0 to 1.

These string forms are string forms that are supported by the CSS3 colors module, and can be parsed by Gdk.RGBA.parse().

Note that this string representation may lose some precision, since “r”, “g” and “b” are represented as 8-bit integers. If this is a concern, you should use a different representation.

New in version 3.0.