clutter/clutter-color.c

   1 /*
   2  * Clutter.
   3  *
   4  * An OpenGL based 'interactive canvas' library.
   5  *
   6  * Authored By Matthew Allum  <mallum@openedhand.com>
   7  *
   8  * Copyright (C) 2006 OpenedHand
   9  *
  10  * This library is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public
  12  * License as published by the Free Software Foundation; either
  13  * version 2 of the License, or (at your option) any later version.
  14  *
  15  * This library is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with this library. If not, see <http://www.gnu.org/licenses/>.
  22  */
  23
  24 /**
  25  * SECTION:clutter-color
  26  * @short_description: Color management and manipulation.
  27  *
  28  * #ClutterColor is a simple type for representing colors in Clutter.
  29  *
  30  * A #ClutterColor is expressed as a 4-tuple of values ranging from
  31  * zero to 255, one for each color channel plus one for the alpha.
  32  *
  33  * The alpha channel is fully opaque at 255 and fully transparent at 0.
  34  */
  35
  36 #ifdef HAVE_CONFIG_H
  37 #include "config.h"
  38 #endif
  39
  40 #include <math.h>
  41
  42 #include <pango/pango-attributes.h>
  43
  44 #include "clutter-interval.h"
  45 #include "clutter-main.h"
  46 #include "clutter-color.h"
  47 #include "clutter-private.h"
  48 #include "clutter-debug.h"
  49
  50 /**
  51  * clutter_color_add:
  52  * @a: a #ClutterColor
  53  * @b: a #ClutterColor
  54  * @result: (out caller-allocates): return location for the result
  55  *
  56  * Adds @a to @b and saves the resulting color inside @result.
  57  *
  58  * The alpha channel of @result is set as as the maximum value
  59  * between the alpha channels of @a and @b.
  60  */
  61 void
  62 clutter_color_add (const ClutterColor *a,
  63                    const ClutterColor *b,
  64                    ClutterColor       *result)
  65 {
  66   g_return_if_fail (a != NULL);
  67   g_return_if_fail (b != NULL);
  68   g_return_if_fail (result != NULL);
  69
  70   result->red   = CLAMP (a->red   + b->red,   0, 255);
  71   result->green = CLAMP (a->green + b->green, 0, 255);
  72   result->blue  = CLAMP (a->blue  + b->blue,  0, 255);
  73
  74   result->alpha = MAX (a->alpha, b->alpha);
  75 }
  76
  77 /**
  78  * clutter_color_subtract:
  79  * @a: a #ClutterColor
  80  * @b: a #ClutterColor
  81  * @result: (out caller-allocates): return location for the result
  82  *
  83  * Subtracts @b from @a and saves the resulting color inside @result.
  84  *
  85  * This function assumes that the components of @a are greater than the
  86  * components of @b; the result is, otherwise, undefined.
  87  *
  88  * The alpha channel of @result is set as the minimum value
  89  * between the alpha channels of @a and @b.
  90  */
  91 void
  92 clutter_color_subtract (const ClutterColor *a,
  93                         const ClutterColor *b,
  94                         ClutterColor       *result)
  95 {
  96   g_return_if_fail (a != NULL);
  97   g_return_if_fail (b != NULL);
  98   g_return_if_fail (result != NULL);
  99
 100   result->red   = CLAMP (a->red   - b->red,   0, 255);
 101   result->green = CLAMP (a->green - b->green, 0, 255);
 102   result->blue  = CLAMP (a->blue  - b->blue,  0, 255);
 103
 104   result->alpha = MIN (a->alpha, b->alpha);
 105 }
 106
 107 /**
 108  * clutter_color_lighten:
 109  * @color: a #ClutterColor
 110  * @result: (out caller-allocates): return location for the lighter color
 111  *
 112  * Lightens @color by a fixed amount, and saves the changed color
 113  * in @result.
 114  */
 115 void
 116 clutter_color_lighten (const ClutterColor *color,
 117                        ClutterColor       *result)
 118 {
 119   clutter_color_shade (color, 1.3, result);
 120 }
 121
 122 /**
 123  * clutter_color_darken:
 124  * @color: a #ClutterColor
 125  * @result: (out caller-allocates): return location for the darker color
 126  *
 127  * Darkens @color by a fixed amount, and saves the changed color
 128  * in @result.
 129  */
 130 void
 131 clutter_color_darken (const ClutterColor *color,
 132                       ClutterColor       *result)
 133 {
 134   clutter_color_shade (color, 0.7, result);
 135 }
 136
 137 /**
 138  * clutter_color_to_hls:
 139  * @color: a #ClutterColor
 140  * @hue: (out): return location for the hue value or %NULL
 141  * @luminance: (out): return location for the luminance value or %NULL
 142  * @saturation: (out): return location for the saturation value or %NULL
 143  *
 144  * Converts @color to the HLS format.
 145  *
 146  * The @hue value is in the 0 .. 360 range. The @luminance and
 147  * @saturation values are in the 0 .. 1 range.
 148  */
 149 void
 150 clutter_color_to_hls (const ClutterColor *color,
 151                       float              *hue,
 152                       float              *luminance,
 153                       float              *saturation)
 154 {
 155   float red, green, blue;
 156   float min, max, delta;
 157   float h, l, s;
 158
 159   g_return_if_fail (color != NULL);
 160
 161   red   = color->red / 255.0;
 162   green = color->green / 255.0;
 163   blue  = color->blue / 255.0;
 164
 165   if (red > green)
 166     {
 167       if (red > blue)
 168         max = red;
 169       else
 170         max = blue;
 171
 172       if (green < blue)
 173         min = green;
 174       else
 175         min = blue;
 176     }
 177   else
 178     {
 179       if (green > blue)
 180         max = green;
 181       else
 182         max = blue;
 183
 184       if (red < blue)
 185         min = red;
 186       else
 187         min = blue;
 188     }
 189
 190   l = (max + min) / 2;
 191   s = 0;
 192   h = 0;
 193
 194   if (max != min)
 195     {
 196       if (l <= 0.5)
 197         s = (max - min) / (max + min);
 198       else
 199         s = (max - min) / (2.0 - max - min);
 200
 201       delta = max - min;
 202
 203       if (red == max)
 204         h = (green - blue) / delta;
 205       else if (green == max)
 206         h = 2.0 + (blue - red) / delta;
 207       else if (blue == max)
 208         h = 4.0 + (red - green) / delta;
 209
 210       h *= 60;
 211
 212       if (h < 0)
 213         h += 360.0;
 214     }
 215
 216   if (hue)
 217     *hue = h;
 218
 219   if (luminance)
 220     *luminance = l;
 221
 222   if (saturation)
 223     *saturation = s;
 224 }
 225
 226 /**
 227  * clutter_color_from_hls:
 228  * @color: (out): return location for a #ClutterColor
 229  * @hue: hue value, in the 0 .. 360 range
 230  * @luminance: luminance value, in the 0 .. 1 range
 231  * @saturation: saturation value, in the 0 .. 1 range
 232  *
 233  * Converts a color expressed in HLS (hue, luminance and saturation)
 234  * values into a #ClutterColor.
 235  */
 236 void
 237 clutter_color_from_hls (ClutterColor *color,
 238                         float         hue,
 239                         float         luminance,
 240                         float         saturation)
 241 {
 242   float tmp1, tmp2;
 243   float tmp3[3];
 244   float clr[3];
 245   int   i;
 246
 247   hue /= 360.0;
 248
 249   if (saturation == 0)
 250     {
 251       color->red = color->green = color->blue = (luminance * 255);
 252
 253       return;
 254     }
 255
 256   if (luminance <= 0.5)
 257     tmp2 = luminance * (1.0 + saturation);
 258   else
 259     tmp2 = luminance + saturation - (luminance * saturation);
 260
 261   tmp1 = 2.0 * luminance - tmp2;
 262
 263   tmp3[0] = hue + 1.0 / 3.0;
 264   tmp3[1] = hue;
 265   tmp3[2] = hue - 1.0 / 3.0;
 266
 267   for (i = 0; i < 3; i++)
 268     {
 269       if (tmp3[i] < 0)
 270         tmp3[i] += 1.0;
 271
 272       if (tmp3[i] > 1)
 273         tmp3[i] -= 1.0;
 274
 275       if (6.0 * tmp3[i] < 1.0)
 276         clr[i] = tmp1 + (tmp2 - tmp1) * tmp3[i] * 6.0;
 277       else if (2.0 * tmp3[i] < 1.0)
 278         clr[i] = tmp2;
 279       else if (3.0 * tmp3[i] < 2.0)
 280         clr[i] = (tmp1 + (tmp2 - tmp1) * ((2.0 / 3.0) - tmp3[i]) * 6.0);
 281       else
 282         clr[i] = tmp1;
 283     }
 284
 285   color->red   = floorf (clr[0] * 255.0 + 0.5);
 286   color->green = floorf (clr[1] * 255.0 + 0.5);
 287   color->blue  = floorf (clr[2] * 255.0 + 0.5);
 288 }
 289
 290 /**
 291  * clutter_color_shade:
 292  * @color: a #ClutterColor
 293  * @factor: the shade factor to apply
 294  * @result: (out caller-allocates): return location for the shaded color
 295  *
 296  * Shades @color by @factor and saves the modified color into @result.
 297  */
 298 void
 299 clutter_color_shade (const ClutterColor *color,
 300                      gdouble             factor,
 301                      ClutterColor       *result)
 302 {
 303   float h, l, s;
 304
 305   g_return_if_fail (color != NULL);
 306   g_return_if_fail (result != NULL);
 307
 308   clutter_color_to_hls (color, &h, &l, &s);
 309
 310   l *= factor;
 311   if (l > 1.0)
 312     l = 1.0;
 313   else if (l < 0)
 314     l = 0;
 315
 316   s *= factor;
 317   if (s > 1.0)
 318     s = 1.0;
 319   else if (s < 0)
 320     s = 0;
 321
 322   clutter_color_from_hls (result, h, l, s);
 323
 324   result->alpha = color->alpha;
 325 }
 326
 327 /**
 328  * clutter_color_to_pixel:
 329  * @color: a #ClutterColor
 330  *
 331  * Converts @color into a packed 32 bit integer, containing
 332  * all the four 8 bit channels used by #ClutterColor.
 333  *
 334  * Return value: a packed color
 335  */
 336 guint32
 337 clutter_color_to_pixel (const ClutterColor *color)
 338 {
 339   g_return_val_if_fail (color != NULL, 0);
 340
 341   return (color->alpha       |
 342           color->blue  << 8  |
 343           color->green << 16 |
 344           color->red   << 24);
 345 }
 346
 347 /**
 348  * clutter_color_from_pixel:
 349  * @color: (out caller-allocates): return location for a #ClutterColor
 350  * @pixel: a 32 bit packed integer containing a color
 351  *
 352  * Converts @pixel from the packed representation of a four 8 bit channel
 353  * color to a #ClutterColor.
 354  */
 355 void
 356 clutter_color_from_pixel (ClutterColor *color,
 357                           guint32       pixel)
 358 {
 359   g_return_if_fail (color != NULL);
 360
 361   color->red   =  pixel >> 24;
 362   color->green = (pixel >> 16) & 0xff;
 363   color->blue  = (pixel >> 8)  & 0xff;
 364   color->alpha =  pixel        & 0xff;
 365 }
 366
 367 /**
 368  * clutter_color_from_string:
 369  * @color: (out caller-allocates): return location for a #ClutterColor
 370  * @str: a string specifiying a color (named color or #RRGGBBAA)
 371  *
 372  * Parses a string definition of a color, filling the
 373  * <structfield>red</structfield>, <structfield>green</structfield>,
 374  * <structfield>blue</structfield> and <structfield>alpha</structfield>
 375  * channels of @color. If alpha is not specified it will be set full opaque.
 376  *
 377  * The @color is not allocated.
 378  *
 379  * The color may be defined by any of the formats understood by
 380  * pango_color_from_string(); these include literal color names, like
 381  * <literal>Red</literal> or <literal>DarkSlateGray</literal>, or
 382  * hexadecimal specifications like <literal>&num;3050b2</literal> or
 383  * <literal>&num;333</literal>.
 384  *
 385  * Return value: %TRUE if parsing succeeded.
 386  *
 387  * Since: 1.0
 388  */
 389 gboolean
 390 clutter_color_from_string (ClutterColor *color,
 391                            const gchar  *str)
 392 {
 393   PangoColor pango_color = { 0, };
 394
 395   g_return_val_if_fail (color != NULL, FALSE);
 396   g_return_val_if_fail (str != NULL, FALSE);
 397
 398   /* if the string contains a color encoded using the hexadecimal
 399    * notations (#rrggbbaa or #rgba) we attempt a rough pass at
 400    * parsing the color ourselves, as we need the alpha channel that
 401    * Pango can't retrieve.
 402    */
 403   if (str[0] == '#')
 404     {
 405       gint32 result;
 406
 407       if (sscanf (str + 1, "%x", &result))
 408         {
 409           gsize length = strlen (str);
 410
 411           switch (length)
 412             {
 413             case 9: /* rrggbbaa */
 414               color->red   = (result >> 24) & 0xff;
 415               color->green = (result >> 16) & 0xff;
 416               color->blue  = (result >>  8) & 0xff;
 417
 418               color->alpha = result & 0xff;
 419
 420               return TRUE;
 421
 422             case 7: /* #rrggbb */
 423               color->red   = (result >> 16) & 0xff;
 424               color->green = (result >>  8) & 0xff;
 425               color->blue  = result & 0xff;
 426
 427               color->alpha = 0xff;
 428
 429               return TRUE;
 430
 431             case 5: /* #rgba */
 432               color->red   = ((result >> 12) & 0xf);
 433               color->green = ((result >>  8) & 0xf);
 434               color->blue  = ((result >>  4) & 0xf);
 435               color->alpha = result & 0xf;
 436
 437               color->red   = (color->red   << 4) | color->red;
 438               color->green = (color->green << 4) | color->green;
 439               color->blue  = (color->blue  << 4) | color->blue;
 440               color->alpha = (color->alpha << 4) | color->alpha;
 441
 442               return TRUE;
 443
 444             case 4: /* #rgb */
 445               color->red   = ((result >>  8) & 0xf);
 446               color->green = ((result >>  4) & 0xf);
 447               color->blue  = result & 0xf;
 448
 449               color->red   = (color->red   << 4) | color->red;
 450               color->green = (color->green << 4) | color->green;
 451               color->blue  = (color->blue  << 4) | color->blue;
 452
 453               color->alpha = 0xff;
 454
 455               return TRUE;
 456
 457             default:
 458               /* pass through to Pango */
 459               break;
 460             }
 461         }
 462     }
 463
 464   /* Fall back to pango for named colors */
 465   if (pango_color_parse (&pango_color, str))
 466     {
 467       color->red   = pango_color.red;
 468       color->green = pango_color.green;
 469       color->blue  = pango_color.blue;
 470
 471       color->alpha = 0xff;
 472
 473       return TRUE;
 474     }
 475
 476   return FALSE;
 477 }
 478
 479 /**
 480  * clutter_color_to_string:
 481  * @color: a #ClutterColor
 482  *
 483  * Returns a textual specification of @color in the hexadecimal form
 484  * <literal>&num;rrggbbaa</literal>, where <literal>r</literal>,
 485  * <literal>g</literal>, <literal>b</literal> and <literal>a</literal> are
 486  * hex digits representing the red, green, blue and alpha components
 487  * respectively.
 488  *
 489  * Return value: (transfer full): a newly-allocated text string
 490  *
 491  * Since: 0.2
 492  */
 493 gchar *
 494 clutter_color_to_string (const ClutterColor *color)
 495 {
 496   g_return_val_if_fail (color != NULL, NULL);
 497
 498   return g_strdup_printf ("#%02x%02x%02x%02x",
 499                           color->red,
 500                           color->green,
 501                           color->blue,
 502                           color->alpha);
 503 }
 504
 505 /**
 506  * clutter_color_equal:
 507  * @v1: a #ClutterColor
 508  * @v2: a #ClutterColor
 509  *
 510  * Compares two #ClutterColor<!-- -->s and checks if they are the same.
 511  *
 512  * This function can be passed to g_hash_table_new() as the @key_equal_func
 513  * parameter, when using #ClutterColor<!-- -->s as keys in a #GHashTable.
 514  *
 515  * Return value: %TRUE if the two colors are the same.
 516  *
 517  * Since: 0.2
 518  */
 519 gboolean
 520 clutter_color_equal (gconstpointer v1,
 521                      gconstpointer v2)
 522 {
 523   const ClutterColor *a, *b;
 524
 525   g_return_val_if_fail (v1 != NULL, FALSE);
 526   g_return_val_if_fail (v2 != NULL, FALSE);
 527
 528   if (v1 == v2)
 529     return TRUE;
 530
 531   a = v1;
 532   b = v2;
 533
 534   return (a->red   == b->red   &&
 535           a->green == b->green &&
 536           a->blue  == b->blue  &&
 537           a->alpha == b->alpha);
 538 }
 539
 540 /**
 541  * clutter_color_hash:
 542  * @v: a #ClutterColor
 543  *
 544  * Converts a #ClutterColor to a hash value.
 545  *
 546  * This function can be passed to g_hash_table_new() as the @hash_func
 547  * parameter, when using #ClutterColor<!-- -->s as keys in a #GHashTable.
 548  *
 549  * Return value: a hash value corresponding to the color
 550  *
 551  * Since: 1.0
 552  */
 553 guint
 554 clutter_color_hash (gconstpointer v)
 555 {
 556   return clutter_color_to_pixel ((const ClutterColor *) v);
 557 }
 558
 559 /**
 560  * clutter_color_interpolate:
 561  * @initial: the initial #ClutterColor
 562  * @final: the final #ClutterColor
 563  * @progress: the interpolation progress
 564  * @result: (out): return location for the interpolation
 565  *
 566  * Interpolates between @initial and @final #ClutterColor<!-- -->s
 567  * using @progress
 568  *
 569  * Since: 1.6
 570  */
 571 void
 572 clutter_color_interpolate (const ClutterColor *initial,
 573                            const ClutterColor *final,
 574                            gdouble             progress,
 575                            ClutterColor       *result)
 576 {
 577   g_return_if_fail (initial != NULL);
 578   g_return_if_fail (final != NULL);
 579   g_return_if_fail (result != NULL);
 580
 581   result->red   = initial->red   + (final->red   - initial->red)   * progress;
 582   result->green = initial->green + (final->green - initial->green) * progress;
 583   result->blue  = initial->blue  + (final->blue  - initial->blue)  * progress;
 584   result->alpha = initial->alpha + (final->alpha - initial->alpha) * progress;
 585 }
 586
 587 static gboolean
 588 clutter_color_progress (const GValue *a,
 589                         const GValue *b,
 590                         gdouble       progress,
 591                         GValue       *retval)
 592 {
 593   const ClutterColor *a_color = clutter_value_get_color (a);
 594   const ClutterColor *b_color = clutter_value_get_color (b);
 595   ClutterColor res = { 0, };
 596
 597   clutter_color_interpolate (a_color, b_color, progress, &res);
 598   clutter_value_set_color (retval, &res);
 599
 600   return TRUE;
 601 }
 602
 603 /**
 604  * clutter_color_copy:
 605  * @color: a #ClutterColor
 606  *
 607  * Makes a copy of the color structure.  The result must be
 608  * freed using clutter_color_free().
 609  *
 610  * Return value: (transfer full): an allocated copy of @color.
 611  *
 612  * Since: 0.2
 613  */
 614 ClutterColor *
 615 clutter_color_copy (const ClutterColor *color)
 616 {
 617   if (G_LIKELY (color != NULL))
 618     return g_slice_dup (ClutterColor, color);
 619
 620   return NULL;
 621 }
 622
 623 /**
 624  * clutter_color_free:
 625  * @color: a #ClutterColor
 626  *
 627  * Frees a color structure created with clutter_color_copy().
 628  *
 629  * Since: 0.2
 630  */
 631 void
 632 clutter_color_free (ClutterColor *color)
 633 {
 634   if (G_LIKELY (color != NULL))
 635     g_slice_free (ClutterColor, color);
 636 }
 637
 638 /**
 639  * clutter_color_new:
 640  * @red: red component of the color, between 0 and 255
 641  * @green: green component of the color, between 0 and 255
 642  * @blue: blue component of the color, between 0 and 255
 643  * @alpha: alpha component of the color, between 0 and 255
 644  *
 645  * Creates a new #ClutterColor with the given values.
 646  *
 647  * Return value: (transfer full): the newly allocated color.
 648  *   Use clutter_color_free() when done
 649  *
 650  * Since: 0.8.4
 651  */
 652 ClutterColor *
 653 clutter_color_new (guint8 red,
 654                    guint8 green,
 655                    guint8 blue,
 656                    guint8 alpha)
 657 {
 658   ClutterColor *color;
 659
 660   color = g_slice_new (ClutterColor);
 661
 662   color->red   = red;
 663   color->green = green;
 664   color->blue  = blue;
 665   color->alpha = alpha;
 666
 667   return color;
 668 }
 669
 670 static void
 671 clutter_value_transform_color_string (const GValue *src,
 672                                       GValue       *dest)
 673 {
 674   const ClutterColor *color = g_value_get_boxed (src);
 675
 676   if (color)
 677     {
 678       gchar *string = clutter_color_to_string (color);
 679
 680       g_value_take_string (dest, string);
 681     }
 682   else
 683     g_value_set_string (dest, NULL);
 684 }
 685
 686 static void
 687 clutter_value_transform_string_color (const GValue *src,
 688                                       GValue       *dest)
 689 {
 690   const char *str = g_value_get_string (src);
 691
 692   if (str)
 693     {
 694       ClutterColor color = { 0, };
 695
 696       clutter_color_from_string (&color, str);
 697
 698       clutter_value_set_color (dest, &color);
 699     }
 700   else
 701     clutter_value_set_color (dest, NULL);
 702 }
 703
 704 G_DEFINE_BOXED_TYPE_WITH_CODE (ClutterColor, clutter_color,
 705                                clutter_color_copy,
 706                                clutter_color_free,
 707                                CLUTTER_REGISTER_VALUE_TRANSFORM_TO (G_TYPE_STRING, clutter_value_transform_color_string)
 708                                CLUTTER_REGISTER_VALUE_TRANSFORM_FROM (G_TYPE_STRING, clutter_value_transform_string_color)
 709                                CLUTTER_REGISTER_INTERVAL_PROGRESS (clutter_color_progress));
 710
 711 /**
 712  * clutter_value_set_color:
 713  * @value: a #GValue initialized to #CLUTTER_TYPE_COLOR
 714  * @color: the color to set
 715  *
 716  * Sets @value to @color.
 717  *
 718  * Since: 0.8.4
 719  */
 720 void
 721 clutter_value_set_color (GValue             *value,
 722                          const ClutterColor *color)
 723 {
 724   g_return_if_fail (CLUTTER_VALUE_HOLDS_COLOR (value));
 725
 726   g_value_set_boxed (value, color);
 727 }
 728
 729 /**
 730  * clutter_value_get_color:
 731  * @value: a #GValue initialized to #CLUTTER_TYPE_COLOR
 732  *
 733  * Gets the #ClutterColor contained in @value.
 734  *
 735  * Return value: (transfer none): the color inside the passed #GValue
 736  *
 737  * Since: 0.8.4
 738  */
 739 G_CONST_RETURN ClutterColor *
 740 clutter_value_get_color (const GValue *value)
 741 {
 742   g_return_val_if_fail (CLUTTER_VALUE_HOLDS_COLOR (value), NULL);
 743
 744   return g_value_get_boxed (value);
 745 }
 746
 747 static void
 748 param_color_init (GParamSpec *pspec)
 749 {
 750   ClutterParamSpecColor *cspec = CLUTTER_PARAM_SPEC_COLOR (pspec);
 751
 752   cspec->default_value = NULL;
 753 }
 754
 755 static void
 756 param_color_finalize (GParamSpec *pspec)
 757 {
 758   ClutterParamSpecColor *cspec = CLUTTER_PARAM_SPEC_COLOR (pspec);
 759
 760   clutter_color_free (cspec->default_value);
 761 }
 762
 763 static void
 764 param_color_set_default (GParamSpec *pspec,
 765                          GValue     *value)
 766 {
 767   const ClutterColor *default_value =
 768     CLUTTER_PARAM_SPEC_COLOR (pspec)->default_value;
 769   clutter_value_set_color (value, default_value);
 770 }
 771
 772 static gint
 773 param_color_values_cmp (GParamSpec   *pspec,
 774                         const GValue *value1,
 775                         const GValue *value2)
 776 {
 777   const ClutterColor *color1 = g_value_get_boxed (value1);
 778   const ClutterColor *color2 = g_value_get_boxed (value2);
 779   int pixel1, pixel2;
 780
 781   if (color1 == NULL)
 782     return color2 == NULL ? 0 : -1;
 783
 784   pixel1 = clutter_color_to_pixel (color1);
 785   pixel2 = clutter_color_to_pixel (color2);
 786
 787   if (pixel1 < pixel2)
 788     return -1;
 789   else if (pixel1 == pixel2)
 790     return 0;
 791   else
 792     return 1;
 793 }
 794
 795 GType
 796 clutter_param_color_get_type (void)
 797 {
 798   static GType pspec_type = 0;
 799
 800   if (G_UNLIKELY (pspec_type == 0))
 801     {
 802       const GParamSpecTypeInfo pspec_info = {
 803         sizeof (ClutterParamSpecColor),
 804         16,
 805         param_color_init,
 806         CLUTTER_TYPE_COLOR,
 807         param_color_finalize,
 808         param_color_set_default,
 809         NULL,
 810         param_color_values_cmp,
 811       };
 812
 813       pspec_type = g_param_type_register_static (I_("ClutterParamSpecColor"),
 814                                                  &pspec_info);
 815     }
 816
 817   return pspec_type;
 818 }
 819
 820 /**
 821  * clutter_param_spec_color: (skip)
 822  * @name: name of the property
 823  * @nick: short name
 824  * @blurb: description (can be translatable)
 825  * @default_value: default value
 826  * @flags: flags for the param spec
 827  *
 828  * Creates a #GParamSpec for properties using #ClutterColor.
 829  *
 830  * Return value: the newly created #GParamSpec
 831  *
 832  * Since: 0.8.4
 833  */
 834 GParamSpec *
 835 clutter_param_spec_color (const gchar        *name,
 836                           const gchar        *nick,
 837                           const gchar        *blurb,
 838                           const ClutterColor *default_value,
 839                           GParamFlags         flags)
 840 {
 841   ClutterParamSpecColor *cspec;
 842
 843   cspec = g_param_spec_internal (CLUTTER_TYPE_PARAM_COLOR,
 844                                  name, nick, blurb, flags);
 845
 846   cspec->default_value = clutter_color_copy (default_value);
 847
 848   return G_PARAM_SPEC (cspec);
 849 }