CLUTTER_ACTOR_SET_FLAGS()

#define CLUTTER_ACTOR_SET_FLAGS(a,f)    (((ClutterActor*)(a))->flags |= (f))

Sets the given flags on a ClutterActor

CLUTTER_ACTOR_UNSET_FLAGS()

#define CLUTTER_ACTOR_UNSET_FLAGS(a,f)  (((ClutterActor*)(a))->flags &= ~(f))

Unsets the given flags on a ClutterActor

CLUTTER_ACTOR_IS_MAPPED()

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

Evaluates to TRUE if the CLUTTER_ACTOR_MAPPED flag is set.

Since 0.2

CLUTTER_ACTOR_IS_REALIZED()

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

Evaluates to TRUE if the CLUTTER_ACTOR_REALIZED flag is set.

Since 0.2

CLUTTER_ACTOR_IS_VISIBLE()

#define CLUTTER_ACTOR_IS_VISIBLE(e)     (CLUTTER_ACTOR_IS_MAPPED (e) && CLUTTER_ACTOR_IS_REALIZED (e))

Evaluates to TRUE if the actor is both realized and mapped.

Since 0.2

CLUTTER_ACTOR_IS_REACTIVE()

#define CLUTTER_ACTOR_IS_REACTIVE(e)    (((ClutterActor*)(e))->flags & CLUTTER_ACTOR_REACTIVE)

Evaluates to TRUE if the CLUTTER_ACTOR_REACTIVE flag is set.

Since 0.6

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,
  CLUTTER_ACTOR_REACTIVE = 1 << 3
} ClutterActorFlags;

Flags used to signal the state of an actor.

ClutterGeometry

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

The rectangle containing an actor's bounding box, measured in pixels.

CLUTTER_CALLBACK()

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

Convenience macro to cast a function to ClutterCallback

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 (* parent_set)      (ClutterActor        *actor,
                            ClutterActor        *old_parent);

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

  /* event signals */
  gboolean (* event)                (ClutterActor         *actor,
                                     ClutterEvent         *event);
  gboolean (* button_press_event)   (ClutterActor         *actor,
                                     ClutterButtonEvent   *event);
  gboolean (* button_release_event) (ClutterActor         *actor,
                                     ClutterButtonEvent   *event);
  gboolean (* scroll_event)         (ClutterActor         *actor,
                                     ClutterScrollEvent   *event);
  gboolean (* key_press_event)      (ClutterActor         *actor,
                                     ClutterKeyEvent      *event);
  gboolean (* key_release_event)    (ClutterActor         *actor,
                                     ClutterKeyEvent      *event);
  gboolean (* motion_event)         (ClutterActor         *actor,
                                     ClutterMotionEvent   *event);
  gboolean (* enter_event)          (ClutterActor         *actor,
                                     ClutterCrossingEvent *event);
  gboolean (* leave_event)          (ClutterActor         *actor,
                                     ClutterCrossingEvent *event);
  gboolean (* captured_event)       (ClutterActor         *actor,
                                     ClutterEvent         *event);
  void     (* focus_in)             (ClutterActor         *actor);
  void     (* focus_out)            (ClutterActor         *actor);
} ClutterActorClass;

Base class for actors.

clutter_actor_show ()

void                clutter_actor_show                  (ClutterActor *self);

Flags an actor to be displayed. An actor that isn't shown will not be rendered on the stage.

clutter_actor_show_all ()

void                clutter_actor_show_all              (ClutterActor *self);

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

Since 0.2

clutter_actor_hide ()

void                clutter_actor_hide                  (ClutterActor *self);

Flags an actor to be hidden. A hidden actor will not be rendered on the stage.

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. Call clutter_actor_queue_redraw() to queue paints, instead.

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 container, the actor will be removed.

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

Note: you cannot destroy the ClutterStage returned by clutter_stage_get_default().

clutter_actor_request_coords ()

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

Requests new untransformed coordinates for the bounding box of a ClutterActor. The coordinates must be relative to the current parent of the actor.

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

Note: Actors overriding the ClutterActor::request_coords() virtual function should always chain up to the parent class request_coords() method. Actors should override this function only if they need to recompute some internal state or need to reposition their children.

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. The various position/geometry methods should be used instead.

