doc/reference/clutter/html/running-clutter.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>Part III. Running Clutter</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="index.html" title="Clutter Reference Manual">
   9 <link rel="prev" href="building-clutter.html" title="Part II. Building Clutter">
  10 <link rel="next" href="clutterbase.html" title="Part IV. Clutter Core Reference">
  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"><tr valign="middle">
  16 <td><a accesskey="p" href="building-clutter.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  17 <td> </td>
  18 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  19 <th width="100%" align="center">Clutter Reference Manual</th>
  20 <td><a accesskey="n" href="clutterbase.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  21 </tr></table>
  22 <div class="part">
  23 <div class="titlepage"><div>
  24 <div><h1 class="title">
  25 <a name="running-clutter"></a>Part III. Running Clutter</h1></div>
  26 <div><div class="author">
  27 <h3 class="author">
  28 <span class="firstname">Emmanuele</span> <span class="surname">Bassi</span>
  29 </h3>
  30 <div class="affiliation"><div class="address"><p><br>
  31           <code class="email">&lt;<a class="email" href="mailto:ebassilinux.intel.com">ebassi<em class="parameter"><code>linux.intel.com</code></em></a>&gt;</code><br>
  32         </p></div></div>
  33 </div></div>
  34 </div></div>
  35 <div class="partintro">
  36 <div></div>
  37 <div class="section">
  38 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
  39 <a name="environment-variables"></a>Environment Variables</h2></div></div></div>
  40 <p>
  41         Clutter automatically checks environment variables during
  42         its initialization. These environment variables are meant
  43         as debug tools, overrides for default behaviours or to
  44         address known hardware issues:
  45       </p>
  46 <div class="variablelist"><table border="0">
  47 <col align="left" valign="top">
  48 <tbody>
  49 <tr>
  50 <td><p><span class="term">CLUTTER_TEXT_DIRECTION</span></p></td>
  51 <td><p>Forces the text direction of every Pango layout
  52             inside Clutter. Valid values are: ltr or rtl</p></td>
  53 </tr>
  54 <tr>
  55 <td><p><span class="term">CLUTTER_SHOW_FPS</span></p></td>
  56 <td><p>Prints out the frames per second achieved by Clutter.</p></td>
  57 </tr>
  58 <tr>
  59 <td><p><span class="term">CLUTTER_DEFAULT_FPS</span></p></td>
  60 <td><p>Sets the default framerate.</p></td>
  61 </tr>
  62 <tr>
  63 <td><p><span class="term">CLUTTER_DISABLE_MIPMAPPED_TEXT</span></p></td>
  64 <td><p>Disables mipmapping when rendering text.</p></td>
  65 </tr>
  66 <tr>
  67 <td><p><span class="term">CLUTTER_FUZZY_PICK</span></p></td>
  68 <td><p>Enables "fuzzy picking".</p></td>
  69 </tr>
  70 <tr>
  71 <td><p><span class="term">CLUTTER_DEBUG</span></p></td>
  72 <td><p>Enables debugging modes for Clutter; debugging modes are
  73             used to print debugging messages on the console. Clutter must be
  74             compiled with the --enable-debug configuration switch for these
  75             messages to be printed out. Multiple debugging modes can be
  76             enabled by separating them using a colon (":") or a comma
  77             (",").</p></td>
  78 </tr>
  79 <tr>
  80 <td><p><span class="term">CLUTTER_PAINT</span></p></td>
  81 <td><p>Enables paint debugging modes for Clutter; the modes change
  82             the way Clutter paints a scene and are useful for debugging the
  83             behaviour of the paint cycle.</p></td>
  84 </tr>
  85 <tr>
  86 <td><p><span class="term">CLUTTER_ENABLE_DIAGNOSTIC</span></p></td>
  87 <td><p>When set to 1, enables diagnostic messages for run-time
  88             deprecations, similarly to <code class="varname">G_ENABLE_DIAGNOSTIC</code> in
  89             GLib.</p></td>
  90 </tr>
  91 </tbody>
  92 </table></div>
  93 <p>On the GLX backend there is also:</p>
  94 <div class="variablelist"><table border="0">
  95 <col align="left" valign="top">
  96 <tbody><tr>
  97 <td><p><span class="term">CLUTTER_VBLANK</span></p></td>
  98 <td><p>Selects the sync-to-vblank mode to be used.
  99             Valid values are: none, dri or glx</p></td>
 100 </tr></tbody>
 101 </table></div>
 102 </div>
 103 <div class="section">
 104 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 105 <a name="command-line"></a>Command Line Arguments</h2></div></div></div>
 106 <p>Similarly to the environment variables, Clutter also installs
 107       command line switches that are parsed during initialization:</p>
 108 <div class="variablelist"><table border="0">
 109 <col align="left" valign="top">
 110 <tbody>
 111 <tr>
 112 <td><p><span class="term">--clutter-show-fps</span></p></td>
 113 <td><p>Equivalent of CLUTTER_SHOW_FPS. Prints the
 114           current rendering speed in frames per second.</p></td>
 115 </tr>
 116 <tr>
 117 <td><p><span class="term">--clutter-default-fps=FPS</span></p></td>
 118 <td><p>Equivalent of CLUTTER_DEFAULT_FPS. Sets the
 119           default framerate.</p></td>
 120 </tr>
 121 <tr>
 122 <td><p><span class="term">--clutter-text-direction=DIRECTION</span></p></td>
 123 <td><p>Equivalent of CLUTTER_TEXT_DIRECTION. Sets the
 124           direction for the text.</p></td>
 125 </tr>
 126 <tr>
 127 <td><p><span class="term">--clutter-disable-mipmapped-text</span></p></td>
 128 <td><p>Equivalent of CLUTTER_DISABLE_MIPMAPPED_TEXT.
 129           Disables mipmapping when rendering text.</p></td>
 130 </tr>
 131 <tr>
 132 <td><p><span class="term">--clutter-use-fuzzy-picking</span></p></td>
 133 <td><p>Equivalent of CLUTTER_FUZZY_PICK. Enables
 134           "fuzzy" picking.</p></td>
 135 </tr>
 136 <tr>
 137 <td><p><span class="term">--clutter-debug=FLAGS</span></p></td>
 138 <td><p>Equivalent of CLUTTER_DEBUG. Sets FLAGS as the
 139           Clutter debugging flags.</p></td>
 140 </tr>
 141 <tr>
 142 <td><p><span class="term">--clutter-no-debug=FLAGS</span></p></td>
 143 <td><p>Unsets FLAGS from the Clutter debugging
 144           flags.</p></td>
 145 </tr>
 146 <tr>
 147 <td><p><span class="term">--cogl-debug=FLAGS</span></p></td>
 148 <td><p>Equivalent of COGL_DEBUG. Sets FLAGS as the
 149           Cogl debugging flags.</p></td>
 150 </tr>
 151 <tr>
 152 <td><p><span class="term">--cogl-no-debug=FLAGS</span></p></td>
 153 <td><p>Unsets FLAGS from the Cogl debugging
 154           flags.</p></td>
 155 </tr>
 156 <tr>
 157 <td><p><span class="term">--clutter-enable-accessibility</span></p></td>
 158 <td><p>Enables accessibility support.</p></td>
 159 </tr>
 160 </tbody>
 161 </table></div>
 162 <p>The X11 backends also have the following command line
 163       options:</p>
 164 <div class="variablelist"><table border="0">
 165 <col align="left" valign="top">
 166 <tbody>
 167 <tr>
 168 <td><p><span class="term">--display=DISPLAY</span></p></td>
 169 <td><p>Sets the X11 display to use.</p></td>
 170 </tr>
 171 <tr>
 172 <td><p><span class="term">--screen=SCREEN</span></p></td>
 173 <td><p>Sets the X11 screen number to use.</p></td>
 174 </tr>
 175 <tr>
 176 <td><p><span class="term">--synch</span></p></td>
 177 <td><p>Make X11 calls synchronous.</p></td>
 178 </tr>
 179 </tbody>
 180 </table></div>
 181 </div>
 182 <p>The GLX backend also has the following command line option:</p>
 183 <div class="variablelist"><table border="0">
 184 <col align="left" valign="top">
 185 <tbody><tr>
 186 <td><p><span class="term">--vblank=METHOD</span></p></td>
 187 <td><p>Equivalent of CLUTTER_VBLANK. Sets the sync-to-vblank
 188         method to be used.</p></td>
 189 </tr></tbody>
 190 </table></div>
 191 <div class="section">
 192 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 193 <a name="clutter-Debug-Flags"></a>Debug flags for Clutter</h2></div></div></div>
 194 <p>The debugging flags can be used for the CLUTTER_DEBUG environment
 195       variable and the --clutter-debug command line switch. Multiple flags can
 196       be separated by a colon (:) or a comma (,).</p>
 197 <div class="variablelist"><table border="0">
 198 <col align="left" valign="top">
 199 <tbody>
 200 <tr>
 201 <td><p><span class="term">actor</span></p></td>
 202 <td><p>Generic actor-related notes</p></td>
 203 </tr>
 204 <tr>
 205 <td><p><span class="term">animation</span></p></td>
 206 <td><p><a class="link" href="clutter-Implicit-Animations.html#ClutterAnimation"><span class="type">ClutterAnimation</span></a> notes</p></td>
 207 </tr>
 208 <tr>
 209 <td><p><span class="term">backend</span></p></td>
 210 <td><p>Backend-related notes, including initialization of
 211           the backend features and GL context creation</p></td>
 212 </tr>
 213 <tr>
 214 <td><p><span class="term">event</span></p></td>
 215 <td><p>Event handling notes</p></td>
 216 </tr>
 217 <tr>
 218 <td><p><span class="term">layout</span></p></td>
 219 <td><p><a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a> notes</p></td>
 220 </tr>
 221 <tr>
 222 <td><p><span class="term">misc</span></p></td>
 223 <td><p>Miscellaneous notes</p></td>
 224 </tr>
 225 <tr>
 226 <td><p><span class="term">scheduler</span></p></td>
 227 <td><p>Notes related to timelines and the master
 228           clock</p></td>
 229 </tr>
 230 <tr>
 231 <td><p><span class="term">script</span></p></td>
 232 <td><p>Notes related to <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
 233 </tr>
 234 </tbody>
 235 </table></div>
 236 <p>It is possible to get all the debugging notes using the
 237       special "all" flag.</p>
 238 </div>
 239 <div class="section">
 240 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 241 <a name="configuration-file"></a>Configuration File</h2></div></div></div>
 242 <p>Clutter will look for files named <code class="filename">settings.ini</code>
 243       located in the <code class="filename">/etc/clutter-1.0</code> and
 244       <code class="filename">$XDG_CONFIG_HOME/clutter-1.0</code> directories. These files
 245       must be valid key files (see <a href="../glib/glib-Key-value-file-parser.html#GKeyFile"><span class="type">GKeyFile</span></a> in the GLib documentation) and may
 246       have three sections:</p>
 247 <div class="variablelist"><table border="0">
 248 <col align="left" valign="top">
 249 <tbody>
 250 <tr>
 251 <td><p><span class="term">Environment</span></p></td>
 252 <td><p>The keys in this section map the environment variables
 253           honoured by Clutter.</p></td>
 254 </tr>
 255 <tr>
 256 <td><p><span class="term">Debug</span></p></td>
 257 <td><p>The keys in this section related to the debugging notes
 258           that Clutter exposes when compiled with debugging support; similarly to
 259           the environment variables and command line arguments related to the
 260           debugging notes, Clutter must be compiled with support for these notes
 261           in order to use them.</p></td>
 262 </tr>
 263 <tr>
 264 <td><p><span class="term">Settings</span></p></td>
 265 <td><p>The keys in this section strictly map to the <a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a>
 266           properties exposed by the <a class="link" href="ClutterSettings.html" title="ClutterSettings"><span class="type">ClutterSettings</span></a> type; if Clutter is running
 267           on an X11 platform, the XSettings manager will take precedence over the
 268           values specified in the <code class="filename">settings.ini</code>
 269           file.</p></td>
 270 </tr>
 271 </tbody>
 272 </table></div>
 273 <div class="section">
 274 <div class="titlepage"><div><div><h3 class="title">
 275 <a name="configuration-keys-environment"></a>Keys available for the Environment group</h3></div></div></div>
 276 <div class="variablelist"><table border="0">
 277 <col align="left" valign="top">
 278 <tbody>
 279 <tr>
 280 <td><p><span class="term">ShowFps</span></p></td>
 281 <td><p>A boolean value, equivalent to setting
 282             <code class="code">CLUTTER_SHOW_FPS</code>.</p></td>
 283 </tr>
 284 <tr>
 285 <td><p><span class="term">DisableMipmappedText</span></p></td>
 286 <td><p>A boolean value, equivalent to setting
 287             <code class="code">CLUTTER_DISABLE_MIPMAPPED_TEXT</code>.</p></td>
 288 </tr>
 289 <tr>
 290 <td><p><span class="term">UseFuzzyPicking</span></p></td>
 291 <td><p>A boolean value, equivalent to setting
 292             <code class="code">CLUTTER_FUZZY_PICK</code>.</p></td>
 293 </tr>
 294 <tr>
 295 <td><p><span class="term">EnableAccessibility</span></p></td>
 296 <td><p>A boolean value, equivalent to setting
 297             <code class="code">CLUTTER_ENABLE_ACCESSIBILITY</code>.</p></td>
 298 </tr>
 299 <tr>
 300 <td><p><span class="term">DefaultFps</span></p></td>
 301 <td><p>An integer value, equivalent to setting
 302             <code class="code">CLUTTER_DEFAULT_FPS</code>.</p></td>
 303 </tr>
 304 <tr>
 305 <td><p><span class="term">TextDirection</span></p></td>
 306 <td><p>A string value, equivalent to setting
 307             <code class="code">CLUTTER_TEXT_DIRECTION</code>.</p></td>
 308 </tr>
 309 </tbody>
 310 </table></div>
 311 </div>
 312 <div class="section">
 313 <div class="titlepage"><div><div><h3 class="title">
 314 <a name="configuration-keys-debug"></a>Keys available for the Debug group</h3></div></div></div>
 315 <div class="variablelist"><table border="0">
 316 <col align="left" valign="top">
 317 <tbody>
 318 <tr>
 319 <td><p><span class="term">Debug</span></p></td>
 320 <td><p>A string containing the debugging flags, in the same
 321             format that should be used with the <code class="code">CLUTTER_DEBUG</code>
 322             environment variable.</p></td>
 323 </tr>
 324 <tr>
 325 <td><p><span class="term">PaintDebug</span></p></td>
 326 <td><p>A string containing the paint debugging flags, in the same
 327             format that should be used with the <code class="code">CLUTTER_PAINT</code>
 328             environment variable.</p></td>
 329 </tr>
 330 <tr>
 331 <td><p><span class="term">PickDebug</span></p></td>
 332 <td><p>A string containing the pick debugging flags, in the same
 333             format that should be used with the <code class="code">CLUTTER_PICK</code>
 334             environment variable.</p></td>
 335 </tr>
 336 </tbody>
 337 </table></div>
 338 </div>
 339 </div>
 340 </div>
 341 </div>
 342 <div class="footer">
 343 <hr>
 344           Generated by GTK-Doc V1.18.1</div>
 345 </body>
 346 </html>