![]() |
![]() |
![]() |
Clutter 0.0 Reference Manual | ![]() |
---|---|---|---|---|
#define CLUTTER_TYPE_GEOMETRY #define CLUTTER_TYPE_ACTOR_BOX #define CLUTTER_ACTOR_SET_FLAGS (e,f) #define CLUTTER_ACTOR_UNSET_FLAGS (e,f) #define CLUTTER_ACTOR_IS_MAPPED (e) #define CLUTTER_ACTOR_IS_REALIZED (e) #define CLUTTER_ACTOR_IS_VISIBLE (e) ClutterActorBox; ClutterActorPrivate; ClutterGeometry; void (*ClutterCallback) (ClutterActor *actor, gpointer data); enum ClutterActorFlags; GType clutter_actor_box_get_type (void); ClutterActor; GType clutter_actor_get_type (void); void clutter_actor_show (ClutterActor *self); void clutter_actor_hide (ClutterActor *self); void clutter_actor_realize (ClutterActor *self); void clutter_actor_unrealize (ClutterActor *self); void clutter_actor_paint (ClutterActor *self); void clutter_actor_queue_redraw (ClutterActor *self); void clutter_actor_request_coords (ClutterActor *self, ClutterActorBox *box); void clutter_actor_allocate_coords (ClutterActor *self, ClutterActorBox *box); void clutter_actor_set_geometry (ClutterActor *self, ClutterGeometry *geom); void clutter_actor_get_geometry (ClutterActor *self, ClutterGeometry *geom); void clutter_actor_get_coords (ClutterActor *self, gint *x1, gint *y1, gint *x2, gint *y2); void clutter_actor_set_position (ClutterActor *self, gint x, gint y); void clutter_actor_set_size (ClutterActor *self, gint width, gint height); void clutter_actor_get_abs_position (ClutterActor *self, gint *x, gint *y); guint clutter_actor_get_width (ClutterActor *self); guint clutter_actor_get_height (ClutterActor *self); gint clutter_actor_get_x (ClutterActor *self); gint clutter_actor_get_y (ClutterActor *self); void clutter_actor_rotate_z (ClutterActor *self, gfloat angle, gint x, gint y); void clutter_actor_rotate_x (ClutterActor *self, gfloat angle, gint y, gint z); void clutter_actor_rotate_y (ClutterActor *self, gfloat angle, gint x, gint z); void clutter_actor_set_opacity (ClutterActor *self, guint8 opacity); guint8 clutter_actor_get_opacity (ClutterActor *self); void clutter_actor_set_name (ClutterActor *self, const gchar *id); const gchar* clutter_actor_get_name (ClutterActor *self); guint32 clutter_actor_get_id (ClutterActor *self); void clutter_actor_set_clip (ClutterActor *self, gint xoff, gint yoff, gint width, gint height); void clutter_actor_remove_clip (ClutterActor *self); void clutter_actor_set_parent (ClutterActor *self, ClutterActor *parent); ClutterActor* clutter_actor_get_parent (ClutterActor *self); void clutter_actor_raise (ClutterActor *self, ClutterActor *below); void clutter_actor_lower (ClutterActor *self, ClutterActor *above); void clutter_actor_raise_top (ClutterActor *self); void clutter_actor_lower_bottom (ClutterActor *self); void clutter_actor_set_depth (ClutterActor *self, gint depth); gint clutter_actor_get_depth (ClutterActor *self);
GObject +----ClutterActor +----ClutterGroup +----ClutterRectangle +----ClutterTexture +----ClutterCloneTexture
"height" gint : Read / Write "opacity" guchar : Read / Write / Construct "width" gint : Read / Write "x" gint : Read / Write "y" gint : Read / Write
#define CLUTTER_ACTOR_IS_MAPPED(e) ((e)->flags & CLUTTER_ACTOR_MAPPED)
e : |
#define CLUTTER_ACTOR_IS_REALIZED(e) ((e)->flags & CLUTTER_ACTOR_REALIZED)
e : |
typedef enum { CLUTTER_ACTOR_MAPPED = 1 << 1, CLUTTER_ACTOR_REALIZED = 1 << 2 } ClutterActorFlags;
void clutter_actor_show (ClutterActor *self);
Flags a clutter actor to be displayed. An actor not shown will not appear on the display.
self : |
A ClutterActor |
void clutter_actor_hide (ClutterActor *self);
Flags a clutter actor to be hidden. An actor not shown will not appear on the display.
self : |
A ClutterActor |
void clutter_actor_realize (ClutterActor *self);
Frees up any underlying graphics resources needed by the actor to be displayed.
self : |
A ClutterActor |
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.
self : |
A ClutterActor |
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.
self : |
A ClutterActor |
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.
self : |
A ClutterActor |
box : |
A ClutterActorBox with requested new co-ordinates. |
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.
self : |
A ClutterActor |
box : |
A location to store the actors ClutterActorBox co-ordinates |
void clutter_actor_set_geometry (ClutterActor *self, ClutterGeometry *geom);
Sets the actors geometry in pixels relative to any parent actor.
self : |
A ClutterActor |
geom : |
A ClutterGeometry |
void clutter_actor_get_geometry (ClutterActor *self, ClutterGeometry *geom);
Gets the actors geometry in pixels relative to any parent actor.
self : |
A ClutterActor |
geom : |
A location to store actors ClutterGeometry |
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.
self : |
A ClutterActor |
x1 : |
A location to store actors left position if non NULL. |
y1 : |
A location to store actors top position if non NULL. |
x2 : |
A location to store actors right position if non NULL. |
y2 : |
A location to store actors bottom position if non NULL. |
void clutter_actor_set_position (ClutterActor *self, gint x, gint y);
Gets the absolute position of an actor in pixels relative to the stage.
self : |
A ClutterActor |
x : |
Location to store x position if non NULL. |
y : |
Location to store y position if non NULL. |
void clutter_actor_set_size (ClutterActor *self, gint width, gint height);
Sets the actors position in pixels relative to any parent actor.
self : |
A ClutterActor |
width : |
New width of actor in pixels |
height : |
New height of actor in pixels |
void clutter_actor_get_abs_position (ClutterActor *self, gint *x, gint *y);
self : |
|
x : |
|
y : |
guint clutter_actor_get_width (ClutterActor *self);
Retrieves the actors width.
self : |
A ClutterActor |
Returns : | The actor width in pixels |
guint clutter_actor_get_height (ClutterActor *self);
Retrieves the actors height.
self : |
A ClutterActor |
Returns : | The actor height in pixels |
gint clutter_actor_get_x (ClutterActor *self);
Retrieves the actors x position relative to any parent.
self : |
A ClutterActor |
Returns : | The actor x position in pixels |
gint clutter_actor_get_y (ClutterActor *self);
Retrieves the actors y position relative to any parent.
self : |
A ClutterActor |
Returns : | The actor y position in pixels |
void clutter_actor_rotate_z (ClutterActor *self, gfloat angle, gint x, gint y);
Rotates actor around the Z axis.
self : |
A ClutterActor |
angle : |
Angle of rotation |
x : |
X co-ord to rotate actor around ( relative to actor position ) |
y : |
Y co-ord to rotate actor around ( relative to actor position ) |
void clutter_actor_rotate_x (ClutterActor *self, gfloat angle, gint y, gint z);
Rotates actor around the X axis.
self : |
A ClutterActor |
angle : |
Angle of rotation |
y : |
Y co-ord to rotate actor around ( relative to actor position ) |
z : |
Z co-ord to rotate actor around ( relative to actor position ) |
void clutter_actor_rotate_y (ClutterActor *self, gfloat angle, gint x, gint z);
Rotates actor around the X axis.
self : |
A ClutterActor |
angle : |
Angle of rotation |
x : |
X co-ord to rotate actor around ( relative to actor position ) |
z : |
Z co-ord to rotate actor around ( relative to actor position ) |
void clutter_actor_set_opacity (ClutterActor *self, guint8 opacity);
Sets the actors opacity, with zero being completely transparent.
self : |
A ClutterActor |
opacity : |
New opacity value for actor. |
guint8 clutter_actor_get_opacity (ClutterActor *self);
Retrieves the actors opacity.
self : |
A ClutterActor |
Returns : | The actor opacity value. |
void clutter_actor_set_name (ClutterActor *self, const gchar *id);
Sets a textual tag to the actor.
self : |
A ClutterActor |
id : |
Textual tag to apply to actor |
const gchar* clutter_actor_get_name (ClutterActor *self);
self : |
A ClutterActor |
Returns : | pointer to textual tag for the actor. The returned string is owned by the actor and should not be modified or freed. |
guint32 clutter_actor_get_id (ClutterActor *self);
Retrieves the unique id for self
.
self : |
A ClutterActor |
Returns : | Globally unique value for object instance. |
void clutter_actor_set_clip (ClutterActor *self, gint xoff, gint yoff, gint width, gint height);
Sets clip area for self
.
self : |
A ClutterActor |
xoff : |
X offset of the clip rectangle |
yoff : |
Y offset of the clip rectangle |
width : |
Width of the clip rectangle |
height : |
Height of the clip rectangle |
void clutter_actor_remove_clip (ClutterActor *self);
Removes clip area from self
.
self : |
A ClutterActor |
void clutter_actor_set_parent (ClutterActor *self, ClutterActor *parent);
Sets the parent of self
to parent
.
This function should not be used by applications.
self : |
A ClutterActor |
parent : |
A new ClutterActor parent or NULL |
ClutterActor* clutter_actor_get_parent (ClutterActor *self);
Retrieves the parent of self
.
self : |
A ClutterActor |
Returns : | The ClutterActor parent or NULL |
void clutter_actor_raise (ClutterActor *self, ClutterActor *below);
Puts self
above below
.
Both actors must have the same parent.
self : |
A ClutterActor |
below : |
A ClutterActor to raise above. |
void clutter_actor_lower (ClutterActor *self, ClutterActor *above);
Puts self
below above
.
Both actors must have the same parent.
self : |
A ClutterActor |
above : |
A ClutterActor to lower below |
void clutter_actor_lower_bottom (ClutterActor *self);
Lowers self
to the bottom.
self : |
A ClutterActor |
void clutter_actor_set_depth (ClutterActor *self, gint depth);
Sets the Z co-ordinate of self
to depth
.
self : |
a ClutterActor |
depth : |
Z co-ord |
gint clutter_actor_get_depth (ClutterActor *self);
Retrieves the depth of self
.
self : |
a ClutterActor |
Returns : | the depth of a ClutterActor |
height
" property"height" gint : Read / Write
Height of actor in pixels.
Allowed values: >= 0
Default value: 0
opacity
" property"opacity" guchar : Read / Write / Construct
Opacity of actor.
Default value: 255
width
" property"width" gint : Read / Write
Width of actor in pixels.
Allowed values: >= 0
Default value: 0