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

copy ()

equal (p2)

free ()

hash ()

is_clear ()

is_opaque ()

parse (spec)

to_string ()

Details

class Gdk.RGBA

A GdkRGBA is used to represent a color, in a way that is compatible with cairo’s notion of color.

GdkRGBA is a convenient way to pass colors around. It’s based on cairo’s way to deal with colors and mirrors its behavior. All values are in the range from 0.0 to 1.0 inclusive. So the color (0.0, 0.0, 0.0, 0.0) represents transparent black and (1.0, 1.0, 1.0, 1.0) is opaque white. Other values will be clamped to this range when drawing.

copy()[source]
Returns:

A newly allocated GdkRGBA, with the same contents as self

Return type:

Gdk.RGBA

Makes a copy of a GdkRGBA.

The result must be freed through [method`Gdk`.RGBA.free].

equal(p2)[source]
Parameters:

p2 (Gdk.RGBA) – another GdkRGBA

Returns:

True if the two colors compare equal

Return type:

bool

Compares two GdkRGBA colors.

free()[source]

Frees a GdkRGBA.

hash()[source]
Returns:

The hash value for self

Return type:

int

A hash function suitable for using for a hash table that stores ``GdkRGBA``s.

is_clear()[source]
Returns:

True if the self is clear

Return type:

bool

Checks if an self value is transparent.

That is, drawing with the value would not produce any change.

is_opaque()[source]
Returns:

True if the self is opaque

Return type:

bool

Checks if an self value is opaque.

That is, drawing with the value will not retain any results from previous contents.

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.

The string can be either one of:

  • A standard name (Taken from the CSS specification).

  • A hexadecimal value in the form “\#rgb”, “\#rrggbb”, “\#rrrgggbbb” or ”\#rrrrggggbbbb”

  • A hexadecimal value in the form “\#rgba”, “\#rrggbbaa”, or ”\#rrrrggggbbbbaaaa”

  • 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)”

  • A HSL color in the form “hsl(hue, saturation, lightness)”

  • A HSLA color in the form “hsla(hue, saturation, lightness, alpha)”

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.

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 [method`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.