clutter_actor_event ()

gboolean            clutter_actor_event                 (ClutterActor *actor,
                                                         ClutterEvent *event,
                                                         gboolean capture);

This function is used to emit an event on the main stage. You should rarely need to use this function, except for synthetising events.

Since 0.6

clutter_actor_pick ()

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

Renders a silhouette of the actor using the supplied color. Used internally for mapping pointer events to actors.

This function should never be called directly by applications.

Subclasses overiding the ClutterActor::pick() method should call clutter_actor_should_pick_paint() to decide whether to render their silhouette. Containers should always recursively call pick for each child.

Since 0.4

clutter_actor_should_pick_paint ()

gboolean            clutter_actor_should_pick_paint     (ClutterActor *self);

Utility call for subclasses overiding the pick method.

This function should never be called directly by applications.

clutter_actor_set_geometry ()

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

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

clutter_actor_get_geometry ()

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

Gets the actor's 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 actor's untransformed bounding rectangle coordinates in pixels relative to any parent actor.

clutter_actor_set_size ()

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

Sets the actor's size in pixels.

If width and/or height are -1 the actor will assume the same size of its bounding box.

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 actor's position in pixels relative to any parent actor.

clutter_actor_get_position ()

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

Retrieves the position of an actor.

Since 0.6

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 the actor

Since 0.2

clutter_actor_get_width ()

guint               clutter_actor_get_width             (ClutterActor *self);

Retrieves the actor's width ignoring any scaling factors.

clutter_actor_set_height ()

void                clutter_actor_set_height            (ClutterActor *self,
                                                         guint height);

Requests a new height for the actor

Since 0.2

clutter_actor_get_height ()

guint               clutter_actor_get_height            (ClutterActor *self);

Retrieves the actor's height ignoring any scaling factors.

clutter_actor_set_x ()

void                clutter_actor_set_x                 (ClutterActor *self,
                                                         gint x);

Sets the actor's X coordinate, relative to its parent.

Since 0.6

clutter_actor_get_x ()

gint                clutter_actor_get_x                 (ClutterActor *self);

Retrieves the actor's X coordinate, relative to any parent.

clutter_actor_set_y ()

void                clutter_actor_set_y                 (ClutterActor *self,
                                                         gint y);

Sets the actor's Y coordinate, relative to its parent.

Since 0.6

clutter_actor_get_y ()

gint                clutter_actor_get_y                 (ClutterActor *self);

Retrieves the actor's Y coordinate, relative to any parent.

clutter_actor_move_by ()

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

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

Since 0.2

clutter_actor_set_rotation ()

void                clutter_actor_set_rotation          (ClutterActor *self,
                                                         ClutterRotateAxis axis,
                                                         gdouble angle,
                                                         gint x,
                                                         gint y,
                                                         gint z);

Sets the rotation angle of self around the given axis.

The rotation center coordinates used depend on the value of axis:

The rotation coordinates are relative to the anchor point of the actor, set using clutter_actor_set_anchor_point(). If no anchor point is set, the upper left corner is assumed as the origin.

Since 0.6

clutter_actor_get_rotation ()

gdouble             clutter_actor_get_rotation          (ClutterActor *self,
                                                         ClutterRotateAxis axis,
                                                         gint *x,
                                                         gint *y,
                                                         gint *z);

Retrieves the angle and center of rotation on the given axis, set using clutter_actor_set_angle().

The coordinates of the center returned by this function depend on the axis passed.

Since 0.6

clutter_actor_is_rotated ()

gboolean            clutter_actor_is_rotated            (ClutterActor *self);

Checks whether any rotation is applied to the actor.

Since 0.6

clutter_actor_set_opacity ()

void                clutter_actor_set_opacity           (ClutterActor *self,
                                                         guint8 opacity);

Sets the actor's opacity, with zero being completely transparent and 255 (0xff) being fully opaque.

clutter_actor_get_opacity ()

guint8              clutter_actor_get_opacity           (ClutterActor *self);

Retrieves the actor's opacity.

clutter_actor_set_name ()

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

Sets the given name to self. The name can be used to identify a ClutterActor.

clutter_actor_get_name ()

const gchar*        clutter_actor_get_name              (ClutterActor *self);

Retrieves the name of self.

