File: clutter-actor.xml

package info (click to toggle)
clutter 0.1.0-1
links: PTS
area: main
in suites: etch, etch-m68k
size: 3,528 kB
ctags: 3,353
sloc: ansic: 12,634; sh: 8,777; xml: 4,655; makefile: 278
file content (975 lines) | stat: -rw-r--r-- 55,892 bytes
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>

<refentry id="ClutterActor">
<refmeta>
<refentrytitle id="top_of_page">ClutterActor</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>CLUTTER Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>ClutterActor</refname>
<refpurpose>Base abstract class for all visual stage actors.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="synopsis">
<title id="synopsis.title">Synopsis</title>

<synopsis>



#define     <link linkend="CLUTTER-TYPE-GEOMETRY:CAPS">CLUTTER_TYPE_GEOMETRY</link>
#define     <link linkend="CLUTTER-TYPE-ACTOR-BOX:CAPS">CLUTTER_TYPE_ACTOR_BOX</link>
#define     <link linkend="CLUTTER-ACTOR-SET-FLAGS:CAPS">CLUTTER_ACTOR_SET_FLAGS</link>         (e,f)
#define     <link linkend="CLUTTER-ACTOR-UNSET-FLAGS:CAPS">CLUTTER_ACTOR_UNSET_FLAGS</link>       (e,f)
#define     <link linkend="CLUTTER-ACTOR-IS-MAPPED:CAPS">CLUTTER_ACTOR_IS_MAPPED</link>         (e)
#define     <link linkend="CLUTTER-ACTOR-IS-REALIZED:CAPS">CLUTTER_ACTOR_IS_REALIZED</link>       (e)
#define     <link linkend="CLUTTER-ACTOR-IS-VISIBLE:CAPS">CLUTTER_ACTOR_IS_VISIBLE</link>        (e)
            <link linkend="ClutterActorBox">ClutterActorBox</link>;
            <link linkend="ClutterActorPrivate">ClutterActorPrivate</link>;
            <link linkend="ClutterGeometry">ClutterGeometry</link>;
<link linkend="void">void</link>        (<link linkend="ClutterCallback">*ClutterCallback</link>)              (<link linkend="ClutterActor">ClutterActor</link> *actor,
                                             <link linkend="gpointer">gpointer</link> data);
enum        <link linkend="ClutterActorFlags">ClutterActorFlags</link>;
<link linkend="GType">GType</link>       <link linkend="clutter-actor-box-get-type">clutter_actor_box_get_type</link>      (void);
            <link linkend="ClutterActor-struct">ClutterActor</link>;
<link linkend="GType">GType</link>       <link linkend="clutter-actor-get-type">clutter_actor_get_type</link>          (void);
<link linkend="void">void</link>        <link linkend="clutter-actor-show">clutter_actor_show</link>              (<link linkend="ClutterActor">ClutterActor</link> *self);
<link linkend="void">void</link>        <link linkend="clutter-actor-hide">clutter_actor_hide</link>              (<link linkend="ClutterActor">ClutterActor</link> *self);
<link linkend="void">void</link>        <link linkend="clutter-actor-realize">clutter_actor_realize</link>           (<link linkend="ClutterActor">ClutterActor</link> *self);
<link linkend="void">void</link>        <link linkend="clutter-actor-unrealize">clutter_actor_unrealize</link>         (<link linkend="ClutterActor">ClutterActor</link> *self);
<link linkend="void">void</link>        <link linkend="clutter-actor-paint">clutter_actor_paint</link>             (<link linkend="ClutterActor">ClutterActor</link> *self);
<link linkend="void">void</link>        <link linkend="clutter-actor-queue-redraw">clutter_actor_queue_redraw</link>      (<link linkend="ClutterActor">ClutterActor</link> *self);
<link linkend="void">void</link>        <link linkend="clutter-actor-request-coords">clutter_actor_request_coords</link>    (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="ClutterActorBox">ClutterActorBox</link> *box);
<link linkend="void">void</link>        <link linkend="clutter-actor-allocate-coords">clutter_actor_allocate_coords</link>   (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="ClutterActorBox">ClutterActorBox</link> *box);
<link linkend="void">void</link>        <link linkend="clutter-actor-set-geometry">clutter_actor_set_geometry</link>      (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="ClutterGeometry">ClutterGeometry</link> *geom);
<link linkend="void">void</link>        <link linkend="clutter-actor-get-geometry">clutter_actor_get_geometry</link>      (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="ClutterGeometry">ClutterGeometry</link> *geom);
<link linkend="void">void</link>        <link linkend="clutter-actor-get-coords">clutter_actor_get_coords</link>        (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="gint">gint</link> *x1,
                                             <link linkend="gint">gint</link> *y1,
                                             <link linkend="gint">gint</link> *x2,
                                             <link linkend="gint">gint</link> *y2);
