| Clutter 0.2 Reference Manual | ||||
|---|---|---|---|---|
ClutterColor;
ClutterColor* clutter_color_copy (const ClutterColor *color);
void clutter_color_free (ClutterColor *color);
gboolean clutter_color_parse (const gchar *color,
ClutterColor *dest);
void clutter_color_from_hls (ClutterColor *dest,
guint8 hue,
guint8 luminance,
guint8 saturation);
void clutter_color_from_pixel (ClutterColor *dest,
guint32 pixel);
void clutter_color_add (const ClutterColor *src1,
const ClutterColor *src2,
ClutterColor *dest);
void clutter_color_subtract (const ClutterColor *src1,
const ClutterColor *src2,
ClutterColor *dest);
gboolean clutter_color_equal (const ClutterColor *a,
const ClutterColor *b);
void clutter_color_lighten (const ClutterColor *src,
ClutterColor *dest);
void clutter_color_darken (const ClutterColor *src,
ClutterColor *dest);
void clutter_color_shade (const ClutterColor *src,
ClutterColor *dest,
gdouble shade);
void clutter_color_shadex (const ClutterColor *src,
ClutterColor *dest,
ClutterFixed shade);
void clutter_color_to_hls (const ClutterColor *src,
guint8 *hue,
guint8 *luminance,
guint8 *saturation);
guint32 clutter_color_to_pixel (const ClutterColor *src);
gchar* clutter_color_to_string (const ClutterColor *color);
ClutterColor* clutter_color_copy (const ClutterColor *color);
Makes a copy of the color structure. The result must be
freed using clutter_color_free().
color : |
a ClutterColor |
| Returns : | an allocated copy of color.
|
Since 0.2
void clutter_color_free (ClutterColor *color);
Frees a color structure created with clutter_color_copy().
color : |
a ClutterColor |
Since 0.2
gboolean clutter_color_parse (const gchar *color,
ClutterColor *dest);
Parses a string definition of a color, filling the
red, green and
blue channels of dest. The
alpha channel is not changed. The
color in dest is not allocated.
The color may be defined by any of the formats understood by
XParseColor; these include literal color
names, like Red or DarkSlateGray,
or hexadecimal specifications like #3050b2 or
#333.
color : |
a string specifiying a color |
dest : |
return location for a ClutterColor |
| Returns : | TRUE if parsing succeeded.
|
Since 0.2
void clutter_color_from_hls (ClutterColor *dest, guint8 hue, guint8 luminance, guint8 saturation);
Converts a color expressed in HLS (hue, luminance and saturation) values into a ClutterColor.
dest : |
return location for a ClutterColor |
hue : |
hue value (0 .. 255) |
luminance : |
luminance value (0 .. 255) |
saturation : |
saturation value (0 .. 255) |
void clutter_color_from_pixel (ClutterColor *dest, guint32 pixel);
Converts pixel from the packed representation of a four 8 bit channel
color to a ClutterColor.
dest : |
return location for a ClutterColor |
pixel : |
a 32 bit packed integer containing a color |
void clutter_color_add (const ClutterColor *src1, const ClutterColor *src2, ClutterColor *dest);
Adds src2 to src1 and saves the resulting color
inside dest.
The alpha channel of dest is as the maximum value
between the alpha channels of src1 and src2.
src1 : |
a ClutterColor |
src2 : |
a ClutterColor |
dest : |
return location for the result |
void clutter_color_subtract (const ClutterColor *src1, const ClutterColor *src2, ClutterColor *dest);
Subtracts src2 from src1 and saves the resulting
color inside dest.
The alpha channel of dest is set as the minimum value
between the alpha channels of src1 and src2.
src1 : |
a ClutterColor |
src2 : |
a ClutterColor |
dest : |
return location for the result |
gboolean clutter_color_equal (const ClutterColor *a, const ClutterColor *b);
Compares two ClutterColors and checks if they are the same.
a : |
a ClutterColor |
b : |
a ClutterColor |
| Returns : | TRUE if the two colors are the same.
|
Since 0.2
void clutter_color_lighten (const ClutterColor *src, ClutterColor *dest);
Lightens src by a fixed amount, and saves the changed
color in dest.
src : |
a ClutterColor |
dest : |
return location for the lighter color |
void clutter_color_darken (const ClutterColor *src, ClutterColor *dest);
Darkens src by a fixed amount, and saves the changed color
in dest.
src : |
a ClutterColor |
dest : |
return location for the darker color |
void clutter_color_shade (const ClutterColor *src, ClutterColor *dest, gdouble shade);
Shades src by the factor of shade and saves the modified
color into dest.
src : |
a ClutterColor |
dest : |
return location for the shaded color |
shade : |
the shade factor to apply |
void clutter_color_shadex (const ClutterColor *src, ClutterColor *dest, ClutterFixed shade);
Fixed point version of clutter_color_shade().
Shades src by the factor of shade and saves the modified
color into dest.
src : |
a ClutterColor |
dest : |
return location for the shaded color |
shade : |
ClutterFixed the shade factor to apply |
Since 0.2
void clutter_color_to_hls (const ClutterColor *src, guint8 *hue, guint8 *luminance, guint8 *saturation);
Converts src to the HLS format.
src : |
a ClutterColor |
hue : |
return location for the hue value or NULL
|
luminance : |
return location for the luminance value or NULL
|
saturation : |
return location for the saturation value or NULL
|
guint32 clutter_color_to_pixel (const ClutterColor *src);
Converts src into a packed 32 bit integer, containing
all the four 8 bit channels used by ClutterColor.
src : |
a ClutterColor |
| Returns : | a packed color |
gchar* clutter_color_to_string (const ClutterColor *color);
Returns a textual specification of color in the hexadecimal form
#rrrrggggbbbbaaaa, where r,
g, b and a are
hex digits representing the red, green, blue and alpha components
respectively.
Note: the returned string cannot be used to get the color back with
clutter_color_parse().
color : |
a ClutterColor |
| Returns : | a newly-allocated text string |
Since 0.2