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>Paint Nodes</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="clutter-ClutterPaintNode.html" title="ClutterPaintNode">
10 <link rel="next" href="clutteranimation.html" title="Part V. Clutter Animation Framework">
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="clutter-ClutterPaintNode.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="clutteranimation.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="#clutter-Paint-Nodes.synopsis" class="shortcut">Top</a>
26 <a href="#clutter-Paint-Nodes.description" class="shortcut">Description</a>
29 <div class="refentry">
30 <a name="clutter-Paint-Nodes"></a><div class="titlepage"></div>
31 <div class="refnamediv"><table width="100%"><tr>
33 <h2><span class="refentrytitle"><a name="clutter-Paint-Nodes.top_of_page"></a>Paint Nodes</span></h2>
34 <p>Paint Nodes — ClutterPaintNode implementations</p>
36 <td valign="top" align="right"></td>
38 <div class="refsynopsisdiv">
39 <a name="clutter-Paint-Nodes.synopsis"></a><h2>Synopsis</h2>
40 <pre class="synopsis"> <a class="link" href="clutter-Paint-Nodes.html#ClutterColorNode" title="ClutterColorNode">ClutterColorNode</a>;
41 <a class="link" href="clutter-Paint-Nodes.html#ClutterColorNodeClass" title="ClutterColorNodeClass">ClutterColorNodeClass</a>;
42 <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="returnvalue">ClutterPaintNode</span></a> * <a class="link" href="clutter-Paint-Nodes.html#clutter-color-node-new" title="clutter_color_node_new ()">clutter_color_node_new</a> (<em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);
44 <a class="link" href="clutter-Paint-Nodes.html#ClutterTextureNode" title="ClutterTextureNode">ClutterTextureNode</a>;
45 <a class="link" href="clutter-Paint-Nodes.html#ClutterTextureNodeClass" title="ClutterTextureNodeClass">ClutterTextureNodeClass</a>;
46 <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="returnvalue">ClutterPaintNode</span></a> * <a class="link" href="clutter-Paint-Nodes.html#clutter-texture-node-new" title="clutter_texture_node_new ()">clutter_texture_node_new</a> (<em class="parameter"><code><span class="type">CoglTexture</span> *texture</code></em>,
47 <em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>,
48 <em class="parameter"><code><a class="link" href="ClutterActor.html#ClutterScalingFilter" title="enum ClutterScalingFilter"><span class="type">ClutterScalingFilter</span></a> min_filter</code></em>,
49 <em class="parameter"><code><a class="link" href="ClutterActor.html#ClutterScalingFilter" title="enum ClutterScalingFilter"><span class="type">ClutterScalingFilter</span></a> mag_filter</code></em>);
51 <a class="link" href="clutter-Paint-Nodes.html#ClutterPipelineNode" title="ClutterPipelineNode">ClutterPipelineNode</a>;
52 <a class="link" href="clutter-Paint-Nodes.html#ClutterPipelineNodeClass" title="ClutterPipelineNodeClass">ClutterPipelineNodeClass</a>;
53 <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="returnvalue">ClutterPaintNode</span></a> * <a class="link" href="clutter-Paint-Nodes.html#clutter-pipeline-node-new" title="clutter_pipeline_node_new ()">clutter_pipeline_node_new</a> (<em class="parameter"><code><span class="type">CoglPipeline</span> *pipeline</code></em>);
55 <a class="link" href="clutter-Paint-Nodes.html#ClutterTextNode" title="ClutterTextNode">ClutterTextNode</a>;
56 <a class="link" href="clutter-Paint-Nodes.html#ClutterTextNodeClass" title="ClutterTextNodeClass">ClutterTextNodeClass</a>;
57 <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="returnvalue">ClutterPaintNode</span></a> * <a class="link" href="clutter-Paint-Nodes.html#clutter-text-node-new" title="clutter_text_node_new ()">clutter_text_node_new</a> (<em class="parameter"><code><a href="../pango/pango-Layout-Objects.html#PangoLayout"><span class="type">PangoLayout</span></a> *layout</code></em>,
58 <em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);
60 <a class="link" href="clutter-Paint-Nodes.html#ClutterClipNode" title="ClutterClipNode">ClutterClipNode</a>;
61 <a class="link" href="clutter-Paint-Nodes.html#ClutterClipNodeClass" title="ClutterClipNodeClass">ClutterClipNodeClass</a>;
62 <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="returnvalue">ClutterPaintNode</span></a> * <a class="link" href="clutter-Paint-Nodes.html#clutter-clip-node-new" title="clutter_clip_node_new ()">clutter_clip_node_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
65 <div class="refsect1">
66 <a name="clutter-Paint-Nodes.description"></a><h2>Description</h2>
68 Clutter provides a set of predefined <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a> implementations
69 that cover all the state changes available.
72 <div class="refsect1">
73 <a name="clutter-Paint-Nodes.details"></a><h2>Details</h2>
74 <div class="refsect2">
75 <a name="ClutterColorNode"></a><h3>ClutterColorNode</h3>
76 <pre class="programlisting">typedef struct _ClutterColorNode ClutterColorNode;</pre>
78 The <span class="structname">ClutterTextNode</span> structure is an opaque
79 type whose members cannot be directly accessed.
81 <p class="since">Since 1.10</p>
84 <div class="refsect2">
85 <a name="ClutterColorNodeClass"></a><h3>ClutterColorNodeClass</h3>
86 <pre class="programlisting">typedef struct _ClutterColorNodeClass ClutterColorNodeClass;</pre>
88 The <span class="structname">ClutterColorNodeClass</span> structure is an
89 opaque type whose members cannot be directly accessed.
91 <p class="since">Since 1.10</p>
94 <div class="refsect2">
95 <a name="clutter-color-node-new"></a><h3>clutter_color_node_new ()</h3>
96 <pre class="programlisting"><a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="returnvalue">ClutterPaintNode</span></a> * clutter_color_node_new (<em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
98 Creates a new <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a> that will paint a solid color
99 fill using <em class="parameter"><code>color</code></em>.
101 <div class="variablelist"><table border="0">
102 <col align="left" valign="top">
105 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
106 <td>the color to paint, 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>
110 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
111 <td>the newly created <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a>. Use
112 <a class="link" href="clutter-ClutterPaintNode.html#clutter-paint-node-unref" title="clutter_paint_node_unref ()"><code class="function">clutter_paint_node_unref()</code></a> when done. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
117 <p class="since">Since 1.10</p>
120 <div class="refsect2">
121 <a name="ClutterTextureNode"></a><h3>ClutterTextureNode</h3>
122 <pre class="programlisting">typedef struct _ClutterTextureNode ClutterTextureNode;</pre>
124 The <span class="structname">ClutterTextNode</span> structure is an opaque
125 type whose members cannot be directly accessed.
127 <p class="since">Since 1.10</p>
130 <div class="refsect2">
131 <a name="ClutterTextureNodeClass"></a><h3>ClutterTextureNodeClass</h3>
132 <pre class="programlisting">typedef struct _ClutterTextureNodeClass ClutterTextureNodeClass;</pre>
134 The <span class="structname">ClutterTextureNodeClass</span> structure is an
135 opaque type whose members cannot be directly accessed.
137 <p class="since">Since 1.10</p>
140 <div class="refsect2">
141 <a name="clutter-texture-node-new"></a><h3>clutter_texture_node_new ()</h3>
142 <pre class="programlisting"><a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="returnvalue">ClutterPaintNode</span></a> * clutter_texture_node_new (<em class="parameter"><code><span class="type">CoglTexture</span> *texture</code></em>,
143 <em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>,
144 <em class="parameter"><code><a class="link" href="ClutterActor.html#ClutterScalingFilter" title="enum ClutterScalingFilter"><span class="type">ClutterScalingFilter</span></a> min_filter</code></em>,
145 <em class="parameter"><code><a class="link" href="ClutterActor.html#ClutterScalingFilter" title="enum ClutterScalingFilter"><span class="type">ClutterScalingFilter</span></a> mag_filter</code></em>);</pre>
147 Creates a new <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a> that will paint the passed <em class="parameter"><code>texture</code></em>.
150 This function will take a reference on <em class="parameter"><code>texture</code></em>, so it is safe to
151 call <code class="function">cogl_object_unref()</code> on <em class="parameter"><code>texture</code></em> when it returns.
153 <div class="variablelist"><table border="0">
154 <col align="left" valign="top">
157 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
158 <td>a <span class="type">CoglTexture</span>
162 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
163 <td>a <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>
167 <td><p><span class="term"><em class="parameter"><code>min_filter</code></em> :</span></p></td>
168 <td>the minification filter for the texture</td>
171 <td><p><span class="term"><em class="parameter"><code>mag_filter</code></em> :</span></p></td>
172 <td>the magnification filter for the texture</td>
175 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
176 <td>the newly created <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a>.
177 Use <a class="link" href="clutter-ClutterPaintNode.html#clutter-paint-node-unref" title="clutter_paint_node_unref ()"><code class="function">clutter_paint_node_unref()</code></a> when done. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
182 <p class="since">Since 1.10</p>
185 <div class="refsect2">
186 <a name="ClutterPipelineNode"></a><h3>ClutterPipelineNode</h3>
187 <pre class="programlisting">typedef struct _ClutterPipelineNode ClutterPipelineNode;</pre>
189 The <span class="structname">ClutterTextNode</span> structure is an opaque
190 type whose members cannot be directly accessed.
192 <p class="since">Since 1.10</p>
195 <div class="refsect2">
196 <a name="ClutterPipelineNodeClass"></a><h3>ClutterPipelineNodeClass</h3>
197 <pre class="programlisting">typedef struct _ClutterPipelineNodeClass ClutterPipelineNodeClass;</pre>
199 The <span class="structname">ClutterPipelineNodeClass</span> structure is an opaque
200 type whose members cannot be directly accessed.
202 <p class="since">Since 1.10</p>
205 <div class="refsect2">
206 <a name="clutter-pipeline-node-new"></a><h3>clutter_pipeline_node_new ()</h3>
207 <pre class="programlisting"><a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="returnvalue">ClutterPaintNode</span></a> * clutter_pipeline_node_new (<em class="parameter"><code><span class="type">CoglPipeline</span> *pipeline</code></em>);</pre>
209 Creates a new <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a> that will use the <em class="parameter"><code>pipeline</code></em> to
213 This function will acquire a reference on the passed <em class="parameter"><code>pipeline</code></em>,
214 so it is safe to call <code class="function">cogl_object_unref()</code> when it returns.
216 <div class="variablelist"><table border="0">
217 <col align="left" valign="top">
220 <td><p><span class="term"><em class="parameter"><code>pipeline</code></em> :</span></p></td>
221 <td>a Cogl pipeline state object, 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>
225 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
226 <td>the newly created <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a>.
227 Use <a class="link" href="clutter-ClutterPaintNode.html#clutter-paint-node-unref" title="clutter_paint_node_unref ()"><code class="function">clutter_paint_node_unref()</code></a> when done. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
232 <p class="since">Since 1.10</p>
235 <div class="refsect2">
236 <a name="ClutterTextNode"></a><h3>ClutterTextNode</h3>
237 <pre class="programlisting">typedef struct _ClutterTextNode ClutterTextNode;</pre>
239 The <span class="structname">ClutterTextNode</span> structure is an opaque
240 type whose members cannot be directly accessed.
242 <p class="since">Since 1.10</p>
245 <div class="refsect2">
246 <a name="ClutterTextNodeClass"></a><h3>ClutterTextNodeClass</h3>
247 <pre class="programlisting">typedef struct _ClutterTextNodeClass ClutterTextNodeClass;</pre>
249 The <span class="structname">ClutterTextNodeClass</span> structure is an opaque
250 type whose contents cannot be directly accessed.
252 <p class="since">Since 1.10</p>
255 <div class="refsect2">
256 <a name="clutter-text-node-new"></a><h3>clutter_text_node_new ()</h3>
257 <pre class="programlisting"><a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="returnvalue">ClutterPaintNode</span></a> * clutter_text_node_new (<em class="parameter"><code><a href="../pango/pango-Layout-Objects.html#PangoLayout"><span class="type">PangoLayout</span></a> *layout</code></em>,
258 <em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
260 Creates a new <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a> that will paint a <a href="../pango/pango-Layout-Objects.html#PangoLayout"><span class="type">PangoLayout</span></a>
261 with the given color.
264 This function takes a reference on the passed <em class="parameter"><code>layout</code></em>, so it
265 is safe to call <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> after it returns.
267 <div class="variablelist"><table border="0">
268 <col align="left" valign="top">
271 <td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
272 <td>a <a href="../pango/pango-Layout-Objects.html#PangoLayout"><span class="type">PangoLayout</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>
276 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
277 <td>the color used to paint the layout,
278 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>
282 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
283 <td>the newly created <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a>.
284 Use <a class="link" href="clutter-ClutterPaintNode.html#clutter-paint-node-unref" title="clutter_paint_node_unref ()"><code class="function">clutter_paint_node_unref()</code></a> when done. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
289 <p class="since">Since 1.10</p>
292 <div class="refsect2">
293 <a name="ClutterClipNode"></a><h3>ClutterClipNode</h3>
294 <pre class="programlisting">typedef struct _ClutterClipNode ClutterClipNode;</pre>
296 The <span class="structname">ClutterTextNode</span> structure is an opaque
297 type whose members cannot be directly accessed.
299 <p class="since">Since 1.10</p>
302 <div class="refsect2">
303 <a name="ClutterClipNodeClass"></a><h3>ClutterClipNodeClass</h3>
304 <pre class="programlisting">typedef struct _ClutterClipNodeClass ClutterClipNodeClass;</pre>
306 The <span class="structname">ClutterClipNodeClass</span> structure is an opaque
307 type whose members cannot be directly accessed.
309 <p class="since">Since 1.10</p>
312 <div class="refsect2">
313 <a name="clutter-clip-node-new"></a><h3>clutter_clip_node_new ()</h3>
314 <pre class="programlisting"><a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="returnvalue">ClutterPaintNode</span></a> * clutter_clip_node_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
316 Creates a new <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a> that will clip its child
317 nodes to the 2D regions added to it.
319 <div class="variablelist"><table border="0">
320 <col align="left" valign="top">
322 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
323 <td>the newly created <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a>.
324 Use <a class="link" href="clutter-ClutterPaintNode.html#clutter-paint-node-unref" title="clutter_paint_node_unref ()"><code class="function">clutter_paint_node_unref()</code></a> when done. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
328 <p class="since">Since 1.10</p>
334 Generated by GTK-Doc V1.18.1</div>