<link linkend="void">void</link>        <link linkend="clutter-actor-set-position">clutter_actor_set_position</link>      (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="gint">gint</link> x,
                                             <link linkend="gint">gint</link> y);
<link linkend="void">void</link>        <link linkend="clutter-actor-set-size">clutter_actor_set_size</link>          (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="gint">gint</link> width,
                                             <link linkend="gint">gint</link> height);
<link linkend="void">void</link>        <link linkend="clutter-actor-get-abs-position">clutter_actor_get_abs_position</link>  (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="gint">gint</link> *x,
                                             <link linkend="gint">gint</link> *y);
<link linkend="guint">guint</link>       <link linkend="clutter-actor-get-width">clutter_actor_get_width</link>         (<link linkend="ClutterActor">ClutterActor</link> *self);
<link linkend="guint">guint</link>       <link linkend="clutter-actor-get-height">clutter_actor_get_height</link>        (<link linkend="ClutterActor">ClutterActor</link> *self);
<link linkend="gint">gint</link>        <link linkend="clutter-actor-get-x">clutter_actor_get_x</link>             (<link linkend="ClutterActor">ClutterActor</link> *self);
<link linkend="gint">gint</link>        <link linkend="clutter-actor-get-y">clutter_actor_get_y</link>             (<link linkend="ClutterActor">ClutterActor</link> *self);
<link linkend="void">void</link>        <link linkend="clutter-actor-rotate-z">clutter_actor_rotate_z</link>          (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="gfloat">gfloat</link> angle,
                                             <link linkend="gint">gint</link> x,
                                             <link linkend="gint">gint</link> y);
<link linkend="void">void</link>        <link linkend="clutter-actor-rotate-x">clutter_actor_rotate_x</link>          (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="gfloat">gfloat</link> angle,
                                             <link linkend="gint">gint</link> y,
                                             <link linkend="gint">gint</link> z);
<link linkend="void">void</link>        <link linkend="clutter-actor-rotate-y">clutter_actor_rotate_y</link>          (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="gfloat">gfloat</link> angle,
                                             <link linkend="gint">gint</link> x,
                                             <link linkend="gint">gint</link> z);
<link linkend="void">void</link>        <link linkend="clutter-actor-set-opacity">clutter_actor_set_opacity</link>       (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="guint8">guint8</link> opacity);
<link linkend="guint8">guint8</link>      <link linkend="clutter-actor-get-opacity">clutter_actor_get_opacity</link>       (<link linkend="ClutterActor">ClutterActor</link> *self);
<link linkend="void">void</link>        <link linkend="clutter-actor-set-name">clutter_actor_set_name</link>          (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             const <link linkend="gchar">gchar</link> *id);
const <link linkend="gchar">gchar</link>* <link linkend="clutter-actor-get-name">clutter_actor_get_name</link>         (<link linkend="ClutterActor">ClutterActor</link> *self);
<link linkend="guint32">guint32</link>     <link linkend="clutter-actor-get-id">clutter_actor_get_id</link>            (<link linkend="ClutterActor">ClutterActor</link> *self);
<link linkend="void">void</link>        <link linkend="clutter-actor-set-clip">clutter_actor_set_clip</link>          (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="gint">gint</link> xoff,
                                             <link linkend="gint">gint</link> yoff,
                                             <link linkend="gint">gint</link> width,
                                             <link linkend="gint">gint</link> height);
<link linkend="void">void</link>        <link linkend="clutter-actor-remove-clip">clutter_actor_remove_clip</link>       (<link linkend="ClutterActor">ClutterActor</link> *self);
<link linkend="void">void</link>        <link linkend="clutter-actor-set-parent">clutter_actor_set_parent</link>        (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="ClutterActor">ClutterActor</link> *parent);
<link linkend="ClutterActor">ClutterActor</link>* <link linkend="clutter-actor-get-parent">clutter_actor_get_parent</link>      (<link linkend="ClutterActor">ClutterActor</link> *self);
<link linkend="void">void</link>        <link linkend="clutter-actor-raise">clutter_actor_raise</link>             (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="ClutterActor">ClutterActor</link> *below);
<link linkend="void">void</link>        <link linkend="clutter-actor-lower">clutter_actor_lower</link>             (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="ClutterActor">ClutterActor</link> *above);
<link linkend="void">void</link>        <link linkend="clutter-actor-raise-top">clutter_actor_raise_top</link>         (<link linkend="ClutterActor">ClutterActor</link> *self);
<link linkend="void">void</link>        <link linkend="clutter-actor-lower-bottom">clutter_actor_lower_bottom</link>      (<link linkend="ClutterActor">ClutterActor</link> *self);
<link linkend="void">void</link>        <link linkend="clutter-actor-set-depth">clutter_actor_set_depth</link>         (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="gint">gint</link> depth);
<link linkend="gint">gint</link>        <link linkend="clutter-actor-get-depth">clutter_actor_get_depth</link>         (<link linkend="ClutterActor">ClutterActor</link> *self);

