← Back to branch summary

~oem-solutions-group/unity-2d/clutter-1.0

« back to all changes in this revision

Viewing changes to doc/reference/clutter/xml/running-clutter.xml

  • Committer: Bazaar Package Importer
  • Author(s): Emilio Pozuelo Monfort
  • Date: 2010-03-21 13:27:56 UTC
  • mto: (2.1.3 experimental)
  • mto: This revision was merged to the branch mainline in revision 8.
  • Revision ID: james.westby@ubuntu.com-20100321132756-nf8yd30yxo3zzwcm
Tags: upstream-1.2.2
Import upstream version 1.2.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/clutter/xml/running-clutter.xml
1
 
<part id="running-clutter">
2
 
  <partinfo>
3
 
    <author>
4
 
      <firstname>Emmanuele</firstname>
5
 
      <surname>Bassi</surname>
6
 
      <affiliation>
7
 
        <address>
8
 
          <email>ebassi<parameter>linux.intel.com</parameter></email>
9
 
        </address>
10
 
      </affiliation>
11
 
    </author>
12
 
  </partinfo>
13
 
 
14
 
  <title>Running Clutter</title>
15
 
 
16
 
  <partintro>
17
 
 
18
 
    <section id="environment-variables">
19
 
      <title>Environment Variables</title>
20
 
 
21
 
      <para>
22
 
        Clutter automatically checks environment variables during
23
 
        its initialization. These environment variables are meant
24
 
        as debug tools, overrides for default behaviours or to
25
 
        address known hardware issues:
26
 
      </para>
27
 
 
28
 
      <variablelist>
29
 
        <varlistentry>
30
 
          <term>CLUTTER_TEXT_DIRECTION</term>
31
 
          <listitem>
32
 
            <para>Forces the text direction of every Pango layout
33
 
            inside Clutter. Valid values are: ltr or rtl</para>
34
 
          </listitem>
35
 
        </varlistentry>
36
 
        <varlistentry>
37
 
          <term>CLUTTER_SHOW_FPS</term>
38
 
          <listitem>
39
 
            <para>Prints out the frames per second achieved by Clutter.</para>
40
 
          </listitem>
41
 
        </varlistentry>
42
 
        <varlistentry>
43
 
          <term>CLUTTER_DEFAULT_FPS</term>
44
 
          <listitem>
45
 
            <para>Sets the default framerate.</para>
46
 
          </listitem>
47
 
        </varlistentry>
48
 
        <varlistentry>
49
 
          <term>CLUTTER_DISABLE_MIPMAPPED_TEXT</term>
50
 
          <listitem>
51
 
            <para>Disables mipmapping when rendering text.</para>
52
 
          </listitem>
53
 
        </varlistentry>
54
 
        <varlistentry>
55
 
          <term>CLUTTER_FUZZY_PICK</term>
56
 
          <listitem>
57
 
            <para>Enables "fuzzy picking".</para>
58
 
          </listitem>
59
 
        </varlistentry>
60
 
        <varlistentry>
61
 
          <term>CLUTTER_DEBUG</term>
62
 
          <listitem>
63
 
            <para>Enables debugging modes for Clutter.</para>
64
 
          </listitem>
65
 
        </varlistentry>
66
 
        <varlistentry>
67
 
          <term>COGL_DEBUG</term>
68
 
          <listitem>
69
 
            <para>Enables debugging modes for COGL.</para>
70
 
          </listitem>
71
 
        </varlistentry>
72
 
      </variablelist>
73
 
 
74
 
      <para>On the GLX backend there is also:</para>
75
 
 
76
 
      <variablelist>
77
 
        <varlistentry>
78
 
          <term>CLUTTER_VBLANK</term>
79
 
          <listitem>
80
 
            <para>Selects the sync-to-vblank mode to be used.
81
 
            Valid values are: none, dri or glx</para>
82
 
          </listitem>
83
 
        </varlistentry>
84
 
      </variablelist>
85
 
 
86
 
    </section>
87
 
 
88
 
    <section id="command-line">
