CLUTTER_ACTOR_SET_FLAGS()

#define CLUTTER_ACTOR_SET_FLAGS(e,f)    ((e)->flags |= (f))  

CLUTTER_ACTOR_UNSET_FLAGS()

#define CLUTTER_ACTOR_UNSET_FLAGS(e,f)  ((e)->flags &= ~(f))  

CLUTTER_ACTOR_IS_MAPPED()

#define CLUTTER_ACTOR_IS_MAPPED(e)      ((e)->flags & CLUTTER_ACTOR_MAPPED)  

CLUTTER_ACTOR_IS_REALIZED()

#define CLUTTER_ACTOR_IS_REALIZED(e)    ((e)->flags & CLUTTER_ACTOR_REALIZED)

CLUTTER_ACTOR_IS_VISIBLE()

#define             CLUTTER_ACTOR_IS_VISIBLE(e)

ClutterActorBox

typedef struct {
  ClutterUnit x1;
  ClutterUnit y1;
  ClutterUnit x2;
  ClutterUnit y2;
} ClutterActorBox;

Bounding box of an actor. The coordinates of the top left and right bottom corners of an actor. The coordinates of the two points are expressed in ClutterUnits, that is are device-independent. If you want to obtain the box dimensions in pixels, use clutter_actor_get_geometry().

enum ClutterActorFlags

typedef enum
{
  CLUTTER_ACTOR_MAPPED   = 1 << 1,
  CLUTTER_ACTOR_REALIZED = 1 << 2
} ClutterActorFlags;

Flags used to signal the state of an actor.

ClutterGeometry

typedef struct {
  gint   x;
  gint   y;
  guint  width;
  guint  height;
} ClutterGeometry;

Rectangle containing an actor.

CLUTTER_CALLBACK()

#define CLUTTER_CALLBACK(f)	((ClutterCallback) (f))

ClutterCallback ()

void                (*ClutterCallback)                  (ClutterActor *actor,
                                                         gpointer data);

Generic callback

ClutterActor

typedef struct {
  guint32 flags;
} ClutterActor;

Base class for actors.

ClutterActorClass

typedef struct {
  void (* show)            (ClutterActor        *actor);
  void (* show_all)        (ClutterActor        *actor);
  void (* hide)            (ClutterActor        *actor);
  void (* hide_all)        (ClutterActor        *actor);
  void (* realize)         (ClutterActor        *actor);
  void (* unrealize)       (ClutterActor        *actor);
  void (* paint)           (ClutterActor        *actor);
  void (* request_coords)  (ClutterActor        *actor,
			    ClutterActorBox     *box);
  void (* query_coords)    (ClutterActor        *actor,
			    ClutterActorBox     *box);
  void (* set_depth)       (ClutterActor        *actor,
		            gint                 depth);
  gint (* get_depth)       (ClutterActor        *actor);
  void (* parent_set)      (ClutterActor        *actor,
                            ClutterActor        *old_parent);

  void (* destroy)         (ClutterActor        *actor);
  void (* pick)            (ClutterActor        *actor,
                            const ClutterColor  *color);
} ClutterActorClass;

Base class for actors.

clutter_actor_show ()

void                clutter_actor_show                  (ClutterActor *self);

Flags a clutter actor to be displayed. An actor not shown will not appear on the display.

clutter_actor_show_all ()

void                clutter_actor_show_all              (ClutterActor *self);

Call show() on all children of a actor (if any).

Since 0.2

clutter_actor_hide ()

void                clutter_actor_hide                  (ClutterActor *self);

Flags a clutter actor to be hidden. An actor not shown will not appear on the display.

clutter_actor_hide_all ()

void                clutter_actor_hide_all              (ClutterActor *self);

Call hide() on all child actors (if any).

Since 0.2

clutter_actor_realize ()

void                clutter_actor_realize               (ClutterActor *self);

Creates any underlying graphics resources needed by the actor to be displayed.

clutter_actor_unrealize ()

void                clutter_actor_unrealize             (ClutterActor *self);

Frees up any underlying graphics resources needed by the actor to be displayed.

clutter_actor_paint ()

void                clutter_actor_paint                 (ClutterActor *self);

Renders the actor to display.

This function should not be called directly by applications instead clutter_actor_queue_redraw should be used to queue paints.

clutter_actor_queue_redraw ()

void                clutter_actor_queue_redraw          (ClutterActor *self);

Queues up a redraw of an actor and any children. The redraw occurs once the main loop becomes idle (after the current batch of events has been processed, roughly).

Applications rarely need to call this as redraws are handled automatically by modification functions.

clutter_actor_destroy ()

void                clutter_actor_destroy               (ClutterActor *self);

