doc/reference/clutter/html/ClutterBackend.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>ClutterBackend</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="clutterbackends.html" title="Part VII. Clutter Backends">
   9 <link rel="prev" href="clutterbackends.html" title="Part VII. Clutter Backends">
  10 <link rel="next" href="clutter-X11-Specific-Support.html" title="X11 Specific Support">
  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="clutterbackends.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="clutterbackends.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-X11-Specific-Support.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="#ClutterBackend.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#ClutterBackend.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#ClutterBackend.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#ClutterBackend.signals" class="shortcut">Signals</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="ClutterBackend"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="ClutterBackend.top_of_page"></a>ClutterBackend</span></h2>
  38 <p>ClutterBackend — Backend abstraction</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv">
  43 <a name="ClutterBackend.synopsis"></a><h2>Synopsis</h2>
  44 <pre class="synopsis">                    <a class="link" href="ClutterBackend.html#ClutterBackend-struct" title="ClutterBackend">ClutterBackend</a>;
  45 <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="returnvalue">ClutterBackend</span></a> *    <a class="link" href="ClutterBackend.html#clutter-get-default-backend" title="clutter_get_default_backend ()">clutter_get_default_backend</a>         (<em class="parameter"><code><span class="type">void</span></code></em>);
  46 <span class="returnvalue">void</span>                <a class="link" href="ClutterBackend.html#clutter-backend-set-resolution" title="clutter_backend_set_resolution ()">clutter_backend_set_resolution</a>      (<em class="parameter"><code><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend</code></em>,
  47                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> dpi</code></em>);
  48 <a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             <a class="link" href="ClutterBackend.html#clutter-backend-get-resolution" title="clutter_backend_get_resolution ()">clutter_backend_get_resolution</a>      (<em class="parameter"><code><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend</code></em>);
  49 <span class="returnvalue">void</span>                <a class="link" href="ClutterBackend.html#clutter-backend-set-double-click-time" title="clutter_backend_set_double_click_time ()">clutter_backend_set_double_click_time</a>
  50                                                         (<em class="parameter"><code><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend</code></em>,
  51                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> msec</code></em>);
  52 <a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="ClutterBackend.html#clutter-backend-get-double-click-time" title="clutter_backend_get_double_click_time ()">clutter_backend_get_double_click_time</a>
  53                                                         (<em class="parameter"><code><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend</code></em>);
  54 <span class="returnvalue">void</span>                <a class="link" href="ClutterBackend.html#clutter-backend-set-double-click-distance" title="clutter_backend_set_double_click_distance ()">clutter_backend_set_double_click_distance</a>
  55                                                         (<em class="parameter"><code><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend</code></em>,
  56                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> distance</code></em>);
  57 <a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="ClutterBackend.html#clutter-backend-get-double-click-distance" title="clutter_backend_get_double_click_distance ()">clutter_backend_get_double_click_distance</a>
  58                                                         (<em class="parameter"><code><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend</code></em>);
  59 <span class="returnvalue">void</span>                <a class="link" href="ClutterBackend.html#clutter-backend-set-font-options" title="clutter_backend_set_font_options ()">clutter_backend_set_font_options</a>    (<em class="parameter"><code><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend</code></em>,
  60                                                          <em class="parameter"><code>const <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/cairo/cairo-cairo-font-options-t.html#cairo-font-options-t"><span class="type">cairo_font_options_t</span></a> *options</code></em>);
  61 const <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/cairo/cairo-cairo-font-options-t.html#cairo-font-options-t"><span class="returnvalue">cairo_font_options_t</span></a> * <a class="link" href="ClutterBackend.html#clutter-backend-get-font-options" title="clutter_backend_get_font_options ()">clutter_backend_get_font_options</a>
  62                                                         (<em class="parameter"><code><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend</code></em>);
  63 <span class="returnvalue">void</span>                <a class="link" href="ClutterBackend.html#clutter-backend-set-font-name" title="clutter_backend_set_font_name ()">clutter_backend_set_font_name</a>       (<em class="parameter"><code><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend</code></em>,
  64                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *font_name</code></em>);
  65 const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="ClutterBackend.html#clutter-backend-get-font-name" title="clutter_backend_get_font_name ()">clutter_backend_get_font_name</a>       (<em class="parameter"><code><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend</code></em>);
  66 <span class="returnvalue">CoglContext</span> *       <a class="link" href="ClutterBackend.html#clutter-backend-get-cogl-context" title="clutter_backend_get_cogl_context ()">clutter_backend_get_cogl_context</a>    (<em class="parameter"><code><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend</code></em>);
  67
  68 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="ClutterBackend.html#clutter-check-windowing-backend" title="clutter_check_windowing_backend ()">clutter_check_windowing_backend</a>     (<em class="parameter"><code>const <span class="type">char</span> *backend_type</code></em>);
  69 </pre>
  70 </div>
  71 <div class="refsect1">
  72 <a name="ClutterBackend.object-hierarchy"></a><h2>Object Hierarchy</h2>
  73 <pre class="synopsis">
  74   <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  75    +----ClutterBackend
  76 </pre>
  77 </div>
  78 <div class="refsect1">
  79 <a name="ClutterBackend.signals"></a><h2>Signals</h2>
  80 <pre class="synopsis">
  81   "<a class="link" href="ClutterBackend.html#ClutterBackend-font-changed" title='The "font-changed" signal'>font-changed</a>"                                   : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
  82   "<a class="link" href="ClutterBackend.html#ClutterBackend-resolution-changed" title='The "resolution-changed" signal'>resolution-changed</a>"                             : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
  83   "<a class="link" href="ClutterBackend.html#ClutterBackend-settings-changed" title='The "settings-changed" signal'>settings-changed</a>"                               : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
  84 </pre>
  85 </div>
  86 <div class="refsect1">
  87 <a name="ClutterBackend.description"></a><h2>Description</h2>
  88 <p>
  89 Clutter can be compiled against different backends. Each backend
  90 has to implement a set of functions, in order to be used by Clutter.
  91 </p>
  92 <p>
  93 <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> is the base class abstracting the various implementation;
  94 it provides a basic API to query the backend for generic information
  95 and settings.
  96 </p>
  97 <p>
  98 <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> is available since Clutter 0.4
  99 </p>
 100 </div>
 101 <div class="refsect1">
 102 <a name="ClutterBackend.details"></a><h2>Details</h2>
 103 <div class="refsect2">
 104 <a name="ClutterBackend-struct"></a><h3>ClutterBackend</h3>
 105 <pre class="programlisting">typedef struct _ClutterBackend ClutterBackend;</pre>
 106 <p>
 107 <span class="structname">ClutterBackend</span> is an opaque structure whose
 108 members cannot be directly accessed.
 109 </p>
 110 <p class="since">Since 0.4</p>
 111 </div>
 112 <hr>
 113 <div class="refsect2">
 114 <a name="clutter-get-default-backend"></a><h3>clutter_get_default_backend ()</h3>
 115 <pre class="programlisting"><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="returnvalue">ClutterBackend</span></a> *    clutter_get_default_backend         (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 116 <p>
 117 Retrieves the default <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> used by Clutter. The
 118 <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> holds backend-specific configuration options.
 119 </p>
 120 <div class="variablelist"><table border="0">
 121 <col align="left" valign="top">
 122 <tbody><tr>
 123 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 124 <td>the default backend. You should
 125 not ref or unref the returned object. Applications should rarely
 126 need to use this. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 127 </td>
 128 </tr></tbody>
 129 </table></div>
 130 <p class="since">Since 0.4</p>
 131 </div>
 132 <hr>
 133 <div class="refsect2">
 134 <a name="clutter-backend-set-resolution"></a><h3>clutter_backend_set_resolution ()</h3>
 135 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_backend_set_resolution      (<em class="parameter"><code><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend</code></em>,
 136                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> dpi</code></em>);</pre>
 137 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 138 <h3 class="title">Warning</h3>
 139 <p><code class="literal">clutter_backend_set_resolution</code> has been deprecated since version 1.4 and should not be used in newly-written code. Use <a class="link" href="ClutterSettings.html#ClutterSettings--font-dpi" title='The "font-dpi" property'><span class="type">"font-dpi"</span></a> instead</p>
 140 </div>
 141 <p>
 142 Sets the resolution for font handling on the screen. This is a
 143 scale factor between points specified in a <a href="../pango/pango-Fonts.html#PangoFontDescription"><span class="type">PangoFontDescription</span></a>
 144 and cairo units. The default value is 96, meaning that a 10 point
 145 font will be 13 units high. (10 * 96. / 72. = 13.3).
 146 </p>
 147 <p>
 148 Applications should never need to call this function.
 149 </p>
 150 <div class="variablelist"><table border="0">
 151 <col align="left" valign="top">
 152 <tbody>
 153 <tr>
 154 <td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
 155 <td>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a>
 156 </td>
 157 </tr>
 158 <tr>
 159 <td><p><span class="term"><em class="parameter"><code>dpi</code></em> :</span></p></td>
 160 <td>the resolution in "dots per inch" (Physical inches aren't
 161 actually involved; the terminology is conventional).</td>
 162 </tr>
 163 </tbody>
 164 </table></div>
 165 <p class="since">Since 0.4</p>
 166 </div>
 167 <hr>
 168 <div class="refsect2">
 169 <a name="clutter-backend-get-resolution"></a><h3>clutter_backend_get_resolution ()</h3>
 170 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             clutter_backend_get_resolution      (<em class="parameter"><code><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend</code></em>);</pre>
 171 <p>
 172 Gets the resolution for font handling on the screen.
 173 </p>
 174 <p>
 175 The resolution is a scale factor between points specified in a
 176 <a href="../pango/pango-Fonts.html#PangoFontDescription"><span class="type">PangoFontDescription</span></a> and cairo units. The default value is 96.0,
 177 meaning that a 10 point font will be 13 units
 178 high (10 * 96. / 72. = 13.3).
 179 </p>
 180 <p>
 181 Clutter will set the resolution using the current backend when
 182 initializing; the resolution is also stored in the
 183 <a class="link" href="ClutterSettings.html#ClutterSettings--font-dpi" title='The "font-dpi" property'><span class="type">"font-dpi"</span></a> property.
 184 </p>
 185 <div class="variablelist"><table border="0">
 186 <col align="left" valign="top">
 187 <tbody>
 188 <tr>
 189 <td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
 190 <td>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a>
 191 </td>
 192 </tr>
 193 <tr>
 194 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 195 <td>the current resolution, or -1 if no resolution
 196 has been set.</td>
 197 </tr>
 198 </tbody>
 199 </table></div>
 200 <p class="since">Since 0.4</p>
 201 </div>
 202 <hr>
 203 <div class="refsect2">
 204 <a name="clutter-backend-set-double-click-time"></a><h3>clutter_backend_set_double_click_time ()</h3>
 205 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_backend_set_double_click_time
 206                                                         (<em class="parameter"><code><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend</code></em>,
 207                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> msec</code></em>);</pre>
 208 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 209 <h3 class="title">Warning</h3>
 210 <p><code class="literal">clutter_backend_set_double_click_time</code> has been deprecated since version 1.4 and should not be used in newly-written code. Use <a class="link" href="ClutterSettings.html#ClutterSettings--double-click-time" title='The "double-click-time" property'><span class="type">"double-click-time"</span></a> instead</p>
 211 </div>
 212 <p>
 213 Sets the maximum time between two button press events, used to
 214 verify whether it's a double click event or not.
 215 </p>
 216 <div class="variablelist"><table border="0">
 217 <col align="left" valign="top">
 218 <tbody>
 219 <tr>
 220 <td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
 221 <td>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a>
 222 </td>
 223 </tr>
 224 <tr>
 225 <td><p><span class="term"><em class="parameter"><code>msec</code></em> :</span></p></td>
 226 <td>milliseconds between two button press events</td>
 227 </tr>
 228 </tbody>
 229 </table></div>
 230 <p class="since">Since 0.4</p>
 231 </div>
 232 <hr>
 233 <div class="refsect2">
 234 <a name="clutter-backend-get-double-click-time"></a><h3>clutter_backend_get_double_click_time ()</h3>
 235 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               clutter_backend_get_double_click_time
 236                                                         (<em class="parameter"><code><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend</code></em>);</pre>
 237 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 238 <h3 class="title">Warning</h3>
 239 <p><code class="literal">clutter_backend_get_double_click_time</code> has been deprecated since version 1.4 and should not be used in newly-written code. Use <a class="link" href="ClutterSettings.html#ClutterSettings--double-click-time" title='The "double-click-time" property'><span class="type">"double-click-time"</span></a> instead</p>
 240 </div>
 241 <p>
 242 Gets the maximum time between two button press events, as set
 243 by <a class="link" href="ClutterBackend.html#clutter-backend-set-double-click-time" title="clutter_backend_set_double_click_time ()"><code class="function">clutter_backend_set_double_click_time()</code></a>.
 244 </p>
 245 <div class="variablelist"><table border="0">
 246 <col align="left" valign="top">
 247 <tbody>
 248 <tr>
 249 <td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
 250 <td>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a>
 251 </td>
 252 </tr>
 253 <tr>
 254 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 255 <td>a time in milliseconds</td>
 256 </tr>
 257 </tbody>
 258 </table></div>
 259 <p class="since">Since 0.4</p>
 260 </div>
 261 <hr>
 262 <div class="refsect2">
 263 <a name="clutter-backend-set-double-click-distance"></a><h3>clutter_backend_set_double_click_distance ()</h3>
 264 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_backend_set_double_click_distance
 265                                                         (<em class="parameter"><code><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend</code></em>,
 266                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> distance</code></em>);</pre>
 267 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 268 <h3 class="title">Warning</h3>
 269 <p><code class="literal">clutter_backend_set_double_click_distance</code> has been deprecated since version 1.4 and should not be used in newly-written code. Use <a class="link" href="ClutterSettings.html#ClutterSettings--double-click-distance" title='The "double-click-distance" property'><span class="type">"double-click-distance"</span></a> instead</p>
 270 </div>
 271 <p>
 272 Sets the maximum distance used to verify a double click event.
 273 </p>
 274 <div class="variablelist"><table border="0">
 275 <col align="left" valign="top">
 276 <tbody>
 277 <tr>
 278 <td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
 279 <td>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a>
 280 </td>
 281 </tr>
 282 <tr>
 283 <td><p><span class="term"><em class="parameter"><code>distance</code></em> :</span></p></td>
 284 <td>a distance, in pixels</td>
 285 </tr>
 286 </tbody>
 287 </table></div>
 288 <p class="since">Since 0.4</p>
 289 </div>
 290 <hr>
 291 <div class="refsect2">
 292 <a name="clutter-backend-get-double-click-distance"></a><h3>clutter_backend_get_double_click_distance ()</h3>
 293 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               clutter_backend_get_double_click_distance
 294                                                         (<em class="parameter"><code><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend</code></em>);</pre>
 295 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 296 <h3 class="title">Warning</h3>
 297 <p><code class="literal">clutter_backend_get_double_click_distance</code> has been deprecated since version 1.4 and should not be used in newly-written code. Use <a class="link" href="ClutterSettings.html#ClutterSettings--double-click-distance" title='The "double-click-distance" property'><span class="type">"double-click-distance"</span></a> instead</p>
 298 </div>
 299 <p>
 300 Retrieves the distance used to verify a double click event
 301 </p>
 302 <div class="variablelist"><table border="0">
 303 <col align="left" valign="top">
 304 <tbody>
 305 <tr>
 306 <td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
 307 <td>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a>
 308 </td>
 309 </tr>
 310 <tr>
 311 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 312 <td>a distance, in pixels.</td>
 313 </tr>
 314 </tbody>
 315 </table></div>
 316 <p class="since">Since 0.4</p>
 317 </div>
 318 <hr>
 319 <div class="refsect2">
 320 <a name="clutter-backend-set-font-options"></a><h3>clutter_backend_set_font_options ()</h3>
 321 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_backend_set_font_options    (<em class="parameter"><code><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend</code></em>,
 322                                                          <em class="parameter"><code>const <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/cairo/cairo-cairo-font-options-t.html#cairo-font-options-t"><span class="type">cairo_font_options_t</span></a> *options</code></em>);</pre>
 323 <p>
 324 Sets the new font options for <em class="parameter"><code>backend</code></em>. The <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> will
 325 copy the <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/cairo/cairo-cairo-font-options-t.html#cairo-font-options-t"><span class="type">cairo_font_options_t</span></a>.
 326 </p>
 327 <p>
 328 If <em class="parameter"><code>options</code></em> is <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>, the first following call to
 329 <a class="link" href="ClutterBackend.html#clutter-backend-get-font-options" title="clutter_backend_get_font_options ()"><code class="function">clutter_backend_get_font_options()</code></a> will return the default font
 330 options for <em class="parameter"><code>backend</code></em>.
 331 </p>
 332 <p>
 333 This function is intended for actors creating a Pango layout
 334 using the PangoCairo API.
 335 </p>
 336 <div class="variablelist"><table border="0">
 337 <col align="left" valign="top">
 338 <tbody>
 339 <tr>
 340 <td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
 341 <td>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a>
 342 </td>
 343 </tr>
 344 <tr>
 345 <td><p><span class="term"><em class="parameter"><code>options</code></em> :</span></p></td>
 346 <td>Cairo font options for the backend, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
 347 </td>
 348 </tr>
 349 </tbody>
 350 </table></div>
 351 <p class="since">Since 0.8</p>
 352 </div>
 353 <hr>
 354 <div class="refsect2">
 355 <a name="clutter-backend-get-font-options"></a><h3>clutter_backend_get_font_options ()</h3>
 356 <pre class="programlisting">const <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/cairo/cairo-cairo-font-options-t.html#cairo-font-options-t"><span class="returnvalue">cairo_font_options_t</span></a> * clutter_backend_get_font_options
 357                                                         (<em class="parameter"><code><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend</code></em>);</pre>
 358 <p>
 359 Retrieves the font options for <em class="parameter"><code>backend</code></em>.
 360 </p>
 361 <div class="variablelist"><table border="0">
 362 <col align="left" valign="top">
 363 <tbody>
 364 <tr>
 365 <td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
 366 <td>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a>
 367 </td>
 368 </tr>
 369 <tr>
 370 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 371 <td>the font options of the <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a>.
 372 The returned <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/cairo/cairo-cairo-font-options-t.html#cairo-font-options-t"><span class="type">cairo_font_options_t</span></a> is owned by the backend and should
 373 not be modified or freed. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 374 </td>
 375 </tr>
 376 </tbody>
 377 </table></div>
 378 <p class="since">Since 0.8</p>
 379 </div>
 380 <hr>
 381 <div class="refsect2">
 382 <a name="clutter-backend-set-font-name"></a><h3>clutter_backend_set_font_name ()</h3>
 383 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_backend_set_font_name       (<em class="parameter"><code><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend</code></em>,
 384                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *font_name</code></em>);</pre>
 385 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 386 <h3 class="title">Warning</h3>
 387 <p><code class="literal">clutter_backend_set_font_name</code> has been deprecated since version 1.4 and should not be used in newly-written code. Use <a class="link" href="ClutterSettings.html#ClutterSettings--font-name" title='The "font-name" property'><span class="type">"font-name"</span></a> instead</p>
 388 </div>
 389 <p>
 390 Sets the default font to be used by Clutter. The <em class="parameter"><code>font_name</code></em> string
 391 must either be <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>, which means that the font name from the
 392 default <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> will be used; or be something that can
 393 be parsed by the <a href="../pango/pango-Fonts.html#pango-font-description-from-string"><code class="function">pango_font_description_from_string()</code></a> function.
 394 </p>
 395 <div class="variablelist"><table border="0">
 396 <col align="left" valign="top">
 397 <tbody>
 398 <tr>
 399 <td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
 400 <td>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a>
 401 </td>
 402 </tr>
 403 <tr>
 404 <td><p><span class="term"><em class="parameter"><code>font_name</code></em> :</span></p></td>
 405 <td>the name of the font</td>
 406 </tr>
 407 </tbody>
 408 </table></div>
 409 <p class="since">Since 1.0</p>
 410 </div>
 411 <hr>
 412 <div class="refsect2">
 413 <a name="clutter-backend-get-font-name"></a><h3>clutter_backend_get_font_name ()</h3>
 414 <pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       clutter_backend_get_font_name       (<em class="parameter"><code><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend</code></em>);</pre>
 415 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 416 <h3 class="title">Warning</h3>
 417 <p><code class="literal">clutter_backend_get_font_name</code> has been deprecated since version 1.4 and should not be used in newly-written code. Use <a class="link" href="ClutterSettings.html#ClutterSettings--font-name" title='The "font-name" property'><span class="type">"font-name"</span></a> instead</p>
 418 </div>
 419 <p>
 420 Retrieves the default font name as set by
 421 <a class="link" href="ClutterBackend.html#clutter-backend-set-font-name" title="clutter_backend_set_font_name ()"><code class="function">clutter_backend_set_font_name()</code></a>.
 422 </p>
 423 <div class="variablelist"><table border="0">
 424 <col align="left" valign="top">
 425 <tbody>
 426 <tr>
 427 <td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
 428 <td>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a>
 429 </td>
 430 </tr>
 431 <tr>
 432 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 433 <td>the font name for the backend. The returned string is
 434 owned by the <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> and should never be modified or freed</td>
 435 </tr>
 436 </tbody>
 437 </table></div>
 438 <p class="since">Since 1.0</p>
 439 </div>
 440 <hr>
 441 <div class="refsect2">
 442 <a name="clutter-backend-get-cogl-context"></a><h3>clutter_backend_get_cogl_context ()</h3>
 443 <pre class="programlisting"><span class="returnvalue">CoglContext</span> *       clutter_backend_get_cogl_context    (<em class="parameter"><code><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend</code></em>);</pre>
 444 <p>
 445 Retrieves the <span class="type">CoglContext</span> associated with the given clutter
 446 <em class="parameter"><code>backend</code></em>. A <span class="type">CoglContext</span> is required when using some of the
 447 experimental 2.0 Cogl API.
 448 </p>
 449 <p>
 450 </p>
 451 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
 452 <h3 class="title">Note</h3>Since CoglContext is itself experimental API this API should
 453 be considered experimental too.</div>
 454 <p>
 455 </p>
 456 <p>
 457 </p>
 458 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
 459 <h3 class="title">Note</h3>This API is not yet supported on OSX because OSX still
 460 uses the stub Cogl winsys and the Clutter backend doesn't
 461 explicitly create a CoglContext.</div>
 462 <p>
 463 </p>
 464 <div class="variablelist"><table border="0">
 465 <col align="left" valign="top">
 466 <tbody>
 467 <tr>
 468 <td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
 469 <td>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a>
 470 </td>
 471 </tr>
 472 <tr>
 473 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 474 <td>The <span class="type">CoglContext</span> associated with <em class="parameter"><code>backend</code></em>.</td>
 475 </tr>
 476 </tbody>
 477 </table></div>
 478 <p class="since">Since 1.8</p>
 479 <p class="stability">Stability Level: Unstable</p>
 480 </div>
 481 <hr>
 482 <div class="refsect2">
 483 <a name="clutter-check-windowing-backend"></a><h3>clutter_check_windowing_backend ()</h3>
 484 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            clutter_check_windowing_backend     (<em class="parameter"><code>const <span class="type">char</span> *backend_type</code></em>);</pre>
 485 <p>
 486 Checks the run-time name of the Clutter windowing system backend, using
 487 the symbolic macros like <code class="literal">CLUTTER_WINDOWING_WIN32</code> or
 488 <code class="literal">CLUTTER_WINDOWING_X11</code>.
 489 </p>
 490 <p>
 491 This function should be used in conjuction with the compile-time macros
 492 inside applications and libraries that are using the platform-specific
 493 windowing system API, to ensure that they are running on the correct
 494 windowing system; for instance:
 495 </p>
 496 <p>
 497 </p>
 498 <div class="informalexample">
 499   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 500     <tbody>
 501       <tr>
 502         <td class="listing_lines" align="right"><pre>1
 503 2
 504 3
 505 4
 506 5
 507 6
 508 7
 509 8
 510 9
 511 10
 512 11
 513 12
 514 13
 515 14
 516 15</pre></td>
 517         <td class="listing_code"><pre class="programlisting"><span class="preproc">#ifdef</span><span class="normal"> CLUTTER_WINDOWING_X11</span>
 518 <span class="normal">  </span><span class="keyword">if</span><span class="normal"> </span><span class="symbol">(</span><span class="function"><a href="ClutterBackend.html#clutter-check-windowing-backend">clutter_check_windowing_backend</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">CLUTTER_WINDOWING_X11</span><span class="symbol">))</span>
 519 <span class="normal">    </span><span class="cbracket">{</span>
 520 <span class="normal">      </span><span class="comment">/* it is safe to use the clutter_x11_* API */</span>
 521 <span class="normal">    </span><span class="cbracket">}</span>
 522 <span class="normal">  </span><span class="keyword">else</span>
 523 <span class="preproc">#endif</span>
 524 <span class="preproc">#ifdef</span><span class="normal"> CLUTTER_WINDOWING_WIN32</span>
 525 <span class="normal">  </span><span class="keyword">if</span><span class="normal"> </span><span class="symbol">(</span><span class="function"><a href="ClutterBackend.html#clutter-check-windowing-backend">clutter_check_windowing_backend</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">CLUTTER_WINDOWING_WIN32</span><span class="symbol">))</span>
 526 <span class="normal">    </span><span class="cbracket">{</span>
 527 <span class="normal">      </span><span class="comment">/* it is safe to use the clutter_win32_* API */</span>
 528 <span class="normal">    </span><span class="cbracket">}</span>
 529 <span class="normal">  </span><span class="keyword">else</span>
 530 <span class="preproc">#endif</span>
 531 <span class="normal">    </span><span class="function"><a href="../glib/glib-Message-Logging.html#g-error">g_error</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"Unknown Clutter backend."</span><span class="symbol">);</span></pre></td>
 532       </tr>
 533     </tbody>
 534   </table>
 535 </div>
 536
 537 <p>
 538 </p>
 539 <div class="variablelist"><table border="0">
 540 <col align="left" valign="top">
 541 <tbody>
 542 <tr>
 543 <td><p><span class="term"><em class="parameter"><code>backend_type</code></em> :</span></p></td>
 544 <td>the name of the backend to check</td>
 545 </tr>
 546 <tr>
 547 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 548 <td>
 549 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the current Clutter windowing system backend is
 550 the one checked, and <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td>
 551 </tr>
 552 </tbody>
 553 </table></div>
 554 <p class="since">Since 1.10</p>
 555 </div>
 556 </div>
 557 <div class="refsect1">
 558 <a name="ClutterBackend.signal-details"></a><h2>Signal Details</h2>
 559 <div class="refsect2">
 560 <a name="ClutterBackend-font-changed"></a><h3>The <code class="literal">"font-changed"</code> signal</h3>
 561 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend,
 562                                                         <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>        user_data)      : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
 563 <p>
 564 The ::font-changed signal is emitted each time the font options
 565 have been changed through <a class="link" href="ClutterSettings.html" title="ClutterSettings"><span class="type">ClutterSettings</span></a>.
 566 </p>
 567 <div class="variablelist"><table border="0">
 568 <col align="left" valign="top">
 569 <tbody>
 570 <tr>
 571 <td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
 572 <td>the <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> that emitted the signal</td>
 573 </tr>
 574 <tr>
 575 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 576 <td>user data set when the signal handler was connected.</td>
 577 </tr>
 578 </tbody>
 579 </table></div>
 580 <p class="since">Since 1.0</p>
 581 </div>
 582 <hr>
 583 <div class="refsect2">
 584 <a name="ClutterBackend-resolution-changed"></a><h3>The <code class="literal">"resolution-changed"</code> signal</h3>
 585 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend,
 586                                                         <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>        user_data)      : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
 587 <p>
 588 The ::resolution-changed signal is emitted each time the font
 589 resolutions has been changed through <a class="link" href="ClutterSettings.html" title="ClutterSettings"><span class="type">ClutterSettings</span></a>.
 590 </p>
 591 <div class="variablelist"><table border="0">
 592 <col align="left" valign="top">
 593 <tbody>
 594 <tr>
 595 <td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
 596 <td>the <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> that emitted the signal</td>
 597 </tr>
 598 <tr>
 599 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 600 <td>user data set when the signal handler was connected.</td>
 601 </tr>
 602 </tbody>
 603 </table></div>
 604 <p class="since">Since 1.0</p>
 605 </div>
 606 <hr>
 607 <div class="refsect2">
 608 <a name="ClutterBackend-settings-changed"></a><h3>The <code class="literal">"settings-changed"</code> signal</h3>
 609 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend,
 610                                                         <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>        user_data)      : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
 611 <p>
 612 The ::settings-changed signal is emitted each time the <a class="link" href="ClutterSettings.html" title="ClutterSettings"><span class="type">ClutterSettings</span></a>
 613 properties have been changed.
 614 </p>
 615 <div class="variablelist"><table border="0">
 616 <col align="left" valign="top">
 617 <tbody>
 618 <tr>
 619 <td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
 620 <td>the <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> that emitted the signal</td>
 621 </tr>
 622 <tr>
 623 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 624 <td>user data set when the signal handler was connected.</td>
 625 </tr>
 626 </tbody>
 627 </table></div>
 628 <p class="since">Since 1.4</p>
 629 </div>
 630 </div>
 631 </div>
 632 <div class="footer">
 633 <hr>
 634           Generated by GTK-Doc V1.18.1</div>
 635 </body>
 636 </html>