CLUTTER_COLOR_INIT()

#define CLUTTER_COLOR_INIT(r,g,b,a)     { (r), (g), (b), (a) }

A macro that initializes a ClutterColor, to be used when declaring it.

Since 1.12

ClutterColor

typedef struct {
  guint8 red;
  guint8 green;
  guint8 blue;
  
  guint8 alpha;
} ClutterColor;

Color representation.

clutter_color_new ()

ClutterColor *      clutter_color_new                   (guint8 red,
                                                         guint8 green,
                                                         guint8 blue,
                                                         guint8 alpha);

Creates a new ClutterColor with the given values.

This function is the equivalent of:

1

clutter_color_init (clutter_color_alloc (), red, green, blue, alpha);

Since 0.8.4

clutter_color_alloc ()

ClutterColor *      clutter_color_alloc                 (void);

Allocates a new, transparent black ClutterColor.

Since 1.12

clutter_color_init ()

ClutterColor *      clutter_color_init                  (ClutterColor *color,
                                                         guint8 red,
                                                         guint8 green,
                                                         guint8 blue,
                                                         guint8 alpha);

Initializes color with the given values.

Since 1.12

clutter_color_copy ()

ClutterColor *      clutter_color_copy                  (const ClutterColor *color);

Makes a copy of the color structure. The result must be freed using clutter_color_free().

Since 0.2

clutter_color_free ()

void                clutter_color_free                  (ClutterColor *color);

Frees a color structure created with clutter_color_copy().

Since 0.2

clutter_color_equal ()

gboolean            clutter_color_equal                 (gconstpointer v1,
                                                         gconstpointer v2);

Compares two ClutterColors and checks if they are the same.

This function can be passed to g_hash_table_new() as the key_equal_func parameter, when using ClutterColors as keys in a GHashTable.

Since 0.2

clutter_color_hash ()

guint               clutter_color_hash                  (gconstpointer v);

Converts a ClutterColor to a hash value.

This function can be passed to g_hash_table_new() as the hash_func parameter, when using ClutterColors as keys in a GHashTable.

Since 1.0

enum ClutterStaticColor

typedef enum {
 /*< prefix=CLUTTER_COLOR >*/
  /* CGA/EGA-like palette */
  CLUTTER_COLOR_WHITE           = 0,
  CLUTTER_COLOR_BLACK,
  CLUTTER_COLOR_RED,
  CLUTTER_COLOR_DARK_RED,
  CLUTTER_COLOR_GREEN,
  CLUTTER_COLOR_DARK_GREEN,
  CLUTTER_COLOR_BLUE,
  CLUTTER_COLOR_DARK_BLUE,
  CLUTTER_COLOR_CYAN,
  CLUTTER_COLOR_DARK_CYAN,
  CLUTTER_COLOR_MAGENTA,
  CLUTTER_COLOR_DARK_MAGENTA,
  CLUTTER_COLOR_YELLOW,
  CLUTTER_COLOR_DARK_YELLOW,
  CLUTTER_COLOR_GRAY,
  CLUTTER_COLOR_DARK_GRAY,
  CLUTTER_COLOR_LIGHT_GRAY,

  /* Tango icon palette */
  CLUTTER_COLOR_BUTTER,
  CLUTTER_COLOR_BUTTER_LIGHT,
  CLUTTER_COLOR_BUTTER_DARK,
  CLUTTER_COLOR_ORANGE,
  CLUTTER_COLOR_ORANGE_LIGHT,
  CLUTTER_COLOR_ORANGE_DARK,
  CLUTTER_COLOR_CHOCOLATE,
  CLUTTER_COLOR_CHOCOLATE_LIGHT,
  CLUTTER_COLOR_CHOCOLATE_DARK,
  CLUTTER_COLOR_CHAMELEON,
  CLUTTER_COLOR_CHAMELEON_LIGHT,
  CLUTTER_COLOR_CHAMELEON_DARK,
  CLUTTER_COLOR_SKY_BLUE,
  CLUTTER_COLOR_SKY_BLUE_LIGHT,
  CLUTTER_COLOR_SKY_BLUE_DARK,
  CLUTTER_COLOR_PLUM,
  CLUTTER_COLOR_PLUM_LIGHT,
  CLUTTER_COLOR_PLUM_DARK,
  CLUTTER_COLOR_SCARLET_RED,
  CLUTTER_COLOR_SCARLET_RED_LIGHT,
  CLUTTER_COLOR_SCARLET_RED_DARK,
  CLUTTER_COLOR_ALUMINIUM_1,
  CLUTTER_COLOR_ALUMINIUM_2,
  CLUTTER_COLOR_ALUMINIUM_3,
  CLUTTER_COLOR_ALUMINIUM_4,
  CLUTTER_COLOR_ALUMINIUM_5,
  CLUTTER_COLOR_ALUMINIUM_6,

  /* Fully transparent black */
  CLUTTER_COLOR_TRANSPARENT
} ClutterStaticColor;

Named colors, for accessing global colors defined by Clutter

Since 1.6

clutter_color_get_static ()

const ClutterColor * clutter_color_get_static           (ClutterStaticColor color);