Destroys an actor. When an actor is destroyed, it will break any references it holds to other objects. If the actor is inside a group, the actor will be removed from the group.

When you destroy a group its children will be destroyed as well.

clutter_actor_request_coords ()

void                clutter_actor_request_coords        (ClutterActor *self,
                                                         ClutterActorBox *box);

Requests new untransformed co-ordinates for the ClutterActor ralative to any parent.

This function should not be called directly by applications instead the various position/geometry methods should be used.

clutter_actor_query_coords ()

void                clutter_actor_query_coords          (ClutterActor *self,
                                                         ClutterActorBox *box);

Requests the untransformed co-ordinates (in ClutterUnits) for the ClutterActor relative to any parent.

This function should not be called directly by applications instead the various position/geometry methods should be used.

clutter_actor_set_geometry ()

void                clutter_actor_set_geometry          (ClutterActor *self,
                                                         const ClutterGeometry *geometry);

Sets the actors untransformed geometry in pixels relative to any parent actor.

clutter_actor_get_geometry ()

void                clutter_actor_get_geometry          (ClutterActor *self,
                                                         ClutterGeometry *geometry);

Gets the actors untransformed geometry in pixels relative to any parent actor.

clutter_actor_get_coords ()

void                clutter_actor_get_coords            (ClutterActor *self,
                                                         gint *x_1,
                                                         gint *y_1,
                                                         gint *x_2,
                                                         gint *y_2);

Gets the actors untransformed bounding rectangle co-ordinates in pixels relative to any parent actor.

clutter_actor_set_size ()

void                clutter_actor_set_size              (ClutterActor *self,
                                                         gint width,
                                                         gint height);

Sets the actors size in pixels.

clutter_actor_get_size ()

void                clutter_actor_get_size              (ClutterActor *self,
                                                         guint *width,
                                                         guint *height);

Gets the size of an actor in pixels ignoring any scaling factors.

Since 0.2

clutter_actor_set_position ()

void                clutter_actor_set_position          (ClutterActor *self,
                                                         gint x,
                                                         gint y);

Sets the actors position in pixels relative to any parent actor.

clutter_actor_get_abs_position ()

void                clutter_actor_get_abs_position      (ClutterActor *self,
                                                         gint *x,
                                                         gint *y);

Gets the absolute position of an actor in pixels relative to the stage.

clutter_actor_set_width ()

void                clutter_actor_set_width             (ClutterActor *self,
                                                         guint width);

Requests a new width for actor

Since 2.0

clutter_actor_get_width ()

guint               clutter_actor_get_width             (ClutterActor *self);

Retrieves the actors width ignoring any scaling factors.

clutter_actor_set_height ()

void                clutter_actor_set_height            (ClutterActor *self,
                                                         guint height);

Requests a new height for actor

Since 2.0

clutter_actor_get_height ()

guint               clutter_actor_get_height            (ClutterActor *self);

Retrieves the actors height ignoring any scaling factors.

clutter_actor_get_x ()

gint                clutter_actor_get_x                 (ClutterActor *self);

Retrieves the actors x position relative to any parent.

clutter_actor_get_y ()

gint                clutter_actor_get_y                 (ClutterActor *self);

Retrieves the actors y position relative to any parent.

clutter_actor_move_by ()

void                clutter_actor_move_by               (ClutterActor *self,
                                                         gint dx,
                                                         gint dy);

Moves an actor by specified distance relative to current position in pixels.

Since 0.2

clutter_actor_rotate_x ()

void                clutter_actor_rotate_x              (ClutterActor *self,
                                                         gfloat angle,
                                                         gint y,
                                                         gint z);

Rotates actor around the X axis.

clutter_actor_rotate_y ()

void                clutter_actor_rotate_y              (ClutterActor *self,
                                                         gfloat angle,
                                                         gint x,
                                                         gint z);

Rotates actor around the X axis.

clutter_actor_rotate_z ()

void                clutter_actor_rotate_z              (ClutterActor *self,
                                                         gfloat angle,
                                                         gint x,
                                                         gint y);

Rotates actor around the Z axis.

clutter_actor_set_opacity ()

void                clutter_actor_set_opacity           (ClutterActor *self,
                                                         guint8 opacity);

Sets the actors opacity, with zero being completely transparent.

clutter_actor_get_opacity ()

guint8              clutter_actor_get_opacity           (ClutterActor *self);

Retrieves the actors opacity.

clutter_actor_set_name ()

void                clutter_actor_set_name              (ClutterActor *self,
                                                         const gchar *name);

Sets a textual tag to the actor.

clutter_actor_get_name ()

const gchar*        clutter_actor_get_name              (ClutterActor *self);

Retrieves the name of self.