</synopsis>
</refsynopsisdiv>

<refsect1 id="object_hierarchy">
<title id="object_hierarchy.title">Object Hierarchy</title>
<synopsis>

  <link linkend="GObject">GObject</link>
   +----ClutterActor
         +----<link linkend="ClutterGroup">ClutterGroup</link>
         +----<link linkend="ClutterRectangle">ClutterRectangle</link>
         +----<link linkend="ClutterTexture">ClutterTexture</link>
         +----<link linkend="ClutterCloneTexture">ClutterCloneTexture</link>
</synopsis>

</refsect1>





<refsect1 id="properties">
<title id="properties.title">Properties</title>
<synopsis>

  &quot;<link linkend="ClutterActor--height">height</link>&quot;               <link linkend="gint">gint</link>                  : Read / Write
  &quot;<link linkend="ClutterActor--opacity">opacity</link>&quot;              <link linkend="guchar">guchar</link>                : Read / Write / Construct
  &quot;<link linkend="ClutterActor--width">width</link>&quot;                <link linkend="gint">gint</link>                  : Read / Write
  &quot;<link linkend="ClutterActor--x">x</link>&quot;                    <link linkend="gint">gint</link>                  : Read / Write
  &quot;<link linkend="ClutterActor--y">y</link>&quot;                    <link linkend="gint">gint</link>                  : Read / Write
</synopsis>
</refsect1>



<refsect1 id="desc">
<title id="desc.title">Description</title>
<para>
<link linkend="ClutterActor"><type>ClutterActor</type></link> is a base abstract class for all visual elements.</para>
<para>

</para>
</refsect1>

<refsect1 id="details">
<title id="details.title">Details</title>
<refsect2>
<title><anchor id="CLUTTER-TYPE-GEOMETRY:CAPS" role="macro"/>CLUTTER_TYPE_GEOMETRY</title>
<indexterm><primary>CLUTTER_TYPE_GEOMETRY</primary></indexterm><programlisting>#define CLUTTER_TYPE_GEOMETRY (clutter_geometry_get_type ())
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="CLUTTER-TYPE-ACTOR-BOX:CAPS" role="macro"/>CLUTTER_TYPE_ACTOR_BOX</title>
<indexterm><primary>CLUTTER_TYPE_ACTOR_BOX</primary></indexterm><programlisting>#define CLUTTER_TYPE_ACTOR_BOX (clutter_actor_box_get_type ())
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="CLUTTER-ACTOR-SET-FLAGS:CAPS" role="macro"/>CLUTTER_ACTOR_SET_FLAGS()</title>
<indexterm><primary>CLUTTER_ACTOR_SET_FLAGS</primary></indexterm><programlisting>#define CLUTTER_ACTOR_SET_FLAGS(e,f) ((e)-&gt;flags |= (f))  
</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>e</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>f</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="CLUTTER-ACTOR-UNSET-FLAGS:CAPS" role="macro"/>CLUTTER_ACTOR_UNSET_FLAGS()</title>
<indexterm><primary>CLUTTER_ACTOR_UNSET_FLAGS</primary></indexterm><programlisting>#define CLUTTER_ACTOR_UNSET_FLAGS(e,f) ((e)-&gt;flags &amp;= ~(f))  
</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>e</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>f</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="CLUTTER-ACTOR-IS-MAPPED:CAPS" role="macro"/>CLUTTER_ACTOR_IS_MAPPED()</title>
<indexterm><primary>CLUTTER_ACTOR_IS_MAPPED</primary></indexterm><programlisting>#define CLUTTER_ACTOR_IS_MAPPED(e) ((e)-&gt;flags &amp; CLUTTER_ACTOR_MAPPED)  
</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>e</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="CLUTTER-ACTOR-IS-REALIZED:CAPS" role="macro"/>CLUTTER_ACTOR_IS_REALIZED()</title>
<indexterm><primary>CLUTTER_ACTOR_IS_REALIZED</primary></indexterm><programlisting>#define CLUTTER_ACTOR_IS_REALIZED(e) ((e)-&gt;flags &amp; CLUTTER_ACTOR_REALIZED)
</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>e</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="CLUTTER-ACTOR-IS-VISIBLE:CAPS" role="macro"/>CLUTTER_ACTOR_IS_VISIBLE()</title>
<indexterm><primary>CLUTTER_ACTOR_IS_VISIBLE</primary></indexterm><programlisting>#define     CLUTTER_ACTOR_IS_VISIBLE(e)</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>e</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="ClutterActorBox" role="struct"/>ClutterActorBox</title>
<indexterm><primary>ClutterActorBox</primary></indexterm><programlisting>typedef struct {
 gint x1, y1, x2, y2; 
} ClutterActorBox;
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="ClutterActorPrivate" role="struct"/>ClutterActorPrivate</title>
<indexterm><primary>ClutterActorPrivate</primary></indexterm><programlisting>typedef struct _ClutterActorPrivate ClutterActorPrivate;</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="ClutterGeometry" role="struct"/>ClutterGeometry</title>
<indexterm><primary>ClutterGeometry</primary></indexterm><programlisting>typedef struct {
  gint x;
  gint y;
  guint width;
  guint height;
} ClutterGeometry;
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="ClutterCallback" role="function"/>ClutterCallback ()</title>
<indexterm><primary>ClutterCallback</primary></indexterm><programlisting><link linkend="void">void</link>        (*ClutterCallback)              (<link linkend="ClutterActor">ClutterActor</link> *actor,
                                             <link linkend="gpointer">gpointer</link> data);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>actor</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="ClutterActorFlags" role="enum"/>enum ClutterActorFlags</title>
