CLUTTER_ACTOR_SET_FLAGS()

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

Sets a flag from ClutterActorFlags to an actor

CLUTTER_ACTOR_UNSET_FLAGS()

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

Unsets a flag from ClutterActorFlags to an actor

CLUTTER_ACTOR_IS_MAPPED()

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

Evaluates to TRUE if an actor is mapped.

CLUTTER_ACTOR_IS_REALIZED()

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

Evaluates to TRUE if an actor has been realized.

CLUTTER_ACTOR_IS_VISIBLE()

#define             CLUTTER_ACTOR_IS_VISIBLE(e)

Evaluates to TRUE if an actor is visible.

ClutterActorBox

typedef struct {
 gint x1, y1, x2, y2; 
} ClutterActorBox;

Coordinates (top-left to bottom-right) of a box surrounding an actor.

enum ClutterActorFlags

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

Flags used by an actor.

ClutterGeometry

typedef struct {
  /* FIXME: 
   * It is likely gonna save a load of pain if we make 
   * x,y unsigned...
  */
  gint x;
  gint y;
  guint width;
  guint height;
} ClutterGeometry;

Positional and dimensional coordinates of an actor.

CLUTTER_CALLBACK()

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

Casts a generic callback function into a ClutterCallback

ClutterCallback ()

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

Generic callback function.

ClutterActor

typedef struct {
  GObject parent_instance;
  guint32 flags;
} ClutterActor;

Basic element of the Clutter canvas. Every object present on the stage must be an actor. You can scale, move and rotate an actor; you can group actors inside ClutterGroups or let them follow a ClutterBehaviour.

ClutterActorClass

typedef struct {
  GObjectClass parent_class;

  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 (* allocate_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);

  /* to go ? */
  void (* queue_redraw)    (ClutterActor    *actor);

  /* padding for future expansion */
  void (*_clutter_actor_1) (void);
  void (*_clutter_actor_2) (void);
  void (*_clutter_actor_3) (void);
  void (*_clutter_actor_4) (void);
  void (*_clutter_actor_5) (void);
  void (*_clutter_actor_6) (void);
} ClutterActorClass;

Base class for ClutterActor

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);

Recursively show an actor, and any child actor if self has child actors.

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);

Recursively hides an actor, and any child actor if self has child actors.

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 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_allocate_coords ()

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

Requests the allocated co-ordinates 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 geometry in pixels relative to any parent actor.

clutter_actor_get_geometry ()

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

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

clutter_actor_get_coords ()

void                clutter_actor_get_coords            (ClutterActor *self,
                                                         gint *x1,
                                                         gint *y1,
                                                         gint *x2,
                                                         gint *y2);

Gets the actors 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 position in pixels relative to any parent actor.

clutter_actor_get_size ()

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

Gets the size of an actor 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.

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.

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.

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 for self.

clutter_actor_remove_clip ()

void                clutter_actor_remove_clip           (ClutterActor *self);

Removes clip area 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.

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.

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);

Scale an actor.

clutter_actor_set_scale ()

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

FIXME

Since 0.2

clutter_actor_get_scalex ()

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

FIXME

Since 0.2

clutter_actor_get_scale ()

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

FIXME

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

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