clutter_actor_get_id ()

guint32             clutter_actor_get_id                (ClutterActor *self);

Retrieves the unique id for self.

clutter_actor_set_clip ()

void                clutter_actor_set_clip              (ClutterActor *self,
                                                         gint xoff,
                                                         gint yoff,
                                                         gint width,
                                                         gint height);

Sets clip area in pixels for self.

clutter_actor_remove_clip ()

void                clutter_actor_remove_clip           (ClutterActor *self);

Removes clip area in pixels from self.

clutter_actor_has_clip ()

gboolean            clutter_actor_has_clip              (ClutterActor *self);

Gets whether the actor has a clip set or not.

Since 0.1.1

clutter_actor_set_parent ()

void                clutter_actor_set_parent            (ClutterActor *self,
                                                         ClutterActor *parent);

Sets the parent of self to parent. The opposite function is clutter_actor_unparent().

This function should not be used by applications but by custom 'composite' actor sub classes.

clutter_actor_get_parent ()

ClutterActor*       clutter_actor_get_parent            (ClutterActor *self);

Retrieves the parent of self.

clutter_actor_reparent ()

void                clutter_actor_reparent              (ClutterActor *self,
                                                         ClutterActor *new_parent);

This function resets the parent actor of self. It is logically equivalent to calling clutter_actory_unparent() and clutter_actor_set_parent().

Since 0.2

clutter_actor_unparent ()

void                clutter_actor_unparent              (ClutterActor *self);

This function should not be used in applications. It should be called by implementations of group actors, to dissociate a child from the container.

Since 0.1.1

clutter_actor_raise ()

void                clutter_actor_raise                 (ClutterActor *self,
                                                         ClutterActor *below);

Puts self above below. Both actors must have the same parent.

clutter_actor_lower ()

void                clutter_actor_lower                 (ClutterActor *self,
                                                         ClutterActor *above);

Puts self below above. Both actors must have the same parent.

clutter_actor_raise_top ()

void                clutter_actor_raise_top             (ClutterActor *self);

Raises self to the top.

clutter_actor_lower_bottom ()

void                clutter_actor_lower_bottom          (ClutterActor *self);

Lowers self to the bottom.

clutter_actor_set_depth ()

void                clutter_actor_set_depth             (ClutterActor *self,
                                                         gint depth);

Sets the Z co-ordinate of self to depth. The Units of which are dependant on the perspective setup.

clutter_actor_get_depth ()

gint                clutter_actor_get_depth             (ClutterActor *self);

Retrieves the depth of self.

clutter_actor_set_scalex ()

void                clutter_actor_set_scalex            (ClutterActor *self,
                                                         ClutterFixed scale_x,
                                                         ClutterFixed scale_y);

Scales an actor with fixed point parameters.

clutter_actor_set_scale ()

void                clutter_actor_set_scale             (ClutterActor *self,
                                                         gdouble scale_x,
                                                         gdouble scale_y);

Scales an actor with floating point parameters.

Since 0.2

clutter_actor_get_scalex ()

void                clutter_actor_get_scalex            (ClutterActor *self,
                                                         ClutterFixed *scale_x,
                                                         ClutterFixed *scale_y);

Retrieves an actors scale in fixed point.

Since 0.2

clutter_actor_get_scale ()

void                clutter_actor_get_scale             (ClutterActor *self,
                                                         gdouble *scale_x,
                                                         gdouble *scale_y);

Retrieves an actors scale in floating point.

Since 0.2

clutter_actor_get_abs_size ()

void                clutter_actor_get_abs_size          (ClutterActor *self,
                                                         guint *width,
                                                         guint *height);

Gets the absolute size of an actor taking into account an scaling factors

clutter_actor_apply_transform_to_point ()

void                clutter_actor_apply_transform_to_point
                                                        (ClutterActor *self,
                                                         ClutterVertex *point,
                                                         ClutterVertex *vertex);

Transforms point in coordinates relative to the actor into screen coordiances

Since 0.4

clutter_actor_get_rxang ()

gdouble             clutter_actor_get_rxang             (ClutterActor *self);

Gets the angle of rotation around the X axis.

Since 0.4

clutter_actor_get_ryang ()

gdouble             clutter_actor_get_ryang             (ClutterActor *self);

Gets the angle of rotation around the Y axis.

Since 0.4

clutter_actor_get_rzang ()

gdouble             clutter_actor_get_rzang             (ClutterActor *self);

Gets the angle of rotation around the Z axis.

Since 0.4

clutter_actor_get_rxangx ()

ClutterFixed        clutter_actor_get_rxangx            (ClutterActor *self);

Gets the angle of rotation around the X axis.

Since 0.4