Retrieves a static color for the given color name

Static colors are created by Clutter and are guaranteed to always be available and valid

Since 1.6

clutter_color_from_string ()

gboolean            clutter_color_from_string           (ClutterColor *color,
                                                         const gchar *str);

Parses a string definition of a color, filling the red, green, blue and alpha channels of color.

The color is not allocated.

The format of str can be either one of:

where 'r', 'g', 'b' and 'a' are (respectively) the red, green, blue color intensities and the opacity. The 'h', 's' and 'l' are (respectively) the hue, saturation and luminance values.

In the rgb() and rgba() formats, the 'r', 'g', and 'b' values are either integers between 0 and 255, or percentage values in the range between 0% and 100%; the percentages require the '%' character. The 'a' value, if specified, can only be a floating point value between 0.0 and 1.0.

In the hls() and hlsa() formats, the 'h' value (hue) it's an angle between 0 and 360.0 degrees; the 'l' and 's' values (luminance and saturation) are a floating point value between 0.0 and 1.0. The 'a' value, if specified, can only be a floating point value between 0.0 and 1.0.

Whitespace inside the definitions is ignored; no leading whitespace is allowed.

If the alpha component is not specified then it is assumed to be set to be fully opaque.

Since 1.0

clutter_color_to_string ()

gchar *             clutter_color_to_string             (const ClutterColor *color);

Returns a textual specification of color in the hexadecimal form #rrggbbaa, where r, g, b and a are hexadecimal digits representing the red, green, blue and alpha components respectively.

Since 0.2

clutter_color_from_hls ()

void                clutter_color_from_hls              (ClutterColor *color,
                                                         gfloat hue,
                                                         gfloat luminance,
                                                         gfloat saturation);

Converts a color expressed in HLS (hue, luminance and saturation) values into a ClutterColor.

clutter_color_to_hls ()

void                clutter_color_to_hls                (const ClutterColor *color,
                                                         gfloat *hue,
                                                         gfloat *luminance,
                                                         gfloat *saturation);

Converts color to the HLS format.

The hue value is in the 0 .. 360 range. The luminance and saturation values are in the 0 .. 1 range.

clutter_color_from_pixel ()

void                clutter_color_from_pixel            (ClutterColor *color,
                                                         guint32 pixel);

Converts pixel from the packed representation of a four 8 bit channel color to a ClutterColor.

clutter_color_to_pixel ()

guint32             clutter_color_to_pixel              (const ClutterColor *color);

Converts color into a packed 32 bit integer, containing all the four 8 bit channels used by ClutterColor.

clutter_color_add ()

void                clutter_color_add                   (const ClutterColor *a,
                                                         const ClutterColor *b,
                                                         ClutterColor *result);

Adds a to b and saves the resulting color inside result.

The alpha channel of result is set as as the maximum value between the alpha channels of a and b.

clutter_color_subtract ()

void                clutter_color_subtract              (const ClutterColor *a,
                                                         const ClutterColor *b,
                                                         ClutterColor *result);

Subtracts b from a and saves the resulting color inside result.

This function assumes that the components of a are greater than the components of b; the result is, otherwise, undefined.

The alpha channel of result is set as the minimum value between the alpha channels of a and b.

clutter_color_lighten ()

void                clutter_color_lighten               (const ClutterColor *color,
                                                         ClutterColor *result);

Lightens color by a fixed amount, and saves the changed color in result.

clutter_color_darken ()

void                clutter_color_darken                (const ClutterColor *color,
                                                         ClutterColor *result);

Darkens color by a fixed amount, and saves the changed color in result.

clutter_color_shade ()

void                clutter_color_shade                 (const ClutterColor *color,
                                                         gdouble factor,
                                                         ClutterColor *result);

Shades color by factor and saves the modified color into result.

clutter_color_interpolate ()

void                clutter_color_interpolate           (const ClutterColor *initial,
                                                         const ClutterColor *final,
                                                         gdouble progress,
                                                         ClutterColor *result);

Interpolates between initial and final ClutterColors using progress

Since 1.6

struct ClutterParamSpecColor

struct ClutterParamSpecColor {
  ClutterColor *default_value;
};

A GParamSpec subclass for defining properties holding a ClutterColor.

Since 1.0

clutter_param_spec_color ()

GParamSpec *        clutter_param_spec_color            (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         const ClutterColor *default_value,
                                                         GParamFlags flags);

Creates a GParamSpec for properties using ClutterColor.

Since 0.8.4

CLUTTER_VALUE_HOLDS_COLOR()

#define CLUTTER_VALUE_HOLDS_COLOR(x)       (G_VALUE_HOLDS ((x), CLUTTER_TYPE_COLOR))

Evaluates to TRUE if x holds a ClutterColor.

Since 1.0

clutter_value_set_color ()

void                clutter_value_set_color             (GValue *value,
                                                         const ClutterColor *color);

Sets value to color.

Since 0.8.4

clutter_value_get_color ()

const ClutterColor * clutter_value_get_color            (const GValue *value);

Gets the ClutterColor contained in value.

Since 0.8.4