<indexterm><primary>ClutterActorFlags</primary></indexterm><programlisting>typedef enum
{
  CLUTTER_ACTOR_MAPPED   = 1 &lt;&lt; 1,
  CLUTTER_ACTOR_REALIZED = 1 &lt;&lt; 2
} ClutterActorFlags;
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="clutter-actor-box-get-type" role="function"/>clutter_actor_box_get_type ()</title>
<indexterm><primary>clutter_actor_box_get_type</primary></indexterm><programlisting><link linkend="GType">GType</link>       clutter_actor_box_get_type      (void);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="ClutterActor-struct" role="struct"/>ClutterActor</title>
<indexterm><primary>ClutterActor</primary></indexterm><programlisting>typedef struct {
  GObject                 parent;
  guint32                 flags;
} ClutterActor;
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="clutter-actor-get-type" role="function"/>clutter_actor_get_type ()</title>
<indexterm><primary>clutter_actor_get_type</primary></indexterm><programlisting><link linkend="GType">GType</link>       clutter_actor_get_type          (void);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-show" role="function"/>clutter_actor_show ()</title>
<indexterm><primary>clutter_actor_show</primary></indexterm><programlisting><link linkend="void">void</link>        clutter_actor_show              (<link linkend="ClutterActor">ClutterActor</link> *self);</programlisting>
<para>
Flags a clutter actor to be displayed. An actor not shown will not 
appear on the display.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-hide" role="function"/>clutter_actor_hide ()</title>
<indexterm><primary>clutter_actor_hide</primary></indexterm><programlisting><link linkend="void">void</link>        clutter_actor_hide              (<link linkend="ClutterActor">ClutterActor</link> *self);</programlisting>
<para>
Flags a clutter actor to be hidden. An actor not shown will not 
appear on the display.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-realize" role="function"/>clutter_actor_realize ()</title>
<indexterm><primary>clutter_actor_realize</primary></indexterm><programlisting><link linkend="void">void</link>        clutter_actor_realize           (<link linkend="ClutterActor">ClutterActor</link> *self);</programlisting>
<para>
Frees up any underlying graphics resources needed by the actor to be
displayed.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-unrealize" role="function"/>clutter_actor_unrealize ()</title>
<indexterm><primary>clutter_actor_unrealize</primary></indexterm><programlisting><link linkend="void">void</link>        clutter_actor_unrealize         (<link linkend="ClutterActor">ClutterActor</link> *self);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-paint" role="function"/>clutter_actor_paint ()</title>
<indexterm><primary>clutter_actor_paint</primary></indexterm><programlisting><link linkend="void">void</link>        clutter_actor_paint             (<link linkend="ClutterActor">ClutterActor</link> *self);</programlisting>
<para>
Renders the actor to display.
</para>
<para>
This function should not be called directly by applications instead 
<link linkend="clutter-actor-queue-redraw"><type>clutter_actor_queue_redraw</type></link> should be used to queue paints.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-queue-redraw" role="function"/>clutter_actor_queue_redraw ()</title>
<indexterm><primary>clutter_actor_queue_redraw</primary></indexterm><programlisting><link linkend="void">void</link>        clutter_actor_queue_redraw      (<link linkend="ClutterActor">ClutterActor</link> *self);</programlisting>
<para>
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).
</para>
<para>
Applications rarely need to call this as redraws are handled automatically
by modification functions.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-request-coords" role="function"/>clutter_actor_request_coords ()</title>
<indexterm><primary>clutter_actor_request_coords</primary></indexterm><programlisting><link linkend="void">void</link>        clutter_actor_request_coords    (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="ClutterActorBox">ClutterActorBox</link> *box);</programlisting>
<para>
Requests new co-ordinates for the <link linkend="ClutterActor"><type>ClutterActor</type></link> ralative to any parent.
</para>
<para>
This function should not be called directly by applications instead 
the various position/geometry methods should be used.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>box</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterActorBox"><type>ClutterActorBox</type></link> with requested new co-ordinates.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-allocate-coords" role="function"/>clutter_actor_allocate_coords ()</title>
<indexterm><primary>clutter_actor_allocate_coords</primary></indexterm><programlisting><link linkend="void">void</link>        clutter_actor_allocate_coords   (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="ClutterActorBox">ClutterActorBox</link> *box);</programlisting>
<para>
Requests the allocated co-ordinates for the <link linkend="ClutterActor"><type>ClutterActor</type></link> relative 
to any parent.
</para>
<para>
This function should not be called directly by applications instead 
the various position/geometry methods should be used.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>box</parameter>&nbsp;:</term>
<listitem><simpara> A location to store the actors <link linkend="ClutterActorBox"><type>ClutterActorBox</type></link> co-ordinates
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-set-geometry" role="function"/>clutter_actor_set_geometry ()</title>
<indexterm><primary>clutter_actor_set_geometry</primary></indexterm><programlisting><link linkend="void">void</link>        clutter_actor_set_geometry      (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="ClutterGeometry">ClutterGeometry</link> *geom);</programlisting>
<para>
Sets the actors geometry in pixels relative to any parent actor.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>geom</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterGeometry"><type>ClutterGeometry</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-get-geometry" role="function"/>clutter_actor_get_geometry ()</title>
<indexterm><primary>clutter_actor_get_geometry</primary></indexterm><programlisting><link linkend="void">void</link>        clutter_actor_get_geometry      (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="ClutterGeometry">ClutterGeometry</link> *geom);</programlisting>
<para>
Gets the actors geometry in pixels relative to any parent actor.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>geom</parameter>&nbsp;:</term>
<listitem><simpara> A location to store actors <link linkend="ClutterGeometry"><type>ClutterGeometry</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-get-coords" role="function"/>clutter_actor_get_coords ()</title>
<indexterm><primary>clutter_actor_get_coords</primary></indexterm><programlisting><link linkend="void">void</link>        clutter_actor_get_coords        (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="gint">gint</link> *x1,
                                             <link linkend="gint">gint</link> *y1,
                                             <link linkend="gint">gint</link> *x2,
                                             <link linkend="gint">gint</link> *y2);</programlisting>