clutter_actor_get_gid ()

guint32             clutter_actor_get_gid               (ClutterActor *self);

Retrieves the unique id for self.

Since 0.6

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. The clip area is always computed from the upper left corner of the actor, even if the anchor point is set otherwise.

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

Determines whether the actor has a clip area set or not.

Since 0.1.1

clutter_actor_get_clip ()

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

Gets the clip area for self, in pixels.

Since 0.6

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 subclasses.

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_actor_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 container 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_scale ()

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

Scales an actor with the given factors. The scaling is always relative to the anchor 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_is_scaled ()

gboolean            clutter_actor_is_scaled             (ClutterActor *self);

Checks whether the actor is scaled in either dimension.

Since 0.6

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-relative coordinates with the current actor transformation (i.e. scale, rotation, etc)

Since 0.4

clutter_actor_transform_stage_point ()

gboolean            clutter_actor_transform_stage_point (ClutterActor *self,
                                                         ClutterUnit x,
                                                         ClutterUnit y,
                                                         ClutterUnit *x_out,
                                                         ClutterUnit *y_out);

This function translates screen coordinates (x, y) to coordinates relative to the actor. For example, it can be used to translate screen events from global screen coordinates into actor-local coordinates.

The conversion can fail, notably if the transform stack results in the actor being projected on the screen as a mere line.

The conversion should not be expected to be pixel-perfect due to the nature of the operation. In general the error grows when the skewing of the actor rectangle on screen increases.

Note: This function is fairly computationally intensive.

Since 0.6

clutter_actor_apply_relative_transform_to_point ()

void                clutter_actor_apply_relative_transform_to_point
                                                        (ClutterActor *self,
                                                         ClutterActor *ancestor,
                                                         ClutterVertex *point,
                                                         ClutterVertex *vertex);

Transforms point in coordinates relative to the actor into ancestor-relative coordinates using the relevant transform stack (i.e. scale, rotation, etc).

If ancestor is NULL the ancestor will be the ClutterStage. In this case, the coordinates returned will be the coordinates on the stage before the projection is applied. This is different from the behaviour of clutter_actor_apply_transform_to_point().

Since 0.6

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 transformed screen coordinates of the four corners of the actor; the returned vertices relate to the ClutterActorBox coordinates as follows:

Since 0.4

clutter_actor_get_relative_vertices ()

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

Calculates the transformed coordinates of the four corners of the actor in the plane of ancestor. The returned vertices relate to the ClutterActorBox coordinates as follows:

If ancestor is NULL the ancestor will be the ClutterStage. In this case, the coordinates returned will be the coordinates on the stage before the projection is applied. This is different from the behaviour of clutter_actor_get_vertices().

Since 0.6

clutter_actor_box_get_from_vertices ()

void                clutter_actor_box_get_from_vertices (ClutterVertex vtx[4],
                                                         ClutterActorBox *box);

Calculates the bounding box represented by the four vertices; for details of the vertex array see clutter_actor_get_vertices().

Since 0.6

clutter_actor_set_anchor_point ()

void                clutter_actor_set_anchor_point      (ClutterActor *self,
                                                         gint anchor_x,
                                                         gint anchor_y);

Sets an anchor point for the actor. The anchor point is a point in the coordinate space of an actor to which the actor position within its parent is relative; the default is (0, 0), i.e. the top-left corner of the actor.

Since 0.6

clutter_actor_get_anchor_point ()

void                clutter_actor_get_anchor_point      (ClutterActor *self,
                                                         gint *anchor_x,
                                                         gint *anchor_y);

Gets the current anchor point of the actor in pixels.

Since 0.6

clutter_actor_set_anchor_point_from_gravity ()

void                clutter_actor_set_anchor_point_from_gravity
                                                        (ClutterActor *self,
                                                         ClutterGravity gravity);

Sets an anchor point on the actor, based on the given gravity (this is a convenience function wrapping clutter_actor_set_anchor_point()).

Since 0.6

clutter_actor_move_anchor_point ()

void                clutter_actor_move_anchor_point     (ClutterActor *self,
                                                         gint anchor_x,
                                                         gint anchor_y);

Sets an anchor point for the actor, and adjusts the actor postion so that the relative position of the actor toward its parent remains the same.

