doc/reference/clutter/html/ClutterClone.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>ClutterClone</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="Clutter Reference Manual">
   8 <link rel="up" href="ch02.html" title="Base actors">
   9 <link rel="prev" href="ClutterTexture.html" title="ClutterTexture">
  10 <link rel="next" href="ClutterText.html" title="ClutterText">
  11 <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="ClutterTexture.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">Clutter Reference Manual</th>
  21 <td><a accesskey="n" href="ClutterText.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#ClutterClone.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#ClutterClone.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#ClutterClone.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#ClutterClone.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#ClutterClone.properties" class="shortcut">Properties</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="ClutterClone"></a><div class="titlepage"></div>
  37 <div class="refnamediv"><table width="100%"><tr>
  38 <td valign="top">
  39 <h2><span class="refentrytitle"><a name="ClutterClone.top_of_page"></a>ClutterClone</span></h2>
  40 <p>ClutterClone — An actor that displays a clone of a source actor</p>
  41 </td>
  42 <td valign="top" align="right"></td>
  43 </tr></table></div>
  44 <div class="refsynopsisdiv">
  45 <a name="ClutterClone.synopsis"></a><h2>Synopsis</h2>
  46 <pre class="synopsis">struct              <a class="link" href="ClutterClone.html#ClutterClone-struct" title="struct ClutterClone">ClutterClone</a>;
  47 struct              <a class="link" href="ClutterClone.html#ClutterCloneClass" title="struct ClutterCloneClass">ClutterCloneClass</a>;
  48 <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      <a class="link" href="ClutterClone.html#clutter-clone-new" title="clutter_clone_new ()">clutter_clone_new</a>                   (<em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *source</code></em>);
  49 <span class="returnvalue">void</span>                <a class="link" href="ClutterClone.html#clutter-clone-set-source" title="clutter_clone_set_source ()">clutter_clone_set_source</a>            (<em class="parameter"><code><a class="link" href="ClutterClone.html" title="ClutterClone"><span class="type">ClutterClone</span></a> *self</code></em>,
  50                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *source</code></em>);
  51 <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      <a class="link" href="ClutterClone.html#clutter-clone-get-source" title="clutter_clone_get_source ()">clutter_clone_get_source</a>            (<em class="parameter"><code><a class="link" href="ClutterClone.html" title="ClutterClone"><span class="type">ClutterClone</span></a> *self</code></em>);
  52 </pre>
  53 </div>
  54 <div class="refsect1">
  55 <a name="ClutterClone.object-hierarchy"></a><h2>Object Hierarchy</h2>
  56 <pre class="synopsis">
  57   <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  58    +----<a href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
  59          +----<a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a>
  60                +----ClutterClone
  61 </pre>
  62 </div>
  63 <div class="refsect1">
  64 <a name="ClutterClone.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  65 <p>
  66 ClutterClone implements
  67  <a class="link" href="ClutterContainer.html" title="ClutterContainer">ClutterContainer</a>,  <a class="link" href="ClutterScriptable.html" title="ClutterScriptable">ClutterScriptable</a>,  <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable">ClutterAnimatable</a> and  AtkImplementorIface.</p>
  68 </div>
  69 <div class="refsect1">
  70 <a name="ClutterClone.properties"></a><h2>Properties</h2>
  71 <pre class="synopsis">
  72   "<a class="link" href="ClutterClone.html#ClutterClone--source" title='The "source" property'>source</a>"                   <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>*         : Read / Write / Construct
  73 </pre>
  74 </div>
  75 <div class="refsect1">
  76 <a name="ClutterClone.description"></a><h2>Description</h2>
  77 <p>
  78 <a class="link" href="ClutterClone.html" title="ClutterClone"><span class="type">ClutterClone</span></a> is a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> which draws with the paint
  79 function of another actor, scaled to fit its own allocation.
  80 </p>
  81 <p>
  82 <a class="link" href="ClutterClone.html" title="ClutterClone"><span class="type">ClutterClone</span></a> can be used to efficiently clone any other actor.
  83 </p>
  84 <p>
  85 </p>
  86 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
  87 <h3 class="title">Note</h3>
  88 <p>This is different from <a class="link" href="ClutterTexture.html#clutter-texture-new-from-actor" title="clutter_texture_new_from_actor ()"><code class="function">clutter_texture_new_from_actor()</code></a>
  89 which requires support for FBOs in the underlying GL
  90 implementation.</p>
  91 </div>
  92 <p>
  93 </p>
  94 <p>
  95 <a class="link" href="ClutterClone.html" title="ClutterClone"><span class="type">ClutterClone</span></a> is available since Clutter 1.0
  96 </p>
  97 </div>
  98 <div class="refsect1">
  99 <a name="ClutterClone.details"></a><h2>Details</h2>
 100 <div class="refsect2">
 101 <a name="ClutterClone-struct"></a><h3>struct ClutterClone</h3>
 102 <pre class="programlisting">struct ClutterClone;</pre>
 103 <p>
 104 The <a class="link" href="ClutterClone.html" title="ClutterClone"><span class="type">ClutterClone</span></a> structure contains only private data
 105 and should be accessed using the provided API
 106 </p>
 107 <p class="since">Since 1.0</p>
 108 </div>
 109 <hr>
 110 <div class="refsect2">
 111 <a name="ClutterCloneClass"></a><h3>struct ClutterCloneClass</h3>
 112 <pre class="programlisting">struct ClutterCloneClass {
 113 };
 114 </pre>
 115 <p>
 116 The <a class="link" href="ClutterClone.html#ClutterCloneClass" title="struct ClutterCloneClass"><span class="type">ClutterCloneClass</span></a> structure contains only private data
 117 </p>
 118 <p class="since">Since 1.0</p>
 119 </div>
 120 <hr>
 121 <div class="refsect2">
 122 <a name="clutter-clone-new"></a><h3>clutter_clone_new ()</h3>
 123 <pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_clone_new                   (<em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *source</code></em>);</pre>
 124 <p>
 125 Creates a new <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> which clones <em class="parameter"><code>source</code></em>/
 126 </p>
 127 <div class="variablelist"><table border="0">
 128 <col align="left" valign="top">
 129 <tbody>
 130 <tr>
 131 <td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
 132 <td>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
 133 </td>
 134 </tr>
 135 <tr>
 136 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 137 <td>the newly created <a class="link" href="ClutterClone.html" title="ClutterClone"><span class="type">ClutterClone</span></a>
 138 </td>
 139 </tr>
 140 </tbody>
 141 </table></div>
 142 <p class="since">Since 1.0</p>
 143 </div>
 144 <hr>
 145 <div class="refsect2">
 146 <a name="clutter-clone-set-source"></a><h3>clutter_clone_set_source ()</h3>
 147 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_clone_set_source            (<em class="parameter"><code><a class="link" href="ClutterClone.html" title="ClutterClone"><span class="type">ClutterClone</span></a> *self</code></em>,
 148                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *source</code></em>);</pre>
 149 <p>
 150 Sets <em class="parameter"><code>source</code></em> as the source actor to be cloned by <em class="parameter"><code>self</code></em>.
 151 </p>
 152 <div class="variablelist"><table border="0">
 153 <col align="left" valign="top">
 154 <tbody>
 155 <tr>
 156 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 157 <td>a <a class="link" href="ClutterClone.html" title="ClutterClone"><span class="type">ClutterClone</span></a>
 158 </td>
 159 </tr>
 160 <tr>
 161 <td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
 162 <td>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 163 </td>
 164 </tr>
 165 </tbody>
 166 </table></div>
 167 <p class="since">Since 1.0</p>
 168 </div>
 169 <hr>
 170 <div class="refsect2">
 171 <a name="clutter-clone-get-source"></a><h3>clutter_clone_get_source ()</h3>
 172 <pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_clone_get_source            (<em class="parameter"><code><a class="link" href="ClutterClone.html" title="ClutterClone"><span class="type">ClutterClone</span></a> *self</code></em>);</pre>
 173 <p>
 174 Retrieves the source <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> being cloned by <em class="parameter"><code>self</code></em>.
 175 </p>
 176 <div class="variablelist"><table border="0">
 177 <col align="left" valign="top">
 178 <tbody>
 179 <tr>
 180 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 181 <td>a <a class="link" href="ClutterClone.html" title="ClutterClone"><span class="type">ClutterClone</span></a>
 182 </td>
 183 </tr>
 184 <tr>
 185 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 186 <td>the actor source for the clone. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 187 </td>
 188 </tr>
 189 </tbody>
 190 </table></div>
 191 <p class="since">Since 1.0</p>
 192 </div>
 193 </div>
 194 <div class="refsect1">
 195 <a name="ClutterClone.property-details"></a><h2>Property Details</h2>
 196 <div class="refsect2">
 197 <a name="ClutterClone--source"></a><h3>The <code class="literal">"source"</code> property</h3>
 198 <pre class="programlisting">  "source"                   <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>*         : Read / Write / Construct</pre>
 199 <p>
 200 This property specifies the source actor being cloned.
 201 </p>
 202 <p class="since">Since 1.0</p>
 203 </div>
 204 </div>
 205 </div>
 206 <div class="footer">
 207 <hr>
 208           Generated by GTK-Doc V1.18.1</div>
 209 </body>
 210 </html>