doc/reference/clutter/html/clutter-Paint-Nodes.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>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">
  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="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>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#clutter-Paint-Nodes.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#clutter-Paint-Nodes.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="clutter-Paint-Nodes"></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-Paint-Nodes.top_of_page"></a>Paint Nodes</span></h2>
  34 <p>Paint Nodes — ClutterPaintNode implementations</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  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>);
  43
  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>);
  50
  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>);
  54
  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><span class="type">PangoLayout</span> *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>);
  59
  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>);
  63 </pre>
  64 </div>
  65 <div class="refsect1">
  66 <a name="clutter-Paint-Nodes.description"></a><h2>Description</h2>
  67 <p>
  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.
  70 </p>
  71 </div>
  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>
  77 <p>
  78 The <span class="structname">ClutterTextNode</span> structure is an opaque
  79 type whose members cannot be directly accessed.
  80 </p>
  81 <p class="since">Since 1.10</p>
  82 </div>
  83 <hr>
  84 <div class="refsect2">
  85 <a name="ClutterColorNodeClass"></a><h3>ClutterColorNodeClass</h3>
  86 <pre class="programlisting">typedef struct _ClutterColorNodeClass ClutterColorNodeClass;</pre>
  87 </div>
  88 <hr>
  89 <div class="refsect2">
  90 <a name="clutter-color-node-new"></a><h3>clutter_color_node_new ()</h3>
  91 <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>
  92 <p>
  93 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
  94 fill using <em class="parameter"><code>color</code></em>.
  95 </p>
  96 <div class="variablelist"><table border="0">
  97 <col align="left" valign="top">
  98 <tbody>
  99 <tr>
 100 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
 101 <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>
 102 </td>
 103 </tr>
 104 <tr>
 105 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 106 <td>the newly created <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a>. Use
 107 <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>
 108 </td>
 109 </tr>
 110 </tbody>
 111 </table></div>
 112 <p class="since">Since 1.10</p>
 113 </div>
 114 <hr>
 115 <div class="refsect2">
 116 <a name="ClutterTextureNode"></a><h3>ClutterTextureNode</h3>
 117 <pre class="programlisting">typedef struct _ClutterTextureNode ClutterTextureNode;</pre>
 118 <p>
 119 The <span class="structname">ClutterTextNode</span> structure is an opaque
 120 type whose members cannot be directly accessed.
 121 </p>
 122 <p class="since">Since 1.10</p>
 123 </div>
 124 <hr>
 125 <div class="refsect2">
 126 <a name="ClutterTextureNodeClass"></a><h3>ClutterTextureNodeClass</h3>
 127 <pre class="programlisting">typedef struct _ClutterTextureNodeClass ClutterTextureNodeClass;</pre>
 128 </div>
 129 <hr>
 130 <div class="refsect2">
 131 <a name="clutter-texture-node-new"></a><h3>clutter_texture_node_new ()</h3>
 132 <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>,
 133                                                          <em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>,
 134                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html#ClutterScalingFilter" title="enum ClutterScalingFilter"><span class="type">ClutterScalingFilter</span></a> min_filter</code></em>,
 135                                                          <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>
 136 <p>
 137 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>.
 138 </p>
 139 <p>
 140 This function will take a reference on <em class="parameter"><code>texture</code></em>, so it is safe to
 141 call <code class="function">cogl_object_unref()</code> on <em class="parameter"><code>texture</code></em> when it returns.
 142 </p>
 143 <div class="variablelist"><table border="0">
 144 <col align="left" valign="top">
 145 <tbody>
 146 <tr>
 147 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
 148 <td>a <span class="type">CoglTexture</span>
 149 </td>
 150 </tr>
 151 <tr>
 152 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
 153 <td>a <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>
 154 </td>
 155 </tr>
 156 <tr>
 157 <td><p><span class="term"><em class="parameter"><code>min_filter</code></em> :</span></p></td>
 158 <td>the minification filter for the texture</td>
 159 </tr>
 160 <tr>
 161 <td><p><span class="term"><em class="parameter"><code>mag_filter</code></em> :</span></p></td>
 162 <td>the magnification filter for the texture</td>
 163 </tr>
 164 <tr>
 165 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 166 <td>the newly created <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a>.
 167 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>
 168 </td>
 169 </tr>
 170 </tbody>
 171 </table></div>
 172 <p class="since">Since 1.10</p>
 173 </div>
 174 <hr>
 175 <div class="refsect2">
 176 <a name="ClutterPipelineNode"></a><h3>ClutterPipelineNode</h3>
 177 <pre class="programlisting">typedef struct _ClutterPipelineNode ClutterPipelineNode;</pre>
 178 <p>
 179 The <span class="structname">ClutterTextNode</span> structure is an opaque
 180 type whose members cannot be directly accessed.
 181 </p>
 182 <p class="since">Since 1.10</p>
 183 </div>
 184 <hr>
 185 <div class="refsect2">
 186 <a name="ClutterPipelineNodeClass"></a><h3>ClutterPipelineNodeClass</h3>
 187 <pre class="programlisting">typedef struct _ClutterPipelineNodeClass ClutterPipelineNodeClass;</pre>
 188 </div>
 189 <hr>
 190 <div class="refsect2">
 191 <a name="clutter-pipeline-node-new"></a><h3>clutter_pipeline_node_new ()</h3>
 192 <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>
 193 <p>
 194 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
 195 paint its contents.
 196 </p>
 197 <p>
 198 This function will acquire a reference on the passed <em class="parameter"><code>pipeline</code></em>,
 199 so it is safe to call <code class="function">cogl_object_unref()</code> when it returns.
 200 </p>
 201 <div class="variablelist"><table border="0">
 202 <col align="left" valign="top">
 203 <tbody>
 204 <tr>
 205 <td><p><span class="term"><em class="parameter"><code>pipeline</code></em> :</span></p></td>
 206 <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>
 207 </td>
 208 </tr>
 209 <tr>
 210 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 211 <td>the newly created <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a>.
 212 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>
 213 </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="ClutterTextNode"></a><h3>ClutterTextNode</h3>
 222 <pre class="programlisting">typedef struct _ClutterTextNode ClutterTextNode;</pre>
 223 <p>
 224 The <span class="structname">ClutterTextNode</span> structure is an opaque
 225 type whose members cannot be directly accessed.
 226 </p>
 227 <p class="since">Since 1.10</p>
 228 </div>
 229 <hr>
 230 <div class="refsect2">
 231 <a name="ClutterTextNodeClass"></a><h3>ClutterTextNodeClass</h3>
 232 <pre class="programlisting">typedef struct _ClutterTextNodeClass ClutterTextNodeClass;</pre>
 233 </div>
 234 <hr>
 235 <div class="refsect2">
 236 <a name="clutter-text-node-new"></a><h3>clutter_text_node_new ()</h3>
 237 <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><span class="type">PangoLayout</span> *layout</code></em>,
 238                                                          <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>
 239 <p>
 240 Creates a new <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a> that will paint a <span class="type">PangoLayout</span>
 241 with the given color.
 242 </p>
 243 <p>
 244 This function takes a reference on the passed <em class="parameter"><code>layout</code></em>, so it
 245 is safe to call <code class="function">g_object_unref()</code> after it returns.
 246 </p>
 247 <div class="variablelist"><table border="0">
 248 <col align="left" valign="top">
 249 <tbody>
 250 <tr>
 251 <td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
 252 <td>a <span class="type">PangoLayout</span>, 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>
 253 </td>
 254 </tr>
 255 <tr>
 256 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
 257 <td>the color used to paint the layout,
 258 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>
 259 </td>
 260 </tr>
 261 <tr>
 262 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 263 <td>the newly created <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a>.
 264 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>
 265 </td>
 266 </tr>
 267 </tbody>
 268 </table></div>
 269 <p class="since">Since 1.10</p>
 270 </div>
 271 <hr>
 272 <div class="refsect2">
 273 <a name="ClutterClipNode"></a><h3>ClutterClipNode</h3>
 274 <pre class="programlisting">typedef struct _ClutterClipNode ClutterClipNode;</pre>
 275 <p>
 276 The <span class="structname">ClutterTextNode</span> structure is an opaque
 277 type whose members cannot be directly accessed.
 278 </p>
 279 <p class="since">Since 1.10</p>
 280 </div>
 281 <hr>
 282 <div class="refsect2">
 283 <a name="ClutterClipNodeClass"></a><h3>ClutterClipNodeClass</h3>
 284 <pre class="programlisting">typedef struct _ClutterClipNodeClass ClutterClipNodeClass;</pre>
 285 </div>
 286 <hr>
 287 <div class="refsect2">
 288 <a name="clutter-clip-node-new"></a><h3>clutter_clip_node_new ()</h3>
 289 <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>
 290 <p>
 291 Creates a new <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a> that will clip its child
 292 nodes to the 2D regions added to it.
 293 </p>
 294 <div class="variablelist"><table border="0">
 295 <col align="left" valign="top">
 296 <tbody><tr>
 297 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 298 <td>the newly created <a class="link" href="clutter-ClutterPaintNode.html#ClutterPaintNode" title="ClutterPaintNode"><span class="type">ClutterPaintNode</span></a>.
 299 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>
 300 </td>
 301 </tr></tbody>
 302 </table></div>
 303 <p class="since">Since 1.10</p>
 304 </div>
 305 </div>
 306 </div>
 307 <div class="footer">
 308 <hr>
 309           Generated by GTK-Doc V1.18.1</div>
 310 </body>
 311 </html>