doc/reference/cogl/html/cogl-Materials-(Deprecated).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>Materials (Deprecated)</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="Cogl Reference Manual">
   8 <link rel="up" href="ch03.html" title="Cogl deprecated API">
   9 <link rel="prev" href="cogl-Textures-(Deprecated).html" title="Textures (Deprecated)">
  10 <link rel="next" href="cogl-Clipping-(Deprecated).html" title="Clipping (Deprecated)">
  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="cogl-Textures-(Deprecated).html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch03.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">Cogl Reference Manual</th>
  21 <td><a accesskey="n" href="cogl-Clipping-(Deprecated).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="#cogl-Materials-(Deprecated).synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#cogl-Materials-(Deprecated).description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="cogl-Materials-(Deprecated)"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="cogl-Materials-(Deprecated).top_of_page"></a>Materials (Deprecated)</span></h2>
  34 <p>Materials (Deprecated)</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="cogl-Materials-(Deprecated).synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis"><a class="link" href="cogl-General-API.html#CoglHandle" title="CoglHandle"><span class="returnvalue">CoglHandle</span></a>          <a class="link" href="cogl-Materials-(Deprecated).html#cogl-material-ref" title="cogl_material_ref ()">cogl_material_ref</a>                   (<em class="parameter"><code><a class="link" href="cogl-General-API.html#CoglHandle" title="CoglHandle"><span class="type">CoglHandle</span></a> material</code></em>);
  41 <span class="returnvalue">void</span>                <a class="link" href="cogl-Materials-(Deprecated).html#cogl-material-unref" title="cogl_material_unref ()">cogl_material_unref</a>                 (<em class="parameter"><code><a class="link" href="cogl-General-API.html#CoglHandle" title="CoglHandle"><span class="type">CoglHandle</span></a> material</code></em>);
  42 const <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *       <a class="link" href="cogl-Materials-(Deprecated).html#cogl-material-get-layers" title="cogl_material_get_layers ()">cogl_material_get_layers</a>            (<em class="parameter"><code><a class="link" href="cogl-Materials.html#CoglMaterial" title="CoglMaterial"><span class="type">CoglMaterial</span></a> *material</code></em>);
  43 </pre>
  44 </div>
  45 <div class="refsect1">
  46 <a name="cogl-Materials-(Deprecated).description"></a><h2>Description</h2>
  47 </div>
  48 <div class="refsect1">
  49 <a name="cogl-Materials-(Deprecated).details"></a><h2>Details</h2>
  50 <div class="refsect2">
  51 <a name="cogl-material-ref"></a><h3>cogl_material_ref ()</h3>
  52 <pre class="programlisting"><a class="link" href="cogl-General-API.html#CoglHandle" title="CoglHandle"><span class="returnvalue">CoglHandle</span></a>          cogl_material_ref                   (<em class="parameter"><code><a class="link" href="cogl-General-API.html#CoglHandle" title="CoglHandle"><span class="type">CoglHandle</span></a> material</code></em>);</pre>
  53 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
  54 <h3 class="title">Warning</h3>
  55 <p><code class="literal">cogl_material_ref</code> has been deprecated since version 1.2 and should not be used in newly-written code. Use <a class="link" href="cogl-General-API.html#cogl-object-ref" title="cogl_object_ref ()"><code class="function">cogl_object_ref()</code></a> instead</p>
  56 </div>
  57 <p>
  58 Increment the reference count for a <a class="link" href="cogl-Materials.html#CoglMaterial" title="CoglMaterial"><span class="type">CoglMaterial</span></a>.
  59 </p>
  60 <div class="variablelist"><table border="0">
  61 <col align="left" valign="top">
  62 <tbody>
  63 <tr>
  64 <td><p><span class="term"><em class="parameter"><code>material</code></em> :</span></p></td>
  65 <td>a <a class="link" href="cogl-Materials.html#CoglMaterial" title="CoglMaterial"><span class="type">CoglMaterial</span></a> object.</td>
  66 </tr>
  67 <tr>
  68 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  69 <td>the <em class="parameter"><code>material</code></em>.</td>
  70 </tr>
  71 </tbody>
  72 </table></div>
  73 <p class="since">Since 1.0</p>
  74 </div>
  75 <hr>
  76 <div class="refsect2">
  77 <a name="cogl-material-unref"></a><h3>cogl_material_unref ()</h3>
  78 <pre class="programlisting"><span class="returnvalue">void</span>                cogl_material_unref                 (<em class="parameter"><code><a class="link" href="cogl-General-API.html#CoglHandle" title="CoglHandle"><span class="type">CoglHandle</span></a> material</code></em>);</pre>
  79 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
  80 <h3 class="title">Warning</h3>
  81 <p><code class="literal">cogl_material_unref</code> has been deprecated since version 1.2 and should not be used in newly-written code. Use <a class="link" href="cogl-General-API.html#cogl-object-unref" title="cogl_object_unref ()"><code class="function">cogl_object_unref()</code></a> instead</p>
  82 </div>
  83 <p>
  84 Decrement the reference count for a <a class="link" href="cogl-Materials.html#CoglMaterial" title="CoglMaterial"><span class="type">CoglMaterial</span></a>.
  85 </p>
  86 <div class="variablelist"><table border="0">
  87 <col align="left" valign="top">
  88 <tbody><tr>
  89 <td><p><span class="term"><em class="parameter"><code>material</code></em> :</span></p></td>
  90 <td>a <a class="link" href="cogl-Materials.html#CoglMaterial" title="CoglMaterial"><span class="type">CoglMaterial</span></a> object.</td>
  91 </tr></tbody>
  92 </table></div>
  93 <p class="since">Since 1.0</p>
  94 </div>
  95 <hr>
  96 <div class="refsect2">
  97 <a name="cogl-material-get-layers"></a><h3>cogl_material_get_layers ()</h3>
  98 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *       cogl_material_get_layers            (<em class="parameter"><code><a class="link" href="cogl-Materials.html#CoglMaterial" title="CoglMaterial"><span class="type">CoglMaterial</span></a> *material</code></em>);</pre>
  99 <p>
 100 This function lets you access a material's internal list of layers
 101 for iteration.
 102 </p>
 103 <p>
 104 </p>
 105 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
 106 <h3 class="title">Note</h3>You should avoid using this API if possible since it was only
 107 made public by mistake and will be deprecated when we have
 108 suitable alternative.</div>
 109 <p>
 110 </p>
 111 <p>
 112 </p>
 113 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
 114 <h3 class="title">Note</h3>It's important to understand that the list returned may not
 115 remain valid if you modify the material or any of the layers in any
 116 way and so you would have to re-get the list in that
 117 situation.</div>
 118 <p>
 119 </p>
 120 <div class="variablelist"><table border="0">
 121 <col align="left" valign="top">
 122 <tbody>
 123 <tr>
 124 <td><p><span class="term"><em class="parameter"><code>material</code></em> :</span></p></td>
 125 <td>A <a class="link" href="cogl-Materials.html#CoglMaterial" title="CoglMaterial"><span class="type">CoglMaterial</span></a> object</td>
 126 </tr>
 127 <tr>
 128 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 129 <td>A
 130 list of <a class="link" href="cogl-Materials.html#CoglMaterialLayer" title="CoglMaterialLayer"><span class="type">CoglMaterialLayer</span></a>'s that can be passed to the
 131 cogl_material_layer_* functions. The list is owned by Cogl and it
 132 should not be modified or freed. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> CoglMaterialLayer][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 133 </td>
 134 </tr>
 135 </tbody>
 136 </table></div>
 137 </div>
 138 </div>
 139 </div>
 140 <div class="footer">
 141 <hr>
 142           Generated by GTK-Doc V1.18.1</div>
 143 </body>
 144 </html>