update to 1.10.4
[profile/ivi/clutter.git] / doc / reference / clutter / html / clutter-ClutterPaintNode.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>ClutterPaintNode</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="ch08.html" title="Paint Objects">
9 <link rel="prev" href="ch08.html" title="Paint Objects">
10 <link rel="next" href="clutter-Paint-Nodes.html" title="Paint Nodes">
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="ch08.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ch08.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="clutter-Paint-Nodes.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="#clutter-ClutterPaintNode.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#clutter-ClutterPaintNode.description" class="shortcut">Description</a>
27 </td></tr>
28 </table>
29 <div class="refentry">
30 <a name="clutter-ClutterPaintNode"></a><div class="titlepage"></div>
31 <div class="refnamediv"><table width="100%"><tr>
32 <td valign="top">
33 <h2><span class="refentrytitle"><a name="clutter-ClutterPaintNode.top_of_page"></a>ClutterPaintNode</span></h2>
34 <p>ClutterPaintNode — Paint objects</p>
35 </td>
36 <td valign="top" align="right"></td>
37 </tr></table></div>
38 <div class="refsynopsisdiv">
39 <a name="clutter-ClutterPaintNode.synopsis"></a><h2>Synopsis</h2>
40 <pre class="synopsis">                    <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode">ClutterPaintNode</a>;
41                     <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNodeClass" title="ClutterPaintNodeClass">ClutterPaintNodeClass</a>;
42 <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="returnvalue">ClutterPaintNode</span></a> *  <a class="link" href="clutter-ClutterPaintNode.html#clutter-paint-node-ref" title="clutter_paint_node_ref ()">clutter_paint_node_ref</a>              (<em class="parameter"><code><a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a> *node</code></em>);
43 <span class="returnvalue">void</span>                <a class="link" href="clutter-ClutterPaintNode.html#clutter-paint-node-unref" title="clutter_paint_node_unref ()">clutter_paint_node_unref</a>            (<em class="parameter"><code><a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a> *node</code></em>);
44 <span class="returnvalue">void</span>                <a class="link" href="clutter-ClutterPaintNode.html#clutter-paint-node-set-name" title="clutter_paint_node_set_name ()">clutter_paint_node_set_name</a>         (<em class="parameter"><code><a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a> *node</code></em>,
45                                                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);
46
47 <span class="returnvalue">void</span>                <a class="link" href="clutter-ClutterPaintNode.html#clutter-paint-node-add-child" title="clutter_paint_node_add_child ()">clutter_paint_node_add_child</a>        (<em class="parameter"><code><a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a> *node</code></em>,
48                                                          <em class="parameter"><code><a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a> *child</code></em>);
49
50 <span class="returnvalue">void</span>                <a class="link" href="clutter-ClutterPaintNode.html#clutter-paint-node-add-rectangle" title="clutter_paint_node_add_rectangle ()">clutter_paint_node_add_rectangle</a>    (<em class="parameter"><code><a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a> *node</code></em>,
51                                                          <em class="parameter"><code>const <a class="link" href="ClutterActor.html#ClutterActorBox" title="struct ClutterActorBox"><span class="type">ClutterActorBox</span></a> *rect</code></em>);
52 <span class="returnvalue">void</span>                <a class="link" href="clutter-ClutterPaintNode.html#clutter-paint-node-add-texture-rectangle" title="clutter_paint_node_add_texture_rectangle ()">clutter_paint_node_add_texture_rectangle</a>
53                                                         (<em class="parameter"><code><a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a> *node</code></em>,
54                                                          <em class="parameter"><code>const <a class="link" href="ClutterActor.html#ClutterActorBox" title="struct ClutterActorBox"><span class="type">ClutterActorBox</span></a> *rect</code></em>,
55                                                          <em class="parameter"><code><span class="type">float</span> x_1</code></em>,
56                                                          <em class="parameter"><code><span class="type">float</span> y_1</code></em>,
57                                                          <em class="parameter"><code><span class="type">float</span> x_2</code></em>,
58                                                          <em class="parameter"><code><span class="type">float</span> y_2</code></em>);
59 <span class="returnvalue">void</span>                <a class="link" href="clutter-ClutterPaintNode.html#clutter-paint-node-add-path" title="clutter_paint_node_add_path ()">clutter_paint_node_add_path</a>         (<em class="parameter"><code><a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a> *node</code></em>,
60                                                          <em class="parameter"><code><span class="type">CoglPath</span> *path</code></em>);
61 <span class="returnvalue">void</span>                <a class="link" href="clutter-ClutterPaintNode.html#clutter-paint-node-add-primitive" title="clutter_paint_node_add_primitive ()">clutter_paint_node_add_primitive</a>    (<em class="parameter"><code><a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a> *node</code></em>,
62                                                          <em class="parameter"><code><span class="type">CoglPrimitive</span> *primitive</code></em>);
63
64 #define             <a class="link" href="clutter-ClutterPaintNode.html#CLUTTER-VALUE-HOLDS-PAINT-NODE:CAPS" title="CLUTTER_VALUE_HOLDS_PAINT_NODE()">CLUTTER_VALUE_HOLDS_PAINT_NODE</a>      (value)
65 <span class="returnvalue">void</span>                <a class="link" href="clutter-ClutterPaintNode.html#clutter-value-set-paint-node" title="clutter_value_set_paint_node ()">clutter_value_set_paint_node</a>        (<em class="parameter"><code><a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>,
66                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> node</code></em>);
67 <span class="returnvalue">void</span>                <a class="link" href="clutter-ClutterPaintNode.html#clutter-value-take-paint-node" title="clutter_value_take_paint_node ()">clutter_value_take_paint_node</a>       (<em class="parameter"><code><a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>,
68                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> node</code></em>);
69 <a href="../glib/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a>            <a class="link" href="clutter-ClutterPaintNode.html#clutter-value-get-paint-node" title="clutter_value_get_paint_node ()">clutter_value_get_paint_node</a>        (<em class="parameter"><code>const <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);
70 <a href="../glib/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a>            <a class="link" href="clutter-ClutterPaintNode.html#clutter-value-dup-paint-node" title="clutter_value_dup_paint_node ()">clutter_value_dup_paint_node</a>        (<em class="parameter"><code>const <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);
71 </pre>
72 </div>
73 <div class="refsect1">
74 <a name="clutter-ClutterPaintNode.description"></a><h2>Description</h2>
75 <p>
76 <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a> is an element in the render graph.
77 </p>
78 <p>
79 The render graph contains all the elements that need to be painted by
80 Clutter when submitting a frame to the graphics system.
81 </p>
82 <p>
83 The render graph is distinct from the scene graph: the scene graph is
84 composed by actors, which can be visible or invisible; the scene graph
85 elements also respond to events. The render graph, instead, is only
86 composed by nodes that will be painted.
87 </p>
88 <p>
89 Each <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> can submit multiple <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a>s to
90 the render graph.
91 </p>
92 </div>
93 <div class="refsect1">
94 <a name="clutter-ClutterPaintNode.details"></a><h2>Details</h2>
95 <div class="refsect2">
96 <a name="ClutterPaintNode"></a><h3>ClutterPaintNode</h3>
97 <pre class="programlisting">typedef struct _ClutterPaintNode ClutterPaintNode;</pre>
98 <p>
99 The <span class="structname">ClutterPaintNode</span> structure contains only
100 private data and it should be accessed using the provided API.
101 </p>
102 <p>
103 Ref Func: clutter_paint_node_ref
104 Unref Func: clutter_paint_node_unref
105 Set Value Func: clutter_value_set_paint_node
106 Get Value Func: clutter_value_get_paint_node
107 </p>
108 <p class="since">Since 1.10</p>
109 </div>
110 <hr>
111 <div class="refsect2">
112 <a name="ClutterPaintNodeClass"></a><h3>ClutterPaintNodeClass</h3>
113 <pre class="programlisting">typedef struct _ClutterPaintNodeClass ClutterPaintNodeClass;</pre>
114 <p>
115 The <span class="structname">ClutterPaintNodeClass</span> structure contains
116 only private data.
117 </p>
118 <p class="since">Since 1.10</p>
119 </div>
120 <hr>
121 <div class="refsect2">
122 <a name="clutter-paint-node-ref"></a><h3>clutter_paint_node_ref ()</h3>
123 <pre class="programlisting"><a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="returnvalue">ClutterPaintNode</span></a> *  clutter_paint_node_ref              (<em class="parameter"><code><a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a> *node</code></em>);</pre>
124 <p>
125 Acquires a reference on <em class="parameter"><code>node</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>node</code></em> :</span></p></td>
132 <td>a <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></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 <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
138 </td>
139 </tr>
140 </tbody>
141 </table></div>
142 <p class="since">Since 1.10</p>
143 </div>
144 <hr>
145 <div class="refsect2">
146 <a name="clutter-paint-node-unref"></a><h3>clutter_paint_node_unref ()</h3>
147 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_paint_node_unref            (<em class="parameter"><code><a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a> *node</code></em>);</pre>
148 <p>
149 Releases a reference on <em class="parameter"><code>node</code></em>.
150 </p>
151 <div class="variablelist"><table border="0">
152 <col align="left" valign="top">
153 <tbody><tr>
154 <td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
155 <td>a <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a>
156 </td>
157 </tr></tbody>
158 </table></div>
159 <p class="since">Since 1.10</p>
160 </div>
161 <hr>
162 <div class="refsect2">
163 <a name="clutter-paint-node-set-name"></a><h3>clutter_paint_node_set_name ()</h3>
164 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_paint_node_set_name         (<em class="parameter"><code><a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a> *node</code></em>,
165                                                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre>
166 <p>
167 Sets a user-readable <em class="parameter"><code>name</code></em> for <em class="parameter"><code>node</code></em>.
168 </p>
169 <p>
170 The <em class="parameter"><code>name</code></em> will be used for debugging purposes.
171 </p>
172 <p>
173 The <em class="parameter"><code>node</code></em> will copy the passed string.
174 </p>
175 <div class="variablelist"><table border="0">
176 <col align="left" valign="top">
177 <tbody>
178 <tr>
179 <td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
180 <td>a <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a>
181 </td>
182 </tr>
183 <tr>
184 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
185 <td>a string annotating the <em class="parameter"><code>node</code></em>
186 </td>
187 </tr>
188 </tbody>
189 </table></div>
190 <p class="since">Since 1.10</p>
191 </div>
192 <hr>
193 <div class="refsect2">
194 <a name="clutter-paint-node-add-child"></a><h3>clutter_paint_node_add_child ()</h3>
195 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_paint_node_add_child        (<em class="parameter"><code><a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a> *node</code></em>,
196                                                          <em class="parameter"><code><a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a> *child</code></em>);</pre>
197 <p>
198 Adds <em class="parameter"><code>child</code></em> to the list of children of <em class="parameter"><code>node</code></em>.
199 </p>
200 <p>
201 This function will acquire a reference on <em class="parameter"><code>child</code></em>.
202 </p>
203 <div class="variablelist"><table border="0">
204 <col align="left" valign="top">
205 <tbody>
206 <tr>
207 <td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
208 <td>a <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a>
209 </td>
210 </tr>
211 <tr>
212 <td><p><span class="term"><em class="parameter"><code>child</code></em> :</span></p></td>
213 <td>the child <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a> to add</td>
214 </tr>
215 </tbody>
216 </table></div>
217 <p class="since">Since 1.10</p>
218 </div>
219 <hr>
220 <div class="refsect2">
221 <a name="clutter-paint-node-add-rectangle"></a><h3>clutter_paint_node_add_rectangle ()</h3>
222 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_paint_node_add_rectangle    (<em class="parameter"><code><a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a> *node</code></em>,
223                                                          <em class="parameter"><code>const <a class="link" href="ClutterActor.html#ClutterActorBox" title="struct ClutterActorBox"><span class="type">ClutterActorBox</span></a> *rect</code></em>);</pre>
224 <p>
225 Adds a rectangle region to the <em class="parameter"><code>node</code></em>, as described by the
226 passed <em class="parameter"><code>rect</code></em>.
227 </p>
228 <div class="variablelist"><table border="0">
229 <col align="left" valign="top">
230 <tbody>
231 <tr>
232 <td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
233 <td>a <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a>
234 </td>
235 </tr>
236 <tr>
237 <td><p><span class="term"><em class="parameter"><code>rect</code></em> :</span></p></td>
238 <td>a <a class="link" href="ClutterActor.html#ClutterActorBox" title="struct ClutterActorBox"><span class="type">ClutterActorBox</span></a>
239 </td>
240 </tr>
241 </tbody>
242 </table></div>
243 <p class="since">Since 1.10</p>
244 </div>
245 <hr>
246 <div class="refsect2">
247 <a name="clutter-paint-node-add-texture-rectangle"></a><h3>clutter_paint_node_add_texture_rectangle ()</h3>
248 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_paint_node_add_texture_rectangle
249                                                         (<em class="parameter"><code><a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a> *node</code></em>,
250                                                          <em class="parameter"><code>const <a class="link" href="ClutterActor.html#ClutterActorBox" title="struct ClutterActorBox"><span class="type">ClutterActorBox</span></a> *rect</code></em>,
251                                                          <em class="parameter"><code><span class="type">float</span> x_1</code></em>,
252                                                          <em class="parameter"><code><span class="type">float</span> y_1</code></em>,
253                                                          <em class="parameter"><code><span class="type">float</span> x_2</code></em>,
254                                                          <em class="parameter"><code><span class="type">float</span> y_2</code></em>);</pre>
255 <p>
256 Adds a rectangle region to the <em class="parameter"><code>node</code></em>, with texture coordinates.
257 </p>
258 <div class="variablelist"><table border="0">
259 <col align="left" valign="top">
260 <tbody>
261 <tr>
262 <td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
263 <td>a <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a>
264 </td>
265 </tr>
266 <tr>
267 <td><p><span class="term"><em class="parameter"><code>rect</code></em> :</span></p></td>
268 <td>a <a class="link" href="ClutterActor.html#ClutterActorBox" title="struct ClutterActorBox"><span class="type">ClutterActorBox</span></a>
269 </td>
270 </tr>
271 <tr>
272 <td><p><span class="term"><em class="parameter"><code>x_1</code></em> :</span></p></td>
273 <td>the left X coordinate of the texture</td>
274 </tr>
275 <tr>
276 <td><p><span class="term"><em class="parameter"><code>y_1</code></em> :</span></p></td>
277 <td>the top Y coordinate of the texture</td>
278 </tr>
279 <tr>
280 <td><p><span class="term"><em class="parameter"><code>x_2</code></em> :</span></p></td>
281 <td>the right X coordinate of the texture</td>
282 </tr>
283 <tr>
284 <td><p><span class="term"><em class="parameter"><code>y_2</code></em> :</span></p></td>
285 <td>the bottom Y coordinate of the texture</td>
286 </tr>
287 </tbody>
288 </table></div>
289 <p class="since">Since 1.10</p>
290 </div>
291 <hr>
292 <div class="refsect2">
293 <a name="clutter-paint-node-add-path"></a><h3>clutter_paint_node_add_path ()</h3>
294 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_paint_node_add_path         (<em class="parameter"><code><a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a> *node</code></em>,
295                                                          <em class="parameter"><code><span class="type">CoglPath</span> *path</code></em>);</pre>
296 <p>
297 Adds a region described as a path to the <em class="parameter"><code>node</code></em>.
298 </p>
299 <p>
300 This function acquires a reference on the passed <em class="parameter"><code>path</code></em>, so it
301 is safe to call <code class="function">cogl_object_unref()</code> when it returns.
302 </p>
303 <div class="variablelist"><table border="0">
304 <col align="left" valign="top">
305 <tbody>
306 <tr>
307 <td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
308 <td>a <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a>
309 </td>
310 </tr>
311 <tr>
312 <td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
313 <td>a Cogl path</td>
314 </tr>
315 </tbody>
316 </table></div>
317 <p class="since">Since 1.10</p>
318 <p class="stability">Stability Level: Unstable</p>
319 </div>
320 <hr>
321 <div class="refsect2">
322 <a name="clutter-paint-node-add-primitive"></a><h3>clutter_paint_node_add_primitive ()</h3>
323 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_paint_node_add_primitive    (<em class="parameter"><code><a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a> *node</code></em>,
324                                                          <em class="parameter"><code><span class="type">CoglPrimitive</span> *primitive</code></em>);</pre>
325 <p>
326 Adds a region described by a Cogl primitive to the <em class="parameter"><code>node</code></em>.
327 </p>
328 <p>
329 This function acquires a reference on <em class="parameter"><code>primitive</code></em>, so it is safe
330 to call <code class="function">cogl_object_unref()</code> when it returns.
331 </p>
332 <div class="variablelist"><table border="0">
333 <col align="left" valign="top">
334 <tbody>
335 <tr>
336 <td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
337 <td>a <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a>
338 </td>
339 </tr>
340 <tr>
341 <td><p><span class="term"><em class="parameter"><code>primitive</code></em> :</span></p></td>
342 <td>a Cogl primitive</td>
343 </tr>
344 </tbody>
345 </table></div>
346 <p class="since">Since 1.10</p>
347 </div>
348 <hr>
349 <div class="refsect2">
350 <a name="CLUTTER-VALUE-HOLDS-PAINT-NODE:CAPS"></a><h3>CLUTTER_VALUE_HOLDS_PAINT_NODE()</h3>
351 <pre class="programlisting">#define CLUTTER_VALUE_HOLDS_PAINT_NODE(value)   (G_VALUE_HOLDS (value, CLUTTER_TYPE_PAINT_NODE))
352 </pre>
353 </div>
354 <hr>
355 <div class="refsect2">
356 <a name="clutter-value-set-paint-node"></a><h3>clutter_value_set_paint_node ()</h3>
357 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_value_set_paint_node        (<em class="parameter"><code><a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>,
358                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> node</code></em>);</pre>
359 <p>
360 Sets the contents of a <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> initialized with <code class="literal">CLUTTER_TYPE_PAINT_NODE</code>.
361 </p>
362 <p>
363 This function increased the reference count of <em class="parameter"><code>node</code></em>; if you do not wish
364 to increase the reference count, use <a class="link" href="clutter-ClutterPaintNode.html#clutter-value-take-paint-node" title="clutter_value_take_paint_node ()"><code class="function">clutter_value_take_paint_node()</code></a>
365 instead. The reference count will be released by <a href="../gobject/gobject-Generic-values.html#g-value-unset"><code class="function">g_value_unset()</code></a>.
366 </p>
367 <div class="variablelist"><table border="0">
368 <col align="left" valign="top">
369 <tbody>
370 <tr>
371 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
372 <td>a <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> initialized with <code class="literal">CLUTTER_TYPE_PAINT_NODE</code>
373 </td>
374 </tr>
375 <tr>
376 <td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
377 <td>a <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</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="Override the parsed C type with given type."><span class="acronym">type</span></acronym> Clutter.PaintNode][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
378 </td>
379 </tr>
380 </tbody>
381 </table></div>
382 <p class="since">Since 1.10</p>
383 </div>
384 <hr>
385 <div class="refsect2">
386 <a name="clutter-value-take-paint-node"></a><h3>clutter_value_take_paint_node ()</h3>
387 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_value_take_paint_node       (<em class="parameter"><code><a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>,
388                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> node</code></em>);</pre>
389 <p>
390 Sets the contents of a <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> initialized with <code class="literal">CLUTTER_TYPE_PAINT_NODE</code>.
391 </p>
392 <p>
393 Unlike <a class="link" href="clutter-ClutterPaintNode.html#clutter-value-set-paint-node" title="clutter_value_set_paint_node ()"><code class="function">clutter_value_set_paint_node()</code></a>, this function will not take a
394 reference on the passed <em class="parameter"><code>node</code></em>: instead, it will take ownership of the
395 current reference count.
396 </p>
397 <div class="variablelist"><table border="0">
398 <col align="left" valign="top">
399 <tbody>
400 <tr>
401 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
402 <td>a <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>, initialized with <code class="literal">CLUTTER_TYPE_PAINT_NODE</code>
403 </td>
404 </tr>
405 <tr>
406 <td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
407 <td>a <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</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="Override the parsed C type with given type."><span class="acronym">type</span></acronym> Clutter.PaintNode][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
408 </td>
409 </tr>
410 </tbody>
411 </table></div>
412 <p class="since">Since 1.10</p>
413 </div>
414 <hr>
415 <div class="refsect2">
416 <a name="clutter-value-get-paint-node"></a><h3>clutter_value_get_paint_node ()</h3>
417 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a>            clutter_value_get_paint_node        (<em class="parameter"><code>const <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
418 <p>
419 Retrieves a pointer to the <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a> contained inside
420 the passed <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>.
421 </p>
422 <div class="variablelist"><table border="0">
423 <col align="left" valign="top">
424 <tbody>
425 <tr>
426 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
427 <td>a <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> initialized with <code class="literal">CLUTTER_TYPE_PAINT_NODE</code>
428 </td>
429 </tr>
430 <tr>
431 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
432 <td>a pointer to
433 a <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</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="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> Clutter.PaintNode]</span>
434 </td>
435 </tr>
436 </tbody>
437 </table></div>
438 <p class="since">Since 1.10</p>
439 </div>
440 <hr>
441 <div class="refsect2">
442 <a name="clutter-value-dup-paint-node"></a><h3>clutter_value_dup_paint_node ()</h3>
443 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a>            clutter_value_dup_paint_node        (<em class="parameter"><code>const <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
444 <p>
445 Retrieves a pointer to the <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a> contained inside
446 the passed <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>, and if not <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> it will increase the
447 reference count.
448 </p>
449 <div class="variablelist"><table border="0">
450 <col align="left" valign="top">
451 <tbody>
452 <tr>
453 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
454 <td>a <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> initialized with <code class="literal">CLUTTER_TYPE_PAINT_NODE</code>
455 </td>
456 </tr>
457 <tr>
458 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
459 <td>a pointer
460 to the <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a>, with its reference count increased,
461 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="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> Clutter.PaintNode]</span>
462 </td>
463 </tr>
464 </tbody>
465 </table></div>
466 <p class="since">Since 1.10</p>
467 </div>
468 </div>
469 </div>
470 <div class="footer">
471 <hr>
472           Generated by GTK-Doc V1.18.1</div>
473 </body>
474 </html>