<para>
Gets the actors bounding rectangle co-ordinates in pixels 
relative to any parent actor.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x1</parameter>&nbsp;:</term>
<listitem><simpara> A location to store actors left position if non NULL.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y1</parameter>&nbsp;:</term>
<listitem><simpara> A location to store actors top position if non NULL.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x2</parameter>&nbsp;:</term>
<listitem><simpara> A location to store actors right position if non NULL.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y2</parameter>&nbsp;:</term>
<listitem><simpara> A location to store actors bottom position if non NULL.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-set-position" role="function"/>clutter_actor_set_position ()</title>
<indexterm><primary>clutter_actor_set_position</primary></indexterm><programlisting><link linkend="void">void</link>        clutter_actor_set_position      (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="gint">gint</link> x,
                                             <link linkend="gint">gint</link> y);</programlisting>
<para>
Gets the absolute position of an actor in pixels relative
to the stage.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
<listitem><simpara> Location to store x position if non NULL.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
<listitem><simpara> Location to store y position if non NULL.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-set-size" role="function"/>clutter_actor_set_size ()</title>
<indexterm><primary>clutter_actor_set_size</primary></indexterm><programlisting><link linkend="void">void</link>        clutter_actor_set_size          (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="gint">gint</link> width,
                                             <link linkend="gint">gint</link> height);</programlisting>