Since 0.6

clutter_actor_move_anchor_point_from_gravity ()

void                clutter_actor_move_anchor_point_from_gravity
                                                        (ClutterActor *self,
                                                         ClutterGravity gravity);

Sets an anchor point on the actor based on the given gravity, adjusting the actor postion so that its relative position within its parent remains unchanged.

Since 0.6

clutter_actor_set_reactive ()

void                clutter_actor_set_reactive          (ClutterActor *actor,
                                                         gboolean reactive);

Sets actor as reactive. Reactive actors will receive events.

Since 0.6

clutter_actor_get_reactive ()

gboolean            clutter_actor_get_reactive          (ClutterActor *actor);

Checks whether actor is marked as reactive.

Since 0.6

clutter_actor_set_shader ()

gboolean            clutter_actor_set_shader            (ClutterActor *self,
                                                         ClutterShader *shader);

Sets the ClutterShader to be used when rendering self. If shader is NULL it will unset any currently set shader for the actor.

Since 0.6

clutter_actor_get_shader ()

ClutterShader*      clutter_actor_get_shader            (ClutterActor *self);

Queries the currently set ClutterShader on self.

Since 0.6

clutter_actor_set_shader_param ()

void                clutter_actor_set_shader_param      (ClutterActor *self,
                                                         const gchar *param,
                                                         gfloat value);

Sets the value for a named parameter of the shader applied to actor.

Since 0.6

clutter_actor_set_depthu ()

void                clutter_actor_set_depthu            (ClutterActor *self,
                                                         ClutterUnit depth);

Sets the Z co-ordinate of self to depth in ClutterUnits, the units of which are dependant on the perspective setup.

clutter_actor_get_depthu ()

ClutterUnit         clutter_actor_get_depthu            (ClutterActor *self);

Retrieves the depth of self.

Since 0.6

clutter_actor_set_heightu ()

void                clutter_actor_set_heightu           (ClutterActor *self,
                                                         ClutterUnit height);

Requests a new height for the actor

Since 0.6

clutter_actor_get_heightu ()

ClutterUnit         clutter_actor_get_heightu           (ClutterActor *self);

Retrieves the actor's height ignoring any scaling factors.

Since 0.6

clutter_actor_set_widthu ()

void                clutter_actor_set_widthu            (ClutterActor *self,
                                                         ClutterUnit width);

Requests a new width for the actor

Since 0.6

clutter_actor_get_widthu ()

ClutterUnit         clutter_actor_get_widthu            (ClutterActor *self);

Retrieves the actor's width ignoring any scaling factors.

Since 0.6

clutter_actor_set_xu ()

void                clutter_actor_set_xu                (ClutterActor *self,
                                                         ClutterUnit x);

Sets the actor's X coordinate, relative to its parent.

Since 0.6

clutter_actor_get_xu ()

ClutterUnit         clutter_actor_get_xu                (ClutterActor *self);

Retrieves the actor's X coordinate, relative to any parent, in ClutterUnits.

Since 0.6

clutter_actor_set_yu ()

void                clutter_actor_set_yu                (ClutterActor *self,
                                                         ClutterUnit y);

Sets the actor's Y coordinate, relative to its parent.

Since 0.6

clutter_actor_get_yu ()

ClutterUnit         clutter_actor_get_yu                (ClutterActor *self);

Retrieves the actor's Y coordinate, relative to any parent, in ClutterUnits.

clutter_actor_set_positionu ()

void                clutter_actor_set_positionu         (ClutterActor *self,
                                                         ClutterUnit x,
                                                         ClutterUnit y);

Sets the actor's position in ClutterUnits relative to any parent actor.

Since 0.6

clutter_actor_get_positionu ()

void                clutter_actor_get_positionu         (ClutterActor *self,
                                                         ClutterUnit *x,
                                                         ClutterUnit *y);

Retrieves the position of an actor in ClutterUnits.

Since 0.6

clutter_actor_set_sizeu ()

void                clutter_actor_set_sizeu             (ClutterActor *self,
                                                         ClutterUnit width,
                                                         ClutterUnit height);

Sets the actor's size in ClutterUnits. If width and/or height are -1 the actor will assume the same size as its bounding box.

Since 0.6

clutter_actor_get_sizeu ()

