clutter_units_from_cm ()

void
clutter_units_from_cm (ClutterUnits *units,
                       gfloat cm);

Stores a value in centimeters inside units

Since: 1.2

clutter_units_from_em ()

void
clutter_units_from_em (ClutterUnits *units,
                       gfloat em);

Stores a value in em inside units , using the default font name as returned by clutter_backend_get_font_name()

Since: 1.0

clutter_units_from_em_for_font ()

void
clutter_units_from_em_for_font (ClutterUnits *units,
                                const gchar *font_name,
                                gfloat em);

Stores a value in em inside units using font_name

Since: 1.0

clutter_units_from_mm ()

void
clutter_units_from_mm (ClutterUnits *units,
                       gfloat mm);

Stores a value in millimiters inside units

Since: 1.0

clutter_units_from_pixels ()

void
clutter_units_from_pixels (ClutterUnits *units,
                           gint px);

Stores a value in pixels inside units

Since: 1.0

clutter_units_from_pt ()

void
clutter_units_from_pt (ClutterUnits *units,
                       gfloat pt);

Stores a value in typographic points inside units

Since: 1.0

clutter_units_to_pixels ()

gfloat
clutter_units_to_pixels (ClutterUnits *units);

Converts a value in ClutterUnits to pixels

Since: 1.0

clutter_units_copy ()

ClutterUnits *
clutter_units_copy (const ClutterUnits *units);

Copies units

Since: 1.0

clutter_units_free ()

void
clutter_units_free (ClutterUnits *units);

Frees the resources allocated by units

You should only call this function on a ClutterUnits created using clutter_units_copy()

Since: 1.0

clutter_units_get_unit_type ()

ClutterUnitType
clutter_units_get_unit_type (const ClutterUnits *units);

Retrieves the unit type of the value stored inside units

Since: 1.0

clutter_units_get_unit_value ()

gfloat
clutter_units_get_unit_value (const ClutterUnits *units);

Retrieves the value stored inside units

Since: 1.0

clutter_units_from_string ()

gboolean
clutter_units_from_string (ClutterUnits *units,
                           const gchar *str);

Parses a value and updates units with it

A ClutterUnits expressed in string should match:

1
2
3
4
5
6
7
8

units: wsp* unit-value wsp* unit-name? wsp*
unit-value: number
unit-name: 'px' | 'pt' | 'mm' | 'em' | 'cm'
number: digit+
        | digit* sep digit+
sep: '.' | ','
digit: '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'
wsp: (#0x20 | #0x9 | #0xA | #0xB | #0xC | #0xD)+

For instance, these are valid strings:

1
2
3
4
5

10 px
5.1 em
24 pt
12.6 mm
.3 cm

While these are not:

1
2

42 cats
omg!1!ponies

If no unit is specified, pixels are assumed.

Since: 1.0

clutter_units_to_string ()

gchar *
clutter_units_to_string (const ClutterUnits *units);

Converts units into a string

See clutter_units_from_string() for the units syntax and for examples of output

Fractional values are truncated to the second decimal position for em, mm and cm, and to the first decimal position for typographic points. Pixels are integers.

Since: 1.0

clutter_param_spec_units ()

GParamSpec *
clutter_param_spec_units (const gchar *name,
                          const gchar *nick,
                          const gchar *blurb,
                          ClutterUnitType default_type,
                          gfloat minimum,
                          gfloat maximum,
                          gfloat default_value,
                          GParamFlags flags);

Creates a GParamSpec for properties using ClutterUnits.

[skip]

Since: 1.0

CLUTTER_VALUE_HOLDS_UNITS()

#define CLUTTER_VALUE_HOLDS_UNITS(x)    (G_VALUE_HOLDS ((x), CLUTTER_TYPE_UNITS))

Evaluates to TRUE if x holds a ClutterUnits value

Since: 0.8

clutter_value_set_units ()

void
clutter_value_set_units (GValue *value,
                         const ClutterUnits *units);

Sets value to units

Since: 0.8

clutter_value_get_units ()

const ClutterUnits *
clutter_value_get_units (const GValue *value);

Gets the ClutterUnits contained in value .

Since: 0.8

enum ClutterUnitType

The type of unit in which a value is expressed

This enumeration might be expanded at later date

Since: 1.0

struct ClutterUnits

struct ClutterUnits {
};

An opaque structure, to be used to store sizing and positioning values along with their unit.

Since: 1.0

struct ClutterParamSpecUnits

struct ClutterParamSpecUnits {
  ClutterUnitType default_type;

  gfloat default_value;
  gfloat minimum;
  gfloat maximum;
};

GParamSpec subclass for unit based properties.

Since: 1.0