<para>
Sets the actors position in pixels relative to any
parent actor.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
<listitem><simpara> New width of actor in pixels 
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
<listitem><simpara> New height of actor in pixels
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-get-abs-position" role="function"/>clutter_actor_get_abs_position ()</title>
<indexterm><primary>clutter_actor_get_abs_position</primary></indexterm><programlisting><link linkend="void">void</link>        clutter_actor_get_abs_position  (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="gint">gint</link> *x,
                                             <link linkend="gint">gint</link> *y);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-get-width" role="function"/>clutter_actor_get_width ()</title>
<indexterm><primary>clutter_actor_get_width</primary></indexterm><programlisting><link linkend="guint">guint</link>       clutter_actor_get_width         (<link linkend="ClutterActor">ClutterActor</link> *self);</programlisting>
<para>
Retrieves the actors width.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The actor width in pixels
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-get-height" role="function"/>clutter_actor_get_height ()</title>
<indexterm><primary>clutter_actor_get_height</primary></indexterm><programlisting><link linkend="guint">guint</link>       clutter_actor_get_height        (<link linkend="ClutterActor">ClutterActor</link> *self);</programlisting>
<para>
Retrieves the actors height.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The actor height in pixels
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-get-x" role="function"/>clutter_actor_get_x ()</title>
<indexterm><primary>clutter_actor_get_x</primary></indexterm><programlisting><link linkend="gint">gint</link>        clutter_actor_get_x             (<link linkend="ClutterActor">ClutterActor</link> *self);</programlisting>
<para>
Retrieves the actors x position relative to any parent.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The actor x position in pixels
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-get-y" role="function"/>clutter_actor_get_y ()</title>
<indexterm><primary>clutter_actor_get_y</primary></indexterm><programlisting><link linkend="gint">gint</link>        clutter_actor_get_y             (<link linkend="ClutterActor">ClutterActor</link> *self);</programlisting>
<para>
Retrieves the actors y position relative to any parent.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The actor y position in pixels
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-rotate-z" role="function"/>clutter_actor_rotate_z ()</title>
<indexterm><primary>clutter_actor_rotate_z</primary></indexterm><programlisting><link linkend="void">void</link>        clutter_actor_rotate_z          (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="gfloat">gfloat</link> angle,
                                             <link linkend="gint">gint</link> x,
                                             <link linkend="gint">gint</link> y);</programlisting>
<para>
Rotates actor around the Z axis.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>angle</parameter>&nbsp;:</term>
<listitem><simpara> Angle of rotation
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
<listitem><simpara>     X co-ord to rotate actor around ( relative to actor position )
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
<listitem><simpara>     Y co-ord to rotate actor around ( relative to actor position )
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-rotate-x" role="function"/>clutter_actor_rotate_x ()</title>
<indexterm><primary>clutter_actor_rotate_x</primary></indexterm><programlisting><link linkend="void">void</link>        clutter_actor_rotate_x          (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="gfloat">gfloat</link> angle,
                                             <link linkend="gint">gint</link> y,
                                             <link linkend="gint">gint</link> z);</programlisting>
<para>
Rotates actor around the X axis.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara>  A <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>angle</parameter>&nbsp;:</term>
<listitem><simpara> Angle of rotation
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
<listitem><simpara>     Y co-ord to rotate actor around ( relative to actor position )
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>z</parameter>&nbsp;:</term>
<listitem><simpara>     Z co-ord to rotate actor around ( relative to actor position )
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-rotate-y" role="function"/>clutter_actor_rotate_y ()</title>
<indexterm><primary>clutter_actor_rotate_y</primary></indexterm><programlisting><link linkend="void">void</link>        clutter_actor_rotate_y          (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="gfloat">gfloat</link> angle,
                                             <link linkend="gint">gint</link> x,
                                             <link linkend="gint">gint</link> z);</programlisting>
