4 * An OpenGL based 'interactive canvas' library.
6 * Authored By Matthew Allum <mallum@openedhand.com>
8 * Copyright (C) 2006 OpenedHand
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.
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.
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/>.
25 * SECTION:clutter-color
26 * @short_description: Color management and manipulation.
28 * #ClutterColor is a simple type for representing colors in Clutter.
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.
33 * The alpha channel is fully opaque at 255 and fully transparent at 0.
42 #include <pango/pango-attributes.h>
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"
50 /* XXX - keep in sync with the ClutterStaticColor enumeration order */
51 static const ClutterColor const static_colors[] = {
52 /* CGA/EGA color palette */
53 { 0xff, 0xff, 0xff, 0xff }, /* white */
54 { 0x00, 0x00, 0x00, 0xff }, /* black */
55 { 0xff, 0x00, 0x00, 0xff }, /* red */
56 { 0x80, 0x00, 0x00, 0xff }, /* dark red */
57 { 0x00, 0xff, 0x00, 0xff }, /* green */
58 { 0x00, 0x80, 0x00, 0xff }, /* dark green */
59 { 0x00, 0x00, 0xff, 0xff }, /* blue */
60 { 0x00, 0x00, 0x80, 0xff }, /* dark blue */
61 { 0x00, 0xff, 0xff, 0xff }, /* cyan */
62 { 0x00, 0x80, 0x80, 0xff }, /* dark cyan */
63 { 0xff, 0x00, 0xff, 0xff }, /* magenta */
64 { 0x80, 0x00, 0x80, 0xff }, /* dark magenta */
65 { 0xff, 0xff, 0x00, 0xff }, /* yellow */
66 { 0x80, 0x80, 0x00, 0xff }, /* dark yellow */
67 { 0xa0, 0xa0, 0xa4, 0xff }, /* gray */
68 { 0x80, 0x80, 0x80, 0xff }, /* dark gray */
69 { 0xc0, 0xc0, 0xc0, 0xff }, /* light gray */
71 /* Tango Icon color palette */
72 { 0xed, 0xd4, 0x00, 0xff }, /* butter */
73 { 0xfc, 0xe9, 0x4f, 0xff }, /* butter light */
74 { 0xc4, 0xa0, 0x00, 0xff }, /* butter dark */
75 { 0xf5, 0x79, 0x00, 0xff }, /* orange */
76 { 0xfc, 0xaf, 0x3e, 0xff }, /* orange light */
77 { 0xce, 0x5c, 0x00, 0xff }, /* orange dark */
78 { 0xc1, 0x7d, 0x11, 0xff }, /* chocolate */
79 { 0xe9, 0xb9, 0x6e, 0xff }, /* chocolate light */
80 { 0x8f, 0x59, 0x02, 0xff }, /* chocolate dark */
81 { 0x73, 0xd2, 0x16, 0xff }, /* chameleon */
82 { 0x8a, 0xe2, 0x34, 0xff }, /* chameleon light */
83 { 0x4e, 0x9a, 0x06, 0xff }, /* chameleon dark */
84 { 0x34, 0x65, 0xa4, 0xff }, /* sky blue */
85 { 0x72, 0x9f, 0xcf, 0xff }, /* sky blue light */
86 { 0x20, 0x4a, 0x87, 0xff }, /* sky blue dark */
87 { 0x75, 0x50, 0x7b, 0xff }, /* plum */
88 { 0xad, 0x7f, 0xa8, 0xff }, /* plum light */
89 { 0x5c, 0x35, 0x66, 0xff }, /* plum dark */
90 { 0xcc, 0x00, 0x00, 0xff }, /* scarlet red */
91 { 0xef, 0x29, 0x29, 0xff }, /* scarlet red light */
92 { 0xa4, 0x00, 0x00, 0xff }, /* scarlet red dark */
93 { 0xee, 0xee, 0xec, 0xff }, /* aluminium 1 */
94 { 0xd3, 0xd7, 0xcf, 0xff }, /* aluminium 2 */
95 { 0xba, 0xbd, 0xb6, 0xff }, /* aluminium 3 */
96 { 0x88, 0x8a, 0x85, 0xff }, /* aluminium 4 */
97 { 0x55, 0x57, 0x53, 0xff }, /* aluminium 5 */
98 { 0x2e, 0x34, 0x36, 0xff }, /* aluminium 6 */
101 { 0x00, 0x00, 0x00, 0x00 } /* transparent */
105 * clutter_color_get_static:
106 * @color: the named global color
108 * Retrieves a static color for the given @color name
110 * Static colors are created by Clutter and are guaranteed to always be
111 * available and valid
113 * Return value: a pointer to a static color; the returned pointer
114 * is owned by Clutter and it should never be modified or freed
118 G_CONST_RETURN ClutterColor *
119 clutter_color_get_static (ClutterStaticColor color)
121 g_return_val_if_fail (color >= CLUTTER_COLOR_WHITE &&
122 color <= CLUTTER_COLOR_TRANSPARENT, NULL);
124 return &static_colors[color];
129 * @a: a #ClutterColor
130 * @b: a #ClutterColor
131 * @result: (out caller-allocates): return location for the result
133 * Adds @a to @b and saves the resulting color inside @result.
135 * The alpha channel of @result is set as as the maximum value
136 * between the alpha channels of @a and @b.
139 clutter_color_add (const ClutterColor *a,
140 const ClutterColor *b,
141 ClutterColor *result)
143 g_return_if_fail (a != NULL);
144 g_return_if_fail (b != NULL);
145 g_return_if_fail (result != NULL);
147 result->red = CLAMP (a->red + b->red, 0, 255);
148 result->green = CLAMP (a->green + b->green, 0, 255);
149 result->blue = CLAMP (a->blue + b->blue, 0, 255);
151 result->alpha = MAX (a->alpha, b->alpha);
155 * clutter_color_subtract:
156 * @a: a #ClutterColor
157 * @b: a #ClutterColor
158 * @result: (out caller-allocates): return location for the result
160 * Subtracts @b from @a and saves the resulting color inside @result.
162 * This function assumes that the components of @a are greater than the
163 * components of @b; the result is, otherwise, undefined.
165 * The alpha channel of @result is set as the minimum value
166 * between the alpha channels of @a and @b.
169 clutter_color_subtract (const ClutterColor *a,
170 const ClutterColor *b,
171 ClutterColor *result)
173 g_return_if_fail (a != NULL);
174 g_return_if_fail (b != NULL);
175 g_return_if_fail (result != NULL);
177 result->red = CLAMP (a->red - b->red, 0, 255);
178 result->green = CLAMP (a->green - b->green, 0, 255);
179 result->blue = CLAMP (a->blue - b->blue, 0, 255);
181 result->alpha = MIN (a->alpha, b->alpha);
185 * clutter_color_lighten:
186 * @color: a #ClutterColor
187 * @result: (out caller-allocates): return location for the lighter color
189 * Lightens @color by a fixed amount, and saves the changed color
193 clutter_color_lighten (const ClutterColor *color,
194 ClutterColor *result)
196 clutter_color_shade (color, 1.3, result);
200 * clutter_color_darken:
201 * @color: a #ClutterColor
202 * @result: (out caller-allocates): return location for the darker color
204 * Darkens @color by a fixed amount, and saves the changed color
208 clutter_color_darken (const ClutterColor *color,
209 ClutterColor *result)
211 clutter_color_shade (color, 0.7, result);
215 * clutter_color_to_hls:
216 * @color: a #ClutterColor
217 * @hue: (out): return location for the hue value or %NULL
218 * @luminance: (out): return location for the luminance value or %NULL
219 * @saturation: (out): return location for the saturation value or %NULL
221 * Converts @color to the HLS format.
223 * The @hue value is in the 0 .. 360 range. The @luminance and
224 * @saturation values are in the 0 .. 1 range.
227 clutter_color_to_hls (const ClutterColor *color,
232 float red, green, blue;
233 float min, max, delta;
236 g_return_if_fail (color != NULL);
238 red = color->red / 255.0;
239 green = color->green / 255.0;
240 blue = color->blue / 255.0;
274 s = (max - min) / (max + min);
276 s = (max - min) / (2.0 - max - min);
281 h = (green - blue) / delta;
282 else if (green == max)
283 h = 2.0 + (blue - red) / delta;
284 else if (blue == max)
285 h = 4.0 + (red - green) / delta;
304 * clutter_color_from_hls:
305 * @color: (out): return location for a #ClutterColor
306 * @hue: hue value, in the 0 .. 360 range
307 * @luminance: luminance value, in the 0 .. 1 range
308 * @saturation: saturation value, in the 0 .. 1 range
310 * Converts a color expressed in HLS (hue, luminance and saturation)
311 * values into a #ClutterColor.
314 clutter_color_from_hls (ClutterColor *color,
328 color->red = color->green = color->blue = (luminance * 255);
333 if (luminance <= 0.5)
334 tmp2 = luminance * (1.0 + saturation);
336 tmp2 = luminance + saturation - (luminance * saturation);
338 tmp1 = 2.0 * luminance - tmp2;
340 tmp3[0] = hue + 1.0 / 3.0;
342 tmp3[2] = hue - 1.0 / 3.0;
344 for (i = 0; i < 3; i++)
352 if (6.0 * tmp3[i] < 1.0)
353 clr[i] = tmp1 + (tmp2 - tmp1) * tmp3[i] * 6.0;
354 else if (2.0 * tmp3[i] < 1.0)
356 else if (3.0 * tmp3[i] < 2.0)
357 clr[i] = (tmp1 + (tmp2 - tmp1) * ((2.0 / 3.0) - tmp3[i]) * 6.0);
362 color->red = floorf (clr[0] * 255.0 + 0.5);
363 color->green = floorf (clr[1] * 255.0 + 0.5);
364 color->blue = floorf (clr[2] * 255.0 + 0.5);
368 * clutter_color_shade:
369 * @color: a #ClutterColor
370 * @factor: the shade factor to apply
371 * @result: (out caller-allocates): return location for the shaded color
373 * Shades @color by @factor and saves the modified color into @result.
376 clutter_color_shade (const ClutterColor *color,
378 ClutterColor *result)
382 g_return_if_fail (color != NULL);
383 g_return_if_fail (result != NULL);
385 clutter_color_to_hls (color, &h, &l, &s);
399 clutter_color_from_hls (result, h, l, s);
401 result->alpha = color->alpha;
405 * clutter_color_to_pixel:
406 * @color: a #ClutterColor
408 * Converts @color into a packed 32 bit integer, containing
409 * all the four 8 bit channels used by #ClutterColor.
411 * Return value: a packed color
414 clutter_color_to_pixel (const ClutterColor *color)
416 g_return_val_if_fail (color != NULL, 0);
418 return (color->alpha |
425 * clutter_color_from_pixel:
426 * @color: (out caller-allocates): return location for a #ClutterColor
427 * @pixel: a 32 bit packed integer containing a color
429 * Converts @pixel from the packed representation of a four 8 bit channel
430 * color to a #ClutterColor.
433 clutter_color_from_pixel (ClutterColor *color,
436 g_return_if_fail (color != NULL);
438 color->red = pixel >> 24;
439 color->green = (pixel >> 16) & 0xff;
440 color->blue = (pixel >> 8) & 0xff;
441 color->alpha = pixel & 0xff;
445 * clutter_color_from_string:
446 * @color: (out caller-allocates): return location for a #ClutterColor
447 * @str: a string specifiying a color (named color or #RRGGBBAA)
449 * Parses a string definition of a color, filling the
450 * <structfield>red</structfield>, <structfield>green</structfield>,
451 * <structfield>blue</structfield> and <structfield>alpha</structfield>
452 * channels of @color. If alpha is not specified it will be set full opaque.
454 * The @color is not allocated.
456 * The color may be defined by any of the formats understood by
457 * pango_color_from_string(); these include literal color names, like
458 * <literal>Red</literal> or <literal>DarkSlateGray</literal>, or
459 * hexadecimal specifications like <literal>#3050b2</literal> or
460 * <literal>#333</literal>.
462 * Return value: %TRUE if parsing succeeded.
467 clutter_color_from_string (ClutterColor *color,
470 PangoColor pango_color = { 0, };
472 g_return_val_if_fail (color != NULL, FALSE);
473 g_return_val_if_fail (str != NULL, FALSE);
475 /* if the string contains a color encoded using the hexadecimal
476 * notations (#rrggbbaa or #rgba) we attempt a rough pass at
477 * parsing the color ourselves, as we need the alpha channel that
478 * Pango can't retrieve.
484 if (sscanf (str + 1, "%x", &result))
486 gsize length = strlen (str);
490 case 9: /* rrggbbaa */
491 color->red = (result >> 24) & 0xff;
492 color->green = (result >> 16) & 0xff;
493 color->blue = (result >> 8) & 0xff;
495 color->alpha = result & 0xff;
499 case 7: /* #rrggbb */
500 color->red = (result >> 16) & 0xff;
501 color->green = (result >> 8) & 0xff;
502 color->blue = result & 0xff;
509 color->red = ((result >> 12) & 0xf);
510 color->green = ((result >> 8) & 0xf);
511 color->blue = ((result >> 4) & 0xf);
512 color->alpha = result & 0xf;
514 color->red = (color->red << 4) | color->red;
515 color->green = (color->green << 4) | color->green;
516 color->blue = (color->blue << 4) | color->blue;
517 color->alpha = (color->alpha << 4) | color->alpha;
522 color->red = ((result >> 8) & 0xf);
523 color->green = ((result >> 4) & 0xf);
524 color->blue = result & 0xf;
526 color->red = (color->red << 4) | color->red;
527 color->green = (color->green << 4) | color->green;
528 color->blue = (color->blue << 4) | color->blue;
535 /* pass through to Pango */
541 /* Fall back to pango for named colors */
542 if (pango_color_parse (&pango_color, str))
544 color->red = pango_color.red;
545 color->green = pango_color.green;
546 color->blue = pango_color.blue;
557 * clutter_color_to_string:
558 * @color: a #ClutterColor
560 * Returns a textual specification of @color in the hexadecimal form
561 * <literal>#rrggbbaa</literal>, where <literal>r</literal>,
562 * <literal>g</literal>, <literal>b</literal> and <literal>a</literal> are
563 * hex digits representing the red, green, blue and alpha components
566 * Return value: (transfer full): a newly-allocated text string
571 clutter_color_to_string (const ClutterColor *color)
573 g_return_val_if_fail (color != NULL, NULL);
575 return g_strdup_printf ("#%02x%02x%02x%02x",
583 * clutter_color_equal:
584 * @v1: a #ClutterColor
585 * @v2: a #ClutterColor
587 * Compares two #ClutterColor<!-- -->s and checks if they are the same.
589 * This function can be passed to g_hash_table_new() as the @key_equal_func
590 * parameter, when using #ClutterColor<!-- -->s as keys in a #GHashTable.
592 * Return value: %TRUE if the two colors are the same.
597 clutter_color_equal (gconstpointer v1,
600 const ClutterColor *a, *b;
602 g_return_val_if_fail (v1 != NULL, FALSE);
603 g_return_val_if_fail (v2 != NULL, FALSE);
611 return (a->red == b->red &&
612 a->green == b->green &&
613 a->blue == b->blue &&
614 a->alpha == b->alpha);
618 * clutter_color_hash:
619 * @v: a #ClutterColor
621 * Converts a #ClutterColor to a hash value.
623 * This function can be passed to g_hash_table_new() as the @hash_func
624 * parameter, when using #ClutterColor<!-- -->s as keys in a #GHashTable.
626 * Return value: a hash value corresponding to the color
631 clutter_color_hash (gconstpointer v)
633 return clutter_color_to_pixel ((const ClutterColor *) v);
637 * clutter_color_interpolate:
638 * @initial: the initial #ClutterColor
639 * @final: the final #ClutterColor
640 * @progress: the interpolation progress
641 * @result: (out): return location for the interpolation
643 * Interpolates between @initial and @final #ClutterColor<!-- -->s
649 clutter_color_interpolate (const ClutterColor *initial,
650 const ClutterColor *final,
652 ClutterColor *result)
654 g_return_if_fail (initial != NULL);
655 g_return_if_fail (final != NULL);
656 g_return_if_fail (result != NULL);
658 result->red = initial->red + (final->red - initial->red) * progress;
659 result->green = initial->green + (final->green - initial->green) * progress;
660 result->blue = initial->blue + (final->blue - initial->blue) * progress;
661 result->alpha = initial->alpha + (final->alpha - initial->alpha) * progress;
665 clutter_color_progress (const GValue *a,
670 const ClutterColor *a_color = clutter_value_get_color (a);
671 const ClutterColor *b_color = clutter_value_get_color (b);
672 ClutterColor res = { 0, };
674 clutter_color_interpolate (a_color, b_color, progress, &res);
675 clutter_value_set_color (retval, &res);
681 * clutter_color_copy:
682 * @color: a #ClutterColor
684 * Makes a copy of the color structure. The result must be
685 * freed using clutter_color_free().
687 * Return value: (transfer full): an allocated copy of @color.
692 clutter_color_copy (const ClutterColor *color)
694 if (G_LIKELY (color != NULL))
695 return g_slice_dup (ClutterColor, color);
701 * clutter_color_free:
702 * @color: a #ClutterColor
704 * Frees a color structure created with clutter_color_copy().
709 clutter_color_free (ClutterColor *color)
711 if (G_LIKELY (color != NULL))
712 g_slice_free (ClutterColor, color);
717 * @red: red component of the color, between 0 and 255
718 * @green: green component of the color, between 0 and 255
719 * @blue: blue component of the color, between 0 and 255
720 * @alpha: alpha component of the color, between 0 and 255
722 * Creates a new #ClutterColor with the given values.
724 * Return value: (transfer full): the newly allocated color.
725 * Use clutter_color_free() when done
730 clutter_color_new (guint8 red,
737 color = g_slice_new (ClutterColor);
740 color->green = green;
742 color->alpha = alpha;
748 clutter_value_transform_color_string (const GValue *src,
751 const ClutterColor *color = g_value_get_boxed (src);
755 gchar *string = clutter_color_to_string (color);
757 g_value_take_string (dest, string);
760 g_value_set_string (dest, NULL);
764 clutter_value_transform_string_color (const GValue *src,
767 const char *str = g_value_get_string (src);
771 ClutterColor color = { 0, };
773 clutter_color_from_string (&color, str);
775 clutter_value_set_color (dest, &color);
778 clutter_value_set_color (dest, NULL);
781 G_DEFINE_BOXED_TYPE_WITH_CODE (ClutterColor, clutter_color,
784 CLUTTER_REGISTER_VALUE_TRANSFORM_TO (G_TYPE_STRING, clutter_value_transform_color_string)
785 CLUTTER_REGISTER_VALUE_TRANSFORM_FROM (G_TYPE_STRING, clutter_value_transform_string_color)
786 CLUTTER_REGISTER_INTERVAL_PROGRESS (clutter_color_progress));
789 * clutter_value_set_color:
790 * @value: a #GValue initialized to #CLUTTER_TYPE_COLOR
791 * @color: the color to set
793 * Sets @value to @color.
798 clutter_value_set_color (GValue *value,
799 const ClutterColor *color)
801 g_return_if_fail (CLUTTER_VALUE_HOLDS_COLOR (value));
803 g_value_set_boxed (value, color);
807 * clutter_value_get_color:
808 * @value: a #GValue initialized to #CLUTTER_TYPE_COLOR
810 * Gets the #ClutterColor contained in @value.
812 * Return value: (transfer none): the color inside the passed #GValue
816 G_CONST_RETURN ClutterColor *
817 clutter_value_get_color (const GValue *value)
819 g_return_val_if_fail (CLUTTER_VALUE_HOLDS_COLOR (value), NULL);
821 return g_value_get_boxed (value);
825 param_color_init (GParamSpec *pspec)
827 ClutterParamSpecColor *cspec = CLUTTER_PARAM_SPEC_COLOR (pspec);
829 cspec->default_value = NULL;
833 param_color_finalize (GParamSpec *pspec)
835 ClutterParamSpecColor *cspec = CLUTTER_PARAM_SPEC_COLOR (pspec);
837 clutter_color_free (cspec->default_value);
841 param_color_set_default (GParamSpec *pspec,
844 const ClutterColor *default_value =
845 CLUTTER_PARAM_SPEC_COLOR (pspec)->default_value;
846 clutter_value_set_color (value, default_value);
850 param_color_values_cmp (GParamSpec *pspec,
851 const GValue *value1,
852 const GValue *value2)
854 const ClutterColor *color1 = g_value_get_boxed (value1);
855 const ClutterColor *color2 = g_value_get_boxed (value2);
859 return color2 == NULL ? 0 : -1;
861 pixel1 = clutter_color_to_pixel (color1);
862 pixel2 = clutter_color_to_pixel (color2);
866 else if (pixel1 == pixel2)
873 clutter_param_color_get_type (void)
875 static GType pspec_type = 0;
877 if (G_UNLIKELY (pspec_type == 0))
879 const GParamSpecTypeInfo pspec_info = {
880 sizeof (ClutterParamSpecColor),
884 param_color_finalize,
885 param_color_set_default,
887 param_color_values_cmp,
890 pspec_type = g_param_type_register_static (I_("ClutterParamSpecColor"),
898 * clutter_param_spec_color: (skip)
899 * @name: name of the property
901 * @blurb: description (can be translatable)
902 * @default_value: default value
903 * @flags: flags for the param spec
905 * Creates a #GParamSpec for properties using #ClutterColor.
907 * Return value: the newly created #GParamSpec
912 clutter_param_spec_color (const gchar *name,
915 const ClutterColor *default_value,
918 ClutterParamSpecColor *cspec;
920 cspec = g_param_spec_internal (CLUTTER_TYPE_PARAM_COLOR,
921 name, nick, blurb, flags);
923 cspec->default_value = clutter_color_copy (default_value);
925 return G_PARAM_SPEC (cspec);