void                clutter_actor_get_sizeu             (ClutterActor *self,
                                                         ClutterUnit *width,
                                                         ClutterUnit *height);

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

Since 0.6

clutter_actor_set_anchor_pointu ()

void                clutter_actor_set_anchor_pointu     (ClutterActor *self,
                                                         ClutterUnit anchor_x,
                                                         ClutterUnit anchor_y);

Sets an anchor point for self. The anchor point is a point in the coordinate space of an actor to which the actor position within its parent is relative; the default is (0, 0), i.e. the top-left corner of the actor.

Since 0.6

clutter_actor_get_anchor_pointu ()

void                clutter_actor_get_anchor_pointu     (ClutterActor *self,
                                                         ClutterUnit *anchor_x,
                                                         ClutterUnit *anchor_y);

Gets the current anchor point of the actor in ClutterUnits.

Since 0.6

clutter_actor_move_anchor_pointu ()

void                clutter_actor_move_anchor_pointu    (ClutterActor *self,
                                                         ClutterUnit anchor_x,
                                                         ClutterUnit anchor_y);

Sets an anchor point for the actor, and adjusts the actor postion so that the relative position of the actor toward its parent remains the same.

Since 0.6

clutter_actor_set_clipu ()

void                clutter_actor_set_clipu             (ClutterActor *self,
                                                         ClutterUnit xoff,
                                                         ClutterUnit yoff,
                                                         ClutterUnit width,
                                                         ClutterUnit height);

Unit-based variant of clutter_actor_set_clip()

Sets clip area for self. The clip area is always computed from the upper left corner of the actor, even if the anchor point is set otherwise.

Since 0.6

clutter_actor_get_clipu ()

void                clutter_actor_get_clipu             (ClutterActor *self,
                                                         ClutterUnit *xoff,
                                                         ClutterUnit *yoff,
                                                         ClutterUnit *width,
                                                         ClutterUnit *height);

Unit-based variant of clutter_actor_get_clip().

Gets the clip area for self, in ClutterUnits.

Since 0.6

clutter_actor_move_byu ()

void                clutter_actor_move_byu              (ClutterActor *self,
                                                         ClutterUnit dx,
                                                         ClutterUnit dy);

Moves an actor by the specified distance relative to its current position.

Since 0.6

clutter_actor_set_scalex ()

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

Fixed point version of clutter_actor_set_scale().

Scales an actor with the given factors. The scaling is always relative to the anchor point.

clutter_actor_get_scalex ()

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

Fixed point version of clutter_actor_get_scale().

Retrieves the scale factors of an actor.

Since 0.2

clutter_actor_set_rotationx ()

void                clutter_actor_set_rotationx         (ClutterActor *self,
                                                         ClutterRotateAxis axis,
                                                         ClutterFixed angle,
                                                         gint x,
                                                         gint y,
                                                         gint z);

Sets the rotation angle of self around the given axis.

This function is the fixed point variant of clutter_actor_set_rotation().

Since 0.6

clutter_actor_get_rotationx ()

ClutterFixed        clutter_actor_get_rotationx         (ClutterActor *self,
                                                         ClutterRotateAxis axis,
                                                         gint *x,
                                                         gint *y,
                                                         gint *z);

Retrieves the angle and center of rotation on the given axis, set using clutter_actor_set_rotation().

This function is the fixed point variant of clutter_actor_get_rotation().

Since 0.6

The "clip" property

  "clip"                     ClutterGeometry       : Read / Write

The clip region for the actor.

The "depth" property

  "depth"                    gint                  : Read / Write

Depth of the actor.

Allowed values: >= -2147483647

Default value: 0

Since 0.6

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

Opacity of the actor.

Default value: 255

The "reactive" property

  "reactive"                 gboolean              : Read / Write

Whether the actor is reactive to events or not.

Default value: FALSE

Since 0.6

The "rotation-angle-x" property

  "rotation-angle-x"         gdouble               : Read / Write

The rotation angle on the X axis.

Allowed values: >= 0

Default value: 0

The "rotation-angle-y" property

  "rotation-angle-y"         gdouble               : Read / Write

The rotation angle on the Y axis.

Allowed values: >= 0

Default value: 0

The "rotation-angle-z" property

  "rotation-angle-z"         gdouble               : Read / Write