<para>
Rotates actor around the X axis.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara>  A <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>angle</parameter>&nbsp;:</term>
<listitem><simpara> Angle of rotation
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
<listitem><simpara>     X co-ord to rotate actor around ( relative to actor position )
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>z</parameter>&nbsp;:</term>
<listitem><simpara>     Z co-ord to rotate actor around ( relative to actor position )
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-set-opacity" role="function"/>clutter_actor_set_opacity ()</title>
<indexterm><primary>clutter_actor_set_opacity</primary></indexterm><programlisting><link linkend="void">void</link>        clutter_actor_set_opacity       (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="guint8">guint8</link> opacity);</programlisting>
<para>
Sets the actors opacity, with zero being completely transparent.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>opacity</parameter>&nbsp;:</term>
<listitem><simpara> New opacity value for actor.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-get-opacity" role="function"/>clutter_actor_get_opacity ()</title>
<indexterm><primary>clutter_actor_get_opacity</primary></indexterm><programlisting><link linkend="guint8">guint8</link>      clutter_actor_get_opacity       (<link linkend="ClutterActor">ClutterActor</link> *self);</programlisting>
<para>
Retrieves the actors opacity.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The actor opacity value.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-set-name" role="function"/>clutter_actor_set_name ()</title>
<indexterm><primary>clutter_actor_set_name</primary></indexterm><programlisting><link linkend="void">void</link>        clutter_actor_set_name          (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             const <link linkend="gchar">gchar</link> *id);</programlisting>
<para>
Sets a textual tag to the actor.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter>&nbsp;:</term>
<listitem><simpara> Textual tag to apply to actor
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-get-name" role="function"/>clutter_actor_get_name ()</title>
<indexterm><primary>clutter_actor_get_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* clutter_actor_get_name         (<link linkend="ClutterActor">ClutterActor</link> *self);</programlisting>
<para>
</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> pointer to textual tag for the actor.  The
  returned string is owned by the actor and should not
  be modified or freed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-get-id" role="function"/>clutter_actor_get_id ()</title>
<indexterm><primary>clutter_actor_get_id</primary></indexterm><programlisting><link linkend="guint32">guint32</link>     clutter_actor_get_id            (<link linkend="ClutterActor">ClutterActor</link> *self);</programlisting>
<para>
Retrieves the unique id for <parameter>self</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> Globally unique value for object instance.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-set-clip" role="function"/>clutter_actor_set_clip ()</title>
<indexterm><primary>clutter_actor_set_clip</primary></indexterm><programlisting><link linkend="void">void</link>        clutter_actor_set_clip          (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="gint">gint</link> xoff,
                                             <link linkend="gint">gint</link> yoff,
                                             <link linkend="gint">gint</link> width,
                                             <link linkend="gint">gint</link> height);</programlisting>
<para>
Sets clip area for <parameter>self</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>xoff</parameter>&nbsp;:</term>
<listitem><simpara> X offset of the clip rectangle
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>yoff</parameter>&nbsp;:</term>
<listitem><simpara> Y offset of the clip rectangle
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
<listitem><simpara> Width of the clip rectangle
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
<listitem><simpara> Height of the clip rectangle
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-remove-clip" role="function"/>clutter_actor_remove_clip ()</title>
<indexterm><primary>clutter_actor_remove_clip</primary></indexterm><programlisting><link linkend="void">void</link>        clutter_actor_remove_clip       (<link linkend="ClutterActor">ClutterActor</link> *self);</programlisting>
<para>
Removes clip area from <parameter>self</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-set-parent" role="function"/>clutter_actor_set_parent ()</title>
<indexterm><primary>clutter_actor_set_parent</primary></indexterm><programlisting><link linkend="void">void</link>        clutter_actor_set_parent        (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="ClutterActor">ClutterActor</link> *parent);</programlisting>
<para>
Sets the parent of <parameter>self</parameter> to <parameter>parent</parameter>.
This function should not be used by applications.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>parent</parameter>&nbsp;:</term>
<listitem><simpara> A new <link linkend="ClutterActor"><type>ClutterActor</type></link> parent or NULL
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-get-parent" role="function"/>clutter_actor_get_parent ()</title>
<indexterm><primary>clutter_actor_get_parent</primary></indexterm><programlisting><link linkend="ClutterActor">ClutterActor</link>* clutter_actor_get_parent      (<link linkend="ClutterActor">ClutterActor</link> *self);</programlisting>
<para>
Retrieves the parent of <parameter>self</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The <link linkend="ClutterActor"><type>ClutterActor</type></link> parent or NULL
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-raise" role="function"/>clutter_actor_raise ()</title>
<indexterm><primary>clutter_actor_raise</primary></indexterm><programlisting><link linkend="void">void</link>        clutter_actor_raise             (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="ClutterActor">ClutterActor</link> *below);</programlisting>
<para>
Puts <parameter>self</parameter> above <parameter>below</parameter>.
Both actors must have the same parent.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>below</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterActor"><type>ClutterActor</type></link> to raise above.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-lower" role="function"/>clutter_actor_lower ()</title>
<indexterm><primary>clutter_actor_lower</primary></indexterm><programlisting><link linkend="void">void</link>        clutter_actor_lower             (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="ClutterActor">ClutterActor</link> *above);</programlisting>
<para>
Puts <parameter>self</parameter> below <parameter>above</parameter>.
Both actors must have the same parent.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>above</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterActor"><type>ClutterActor</type></link> to lower below
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-raise-top" role="function"/>clutter_actor_raise_top ()</title>
<indexterm><primary>clutter_actor_raise_top</primary></indexterm><programlisting><link linkend="void">void</link>        clutter_actor_raise_top         (<link linkend="ClutterActor">ClutterActor</link> *self);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-lower-bottom" role="function"/>clutter_actor_lower_bottom ()</title>
<indexterm><primary>clutter_actor_lower_bottom</primary></indexterm><programlisting><link linkend="void">void</link>        clutter_actor_lower_bottom      (<link linkend="ClutterActor">ClutterActor</link> *self);</programlisting>
<para>
Lowers <parameter>self</parameter> to the bottom.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-set-depth" role="function"/>clutter_actor_set_depth ()</title>
<indexterm><primary>clutter_actor_set_depth</primary></indexterm><programlisting><link linkend="void">void</link>        clutter_actor_set_depth         (<link linkend="ClutterActor">ClutterActor</link> *self,
                                             <link linkend="gint">gint</link> depth);</programlisting>