89
 
      <title>Command Line Arguments</title>
90
 
 
91
 
      <para>Similarly to the environment variables, Clutter also installs
92
 
      command line switches that are parsed during initialization:</para>
93
 
 
94
 
      <variablelist>
95
 
        <varlistentry>
96
 
          <term>--clutter-show-fps</term>
97
 
          <listitem><para>Equivalent of CLUTTER_SHOW_FPS. Prints the
98
 
          current rendering speed in frames per second.</para></listitem>
99
 
        </varlistentry>
100
 
        <varlistentry>
101
 
          <term>--clutter-default-fps=FPS</term>
102
 
          <listitem><para>Equivalent of CLUTTER_DEFAULT_FPS. Sets the
103
 
          default framerate.</para></listitem>
104
 
        </varlistentry>
105
 
        <varlistentry>
106
 
          <term>--clutter-text-direction=DIRECTION</term>
107
 
          <listitem><para>Equivalent of CLUTTER_TEXT_DIRECTION. Sets the
108
 
          direction for the text.</para></listitem>
109
 
        </varlistentry>
110
 
        <varlistentry>
111
 
          <term>--clutter-disable-mipmapped-text</term>
112
 
          <listitem><para>Equivalent of CLUTTER_DISABLE_MIPMAPPED_TEXT.
113
 
          Disables mipmapping when rendering text.</para></listitem>
114
 
        </varlistentry>
115
 
        <varlistentry>
116
 
          <term>--clutter-use-fuzzy-picking</term>
117
 
          <listitem><para>Equivalent of CLUTTER_FUZZY_PICK. Enables
118
 
          "fuzzy" picking.</para></listitem>
119
 
        </varlistentry>
120
 
        <varlistentry>
121
 
          <term>--clutter-debug=FLAGS</term>
122
 
          <listitem><para>Equivalent of CLUTTER_DEBUG. Sets FLAGS as the
123
 
          Clutter debugging flags.</para></listitem>
124
 
        </varlistentry>
125
 
        <varlistentry>
126
 
          <term>--clutter-no-debug=FLAGS</term>
127
 
          <listitem><para>Unsets FLAGS from the Clutter debugging
128
 
          flags.</para></listitem>
129
 
        </varlistentry>
130
 
        <varlistentry>
131
 
          <term>--cogl-debug=FLAGS</term>
132
 
          <listitem><para>Equivalent of COGL_DEBUG. Sets FLAGS as the
133
 
          COGL debugging flags.</para></listitem>
134
 
        </varlistentry>
135
 
        <varlistentry>
136
 
          <term>--cogl-no-debug=FLAGS</term>
137
 
          <listitem><para>Unsets FLAGS from the COGL debugging
138
 
          flags.</para></listitem>
139
 
        </varlistentry>
140
 
      </variablelist>
141
 
 
142
 
      <para>The X11 backends also have the following command line
143
 
      options:</para>
144
 
 
145
 
      <variablelist>
146
 
        <varlistentry>
147
 
          <term>--display=DISPLAY</term>
148
 
          <listitem><para>Sets the X11 display to use.</para></listitem>
149
 
        </varlistentry>
150
 
        <varlistentry>
151
 
          <term>--screen=SCREEN</term>
152
 
          <listitem><para>Sets the X11 screen number to use.</para></listitem>
153
 
        </varlistentry>
154
 
        <varlistentry>
155
 
          <term>--synch</term>
156
 
          <listitem><para>Make X11 calls synchronous.</para></listitem>
157
 
        </varlistentry>
158
 
      </variablelist>
159
 
    </section>
160
 
 
161
 
    <para>The GLX backend also has the following command line option:</para>
162
 
 
163
 
    <variablelist>
164
 
      <varlistentry>
165
 
        <term>--vblank=METHOD</term>
166
 
        <listitem><para>Equivalent of CLUTTER_VBLANK. Sets the sync-to-vblank
167
 
        method to be used.</para></listitem>
168
 
      </varlistentry>
169
 
    </variablelist>
170
 
 
171
 
  </partintro>
172
 
</part>