:right-sidebar: True

RGBA
===================================================================

.. currentmodule:: gi.repository.Gdk





.. class:: RGBA(red=1.0, green=1.0, blue=1.0, alpha=1.0)
   :no-contents-entry:






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.




Methods
-------

.. rst-class:: interim-class

.. class:: RGBA
   :no-index:


   .. method:: equal(p2: ~gi.repository.Gdk.RGBA) -> bool

      Compares two ``GdkRGBA`` colors.






      :param p2: another ``GdkRGBA``




   .. method:: free() -> None

      Frees a ``GdkRGBA``\.









   .. method:: hash() -> int

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









   .. method:: is_clear() -> bool

      Checks if an ``rgba`` value is transparent.

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









   .. method:: is_opaque() -> bool

      Checks if an ``rgba`` value is opaque.

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









   .. method:: parse(spec: str) -> 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.






      :param spec: the string specifying the color




   .. method:: to_string() -> str

      Returns a textual specification of ``rgba`` 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 :obj:`~gi.repository.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.



















Fields
------

.. rst-class:: interim-class

.. class:: RGBA
   :no-index:
   

   .. attribute:: alpha

      The opacity of the color from 0.0 for completely translucent to
        1.0 for opaque






   .. attribute:: blue

      The intensity of the blue channel from 0.0 to 1.0 inclusive






   .. attribute:: green

      The intensity of the green channel from 0.0 to 1.0 inclusive






   .. attribute:: red

      The intensity of the red channel from 0.0 to 1.0 inclusive