clutter_actor_get_ryangx ()

ClutterFixed        clutter_actor_get_ryangx            (ClutterActor *self);

Gets the angle of rotation around the Y axis.

Since 0.4

clutter_actor_get_rzangx ()

ClutterFixed        clutter_actor_get_rzangx            (ClutterActor *self);

Gets the angle of rotation around x axis in degrees.

Since 0.4

ClutterVertex

typedef struct {
  ClutterUnit x;
  ClutterUnit y;
  ClutterUnit z;
} ClutterVertex;

Vertex of an actor in 3D space, expressed in device independent units.

Since 0.4

clutter_actor_get_vertices ()

void                clutter_actor_get_vertices          (ClutterActor *self,
                                                         ClutterVertex verts[4]);

Calculates the tranformed screen coordinaces of the four corners of the actor; the returned vertices relate to the ClutterActoBox coordinances as follows:

v[0] contains (x1, y1) v[1] contains (x2, y1) v[2] contains (x1, y2) v[3] contains (x2, y2)

Since 0.4

clutter_actor_pick ()

void                clutter_actor_pick                  (ClutterActor *self,
                                                         const ClutterColor *color);

Renders a silhouette of the actor in supplied color.

This function should not never be called directly by applications.

clutter_actor_rotate_xx ()

void                clutter_actor_rotate_xx             (ClutterActor *self,
                                                         ClutterFixed angle,
                                                         gint y,
                                                         gint z);

Rotates actor around the X axis.

clutter_actor_rotate_yx ()

void                clutter_actor_rotate_yx             (ClutterActor *self,
                                                         ClutterFixed angle,
                                                         gint x,
                                                         gint z);

Rotates actor around the X axis.

clutter_actor_rotate_zx ()

void                clutter_actor_rotate_zx             (ClutterActor *self,
                                                         ClutterFixed angle,
                                                         gint x,
                                                         gint y);

Rotates actor around the Z axis.

clutter_actor_set_scale_with_gravity ()

void                clutter_actor_set_scale_with_gravity
                                                        (ClutterActor *self,
                                                         gfloat scale_x,
                                                         gfloat scale_y,
                                                         ClutterGravity gravity);

Scales the actor by scale_x, scale_y taking into consideration the required gravity.

Since 0.4

clutter_actor_set_scale_with_gravityx ()

void                clutter_actor_set_scale_with_gravityx
                                                        (ClutterActor *self,
                                                         ClutterFixed scale_x,
                                                         ClutterFixed scale_y,
                                                         ClutterGravity gravity);

Scales the actor by scale_x, scale_y taking into consideration the required gravity.

Since 0.4

The "clip" property

  "clip"                     ClutterGeometry       : Read / Write

The clip region for the actor.

The "has-clip" property

  "has-clip"                 gboolean              : Read

Whether the actor has the clip property set or not.

Default value: FALSE

The "height" property

  "height"                   gint                  : Read / Write

Height of the actor (in pixels).

Allowed values: >= 0

Default value: 0

The "name" property

  "name"                     gchararray            : Read / Write

The name of the actor.

Default value: NULL

Since 0.2

The "opacity" property

  "opacity"                  guchar                : Read / Write / Construct

Opacity of the actor.

Default value: 255

The "visible" property

  "visible"                  gboolean              : Read / Write

Whether the actor is visible or not.

Default value: FALSE

The "width" property

  "width"                    gint                  : Read / Write

Width of the actor (in pixels).

Allowed values: >= 0

Default value: 0

The "x" property

  "x"                        gint                  : Read / Write

X coordinate of the actor.

Allowed values: >= -2147483647

Default value: 0

The "y" property

  "y"                        gint                  : Read / Write

Y coordinate of the actor.

Allowed values: >= -2147483647

Default value: 0

The "destroy" signal

void                user_function                      (ClutterActor *actor,
                                                        gpointer      user_data)      : Cleanup / No Recursion / No Hooks

The ::destroy signal is emitted when an actor is destroyed, either by direct invocation of clutter_actor_destroy() or when the ClutterGroup that contains the actor is destroyed.

Since 0.2

The "hide" signal

void                user_function                      (ClutterActor *actor,
                                                        gpointer      user_data)      : Run First

The ::hide signal is emitted when an actor is no longer visible.

Since 0.2

The "parent-set" signal

void                user_function                      (ClutterActor *actor,
                                                        ClutterActor *old_parent,
                                                        gpointer      user_data)       : Run Last

This signal is emitted when the parent of the actor changes.

Since 0.2

The "show" signal

void                user_function                      (ClutterActor *actor,
                                                        gpointer      user_data)      : Run First

The ::show signal is emitted when an actor becomes visible.

Since 0.2