1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
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">
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">
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>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#ClutterClone.synopsis" class="shortcut">Top</a>
26 <a href="#ClutterClone.description" class="shortcut">Description</a>
28 <a href="#ClutterClone.object-hierarchy" class="shortcut">Object Hierarchy</a>
30 <a href="#ClutterClone.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
32 <a href="#ClutterClone.properties" class="shortcut">Properties</a>
35 <div class="refentry">
36 <a name="ClutterClone"></a><div class="titlepage"></div>
37 <div class="refnamediv"><table width="100%"><tr>
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>
42 <td valign="top" align="right"></td>
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>);
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>
63 <div class="refsect1">
64 <a name="ClutterClone.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
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>
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
75 <div class="refsect1">
76 <a name="ClutterClone.description"></a><h2>Description</h2>
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.
82 <a class="link" href="ClutterClone.html" title="ClutterClone"><span class="type">ClutterClone</span></a> can be used to efficiently clone any other actor.
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
95 <a class="link" href="ClutterClone.html" title="ClutterClone"><span class="type">ClutterClone</span></a> is available since Clutter 1.0
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>
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
107 <p class="since">Since 1.0</p>
110 <div class="refsect2">
111 <a name="ClutterCloneClass"></a><h3>struct ClutterCloneClass</h3>
112 <pre class="programlisting">struct ClutterCloneClass {
116 The <a class="link" href="ClutterClone.html#ClutterCloneClass" title="struct ClutterCloneClass"><span class="type">ClutterCloneClass</span></a> structure contains only private data
118 <p class="since">Since 1.0</p>
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>
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>/
127 <div class="variablelist"><table border="0">
128 <col align="left" valign="top">
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>
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>
142 <p class="since">Since 1.0</p>
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>
150 Sets <em class="parameter"><code>source</code></em> as the source actor to be cloned by <em class="parameter"><code>self</code></em>.
152 <div class="variablelist"><table border="0">
153 <col align="left" valign="top">
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>
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>
167 <p class="since">Since 1.0</p>
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>
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>.
176 <div class="variablelist"><table border="0">
177 <col align="left" valign="top">
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>
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>
191 <p class="since">Since 1.0</p>
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>
200 This property specifies the source actor being cloned.
202 <p class="since">Since 1.0</p>
208 Generated by GTK-Doc V1.18.1</div>