<para>
Sets the Z co-ordinate of <parameter>self</parameter> to <parameter>depth</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>depth</parameter>&nbsp;:</term>
<listitem><simpara> Z co-ord
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-actor-get-depth" role="function"/>clutter_actor_get_depth ()</title>
<indexterm><primary>clutter_actor_get_depth</primary></indexterm><programlisting><link linkend="gint">gint</link>        clutter_actor_get_depth         (<link linkend="ClutterActor">ClutterActor</link> *self);</programlisting>
<para>
Retrieves the depth of <parameter>self</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the depth of a <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>
<refsect1 id="property_details">
<title id="property_details.title">Property Details</title>
<refsect2><title><anchor id="ClutterActor--height"/>The &quot;<literal>height</literal>&quot; property</title>
<indexterm><primary>ClutterActor:height</primary></indexterm><programlisting>  &quot;height&quot;               <link linkend="gint">gint</link>                  : Read / Write</programlisting>
<para>Height of actor in pixels.</para><para>Allowed values: &gt;= 0</para>
<para>Default value: 0</para>
</refsect2>
<refsect2><title><anchor id="ClutterActor--opacity"/>The &quot;<literal>opacity</literal>&quot; property</title>
<indexterm><primary>ClutterActor:opacity</primary></indexterm><programlisting>  &quot;opacity&quot;              <link linkend="guchar">guchar</link>                : Read / Write / Construct</programlisting>
<para>Opacity of actor.</para><para>Default value: 255</para>
</refsect2>
<refsect2><title><anchor id="ClutterActor--width"/>The &quot;<literal>width</literal>&quot; property</title>
<indexterm><primary>ClutterActor:width</primary></indexterm><programlisting>  &quot;width&quot;                <link linkend="gint">gint</link>                  : Read / Write</programlisting>
<para>Width of actor in pixels.</para><para>Allowed values: &gt;= 0</para>
<para>Default value: 0</para>
</refsect2>
<refsect2><title><anchor id="ClutterActor--x"/>The &quot;<literal>x</literal>&quot; property</title>
<indexterm><primary>ClutterActor:x</primary></indexterm><programlisting>  &quot;x&quot;                    <link linkend="gint">gint</link>                  : Read / Write</programlisting>
<para>X co-ord of actor.</para><para>Allowed values: &gt;= 0</para>
<para>Default value: 0</para>
</refsect2>
<refsect2><title><anchor id="ClutterActor--y"/>The &quot;<literal>y</literal>&quot; property</title>
<indexterm><primary>ClutterActor:y</primary></indexterm><programlisting>  &quot;y&quot;                    <link linkend="gint">gint</link>                  : Read / Write</programlisting>
<para>Y co-ord of actor.</para><para>Allowed values: &gt;= 0</para>
<para>Default value: 0</para>
</refsect2>

</refsect1>




</refentry>