The rotation angle on the Z axis.

Allowed values: >= 0

Default value: 0

The "rotation-center-x" property

  "rotation-center-x"        ClutterVertex         : Read / Write

The rotation center on the X axis.

The "rotation-center-y" property

  "rotation-center-y"        ClutterVertex         : Read / Write

The rotation center on the Y axis.

The "rotation-center-z" property

  "rotation-center-z"        ClutterVertex         : Read / Write

The rotation center on the Z axis.

The "scale-x" property

  "scale-x"                  gdouble               : Read / Write

Scale factor on the X axis.

Allowed values: >= 0

Default value: 1

The "scale-y" property

  "scale-y"                  gdouble               : Read / Write

Scale factor on the Y axis.

Allowed values: >= 0

Default value: 1

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 "button-press-event" signal

gboolean            user_function                      (ClutterActor *actor,
                                                        ClutterEvent *event,
                                                        gpointer      user_data)      : Run Last

The ::button-press-event signal is emitted each time a mouse button is pressed on actor.

Since 0.6

The "button-release-event" signal

gboolean            user_function                      (ClutterActor *actor,
                                                        ClutterEvent *event,
                                                        gpointer      user_data)      : Run Last

The ::button-release-event signal is emitted each time a mouse button is released on actor.

Since 0.6

The "captured-event" signal

gboolean            user_function                      (ClutterActor *actor,
                                                        ClutterEvent *event,
                                                        gpointer      user_data)      : Run Last

The ::captured-event signal is emitted when an event is captured by Clutter. This signal will be emitted starting from the top-level container (the ClutterStage) to the actor which received the event going down the hierarchy. This signal can be used to intercept every event before the specialized events (like ClutterActor::button-press-event or ::key-released-event) are emitted.

Since 0.6

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 "enter-event" signal

gboolean            user_function                      (ClutterActor *actor,
                                                        ClutterEvent *event,
                                                        gpointer      user_data)      : Run Last

The ::enter-event signal is emitted when the pointer enters the actor

Since 0.6

The "event" signal

gboolean            user_function                      (ClutterActor *actor,
                                                        ClutterEvent *event,
                                                        gpointer      user_data)      : Run Last

The ::event signal is emitted each time an event is received by the actor. This signal will be emitted on every actor, following the hierarchy chain, until it reaches the top-level container (the ClutterStage).

Since 0.6

The "focus-in" signal

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

The ::focus-in signal is emitted when actor recieves key focus.

Since 0.6

The "focus-out" signal

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

The ::focus-out signal is emitted when actor loses key focus.

Since 0.6

The "hide" signal

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

The ::hide signal is emitted when an actor is no longer rendered on the stage.

Since 0.2

The "key-press-event" signal

gboolean            user_function                      (ClutterActor *actor,
                                                        ClutterEvent *event,
                                                        gpointer      user_data)      : Run Last

The ::key-press-event signal is emitted each time a keyboard button is pressed while actor has key focus (see clutter_stage_set_key_focus()).

Since 0.6

The "key-release-event" signal

gboolean            user_function                      (ClutterActor *actor,
                                                        ClutterEvent *event,
                                                        gpointer      user_data)      : Run Last

The ::key-release-event signal is emitted each time a keyboard button is released while actor has key focus (see clutter_stage_set_key_focus()).

Since 0.6

The "leave-event" signal

gboolean            user_function                      (ClutterActor *actor,
                                                        ClutterEvent *event,
                                                        gpointer      user_data)      : Run Last

The ::leave-event signal is emitted when the pointer leaves the actor.

Since 0.6

The "motion-event" signal

gboolean            user_function                      (ClutterActor *actor,
                                                        ClutterEvent *event,
                                                        gpointer      user_data)      : Run Last

The ::motion-event signal is emitted each time the mouse pointer is moved over actor.

Since 0.6

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 "scroll-event" signal

gboolean            user_function                      (ClutterActor *actor,
                                                        ClutterEvent *event,
                                                        gpointer      user_data)      : Run Last

The ::scroll-event signal is emitted each time the mouse is scrolled on actor

Since 0.6

The "show" signal

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

The ::show signal is emitted when an actor is visible and rendered on the stage.

Since 0.2