37
31
<h2><span class="refentrytitle"><a name="ClutterBackend.top_of_page"></a>ClutterBackend</span></h2>
38
32
<p>ClutterBackend — Backend abstraction</p>
40
<td valign="top" align="right"></td>
34
<td class="gallery_image" valign="top" align="right"></td>
41
35
</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><span class="type">gdouble</span> dpi</code></em>);
48
<span class="returnvalue">gdouble</span> <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><span class="type">guint</span> msec</code></em>);
52
<span class="returnvalue">guint</span> <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><span class="type">guint</span> distance</code></em>);
57
<span class="returnvalue">guint</span> <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/gnome/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/gnome/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 <span class="type">gchar</span> *font_name</code></em>);
65
const <span class="returnvalue">gchar</span> * <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>);
68
<span class="returnvalue">gboolean</span> <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>);
36
<div class="refsect1">
37
<a name="ClutterBackend.functions"></a><h2>Functions</h2>
38
<div class="informaltable"><table width="100%" border="0">
40
<col width="150px" class="functions_return">
41
<col class="functions_name">
45
<td class="function_type">
46
<a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="returnvalue">ClutterBackend</span></a> *
48
<td class="function_name">
49
<a class="link" href="ClutterBackend.html#clutter-get-default-backend" title="clutter_get_default_backend ()">clutter_get_default_backend</a> <span class="c_punctuation">()</span>
53
<td class="function_type">
54
<span class="returnvalue">void</span>
56
<td class="function_name">
57
<a class="link" href="ClutterBackend.html#clutter-backend-set-resolution" title="clutter_backend_set_resolution ()">clutter_backend_set_resolution</a> <span class="c_punctuation">()</span>
61
<td class="function_type">
62
<span class="returnvalue">gdouble</span>
64
<td class="function_name">
65
<a class="link" href="ClutterBackend.html#clutter-backend-get-resolution" title="clutter_backend_get_resolution ()">clutter_backend_get_resolution</a> <span class="c_punctuation">()</span>
69
<td class="function_type">
70
<span class="returnvalue">void</span>
72
<td class="function_name">
73
<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> <span class="c_punctuation">()</span>
77
<td class="function_type">
78
<span class="returnvalue">guint</span>
80
<td class="function_name">
81
<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> <span class="c_punctuation">()</span>
85
<td class="function_type">
86
<span class="returnvalue">void</span>
88
<td class="function_name">
89
<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> <span class="c_punctuation">()</span>
93
<td class="function_type">
94
<span class="returnvalue">guint</span>
96
<td class="function_name">
97
<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> <span class="c_punctuation">()</span>
101
<td class="function_type">
102
<span class="returnvalue">void</span>
104
<td class="function_name">
105
<a class="link" href="ClutterBackend.html#clutter-backend-set-font-options" title="clutter_backend_set_font_options ()">clutter_backend_set_font_options</a> <span class="c_punctuation">()</span>
109
<td class="function_type">const <a href="/usr/share/gtk-doc/html/cairo/cairo-cairo-font-options-t.html#cairo-font-options-t"><span class="returnvalue">cairo_font_options_t</span></a> *
111
<td class="function_name">
112
<a class="link" href="ClutterBackend.html#clutter-backend-get-font-options" title="clutter_backend_get_font_options ()">clutter_backend_get_font_options</a> <span class="c_punctuation">()</span>
116
<td class="function_type">
117
<span class="returnvalue">void</span>
119
<td class="function_name">
120
<a class="link" href="ClutterBackend.html#clutter-backend-set-font-name" title="clutter_backend_set_font_name ()">clutter_backend_set_font_name</a> <span class="c_punctuation">()</span>
124
<td class="function_type">const <span class="returnvalue">gchar</span> *
126
<td class="function_name">
127
<a class="link" href="ClutterBackend.html#clutter-backend-get-font-name" title="clutter_backend_get_font_name ()">clutter_backend_get_font_name</a> <span class="c_punctuation">()</span>
131
<td class="function_type">
132
<span class="returnvalue">CoglContext</span> *
134
<td class="function_name">
135
<a class="link" href="ClutterBackend.html#clutter-backend-get-cogl-context" title="clutter_backend_get_cogl_context ()">clutter_backend_get_cogl_context</a> <span class="c_punctuation">()</span>
139
<td class="function_type">
140
<span class="returnvalue">gboolean</span>
142
<td class="function_name">
143
<a class="link" href="ClutterBackend.html#clutter-check-windowing-backend" title="clutter_check_windowing_backend ()">clutter_check_windowing_backend</a> <span class="c_punctuation">()</span>
147
<td class="function_type">
148
<span class="returnvalue">void</span>
150
<td class="function_name">
151
<a class="link" href="ClutterBackend.html#clutter-set-windowing-backend" title="clutter_set_windowing_backend ()">clutter_set_windowing_backend</a> <span class="c_punctuation">()</span>
157
<div class="refsect1">
158
<a name="ClutterBackend.signals"></a><h2>Signals</h2>
159
<div class="informaltable"><table border="0">
161
<col width="150px" class="signals_return">
162
<col width="300px" class="signals_name">
163
<col width="200px" class="signals_flags">
167
<td class="signal_type"><span class="returnvalue">void</span></td>
168
<td class="signal_name"><a class="link" href="ClutterBackend.html#ClutterBackend-font-changed" title="The “font-changed” signal">font-changed</a></td>
169
<td class="signal_flags">Run First</td>
172
<td class="signal_type"><span class="returnvalue">void</span></td>
173
<td class="signal_name"><a class="link" href="ClutterBackend.html#ClutterBackend-resolution-changed" title="The “resolution-changed” signal">resolution-changed</a></td>
174
<td class="signal_flags">Run First</td>
177
<td class="signal_type"><span class="returnvalue">void</span></td>
178
<td class="signal_name"><a class="link" href="ClutterBackend.html#ClutterBackend-settings-changed" title="The “settings-changed” signal">settings-changed</a></td>
179
<td class="signal_flags">Run First</td>
184
<div class="refsect1">
185
<a name="ClutterBackend.other"></a><h2>Types and Values</h2>
186
<div class="informaltable"><table width="100%" border="0">
188
<col width="150px" class="name">
189
<col class="description">
192
<td class="datatype_keyword"> </td>
193
<td class="function_name"><a class="link" href="ClutterBackend.html#ClutterBackend-struct" title="ClutterBackend">ClutterBackend</a></td>
71
197
<div class="refsect1">
72
198
<a name="ClutterBackend.object-hierarchy"></a><h2>Object Hierarchy</h2>
73
<pre class="synopsis">
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>" : <code class="literal">Run First</code>
82
"<a class="link" href="ClutterBackend.html#ClutterBackend-resolution-changed" title='The "resolution-changed" signal'>resolution-changed</a>" : <code class="literal">Run First</code>
83
"<a class="link" href="ClutterBackend.html#ClutterBackend-settings-changed" title='The "settings-changed" signal'>settings-changed</a>" : <code class="literal">Run First</code>
199
<pre class="screen"> GObject
200
<span class="lineart">╰──</span> ClutterBackend
86
203
<div class="refsect1">
87
204
<a name="ClutterBackend.description"></a><h2>Description</h2>
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.
93
<a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> is the base class abstracting the various implementation;
205
<p>Clutter can be compiled against different backends. Each backend
206
has to implement a set of functions, in order to be used by Clutter.</p>
207
<p><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> is the base class abstracting the various implementation;
94
208
it provides a basic API to query the backend for generic information
98
<a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> is available since Clutter 0.4
210
<p><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> is available since Clutter 0.4</p>
101
212
<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>
107
<span class="structname">ClutterBackend</span> is an opaque structure whose
108
members cannot be directly accessed.
110
<p class="since">Since 0.4</p>
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>
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.
120
<div class="variablelist"><table border="0" class="variablelist">
122
<col align="left" valign="top">
126
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
127
<td>the default backend. You should
213
<a name="ClutterBackend.functions_details"></a><h2>Functions</h2>
214
<div class="refsect2">
215
<a name="clutter-get-default-backend"></a><h3>clutter_get_default_backend ()</h3>
216
<pre class="programlisting"><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="returnvalue">ClutterBackend</span></a> *
217
clutter_get_default_backend (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
218
<p>Retrieves the default <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> used by Clutter. The
219
<a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> holds backend-specific configuration options.</p>
220
<div class="refsect3">
221
<a name="id-1.8.3.8.2.5"></a><h4>Returns</h4>
222
<p> the default backend. You should
128
223
not ref or unref the returned object. Applications should rarely
129
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>
224
need to use this. </p>
225
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
133
227
<p class="since">Since 0.4</p>
136
230
<div class="refsect2">
137
<a name="clutter-backend-set-resolution"></a><h3>clutter_backend_set_resolution ()</h3>
138
<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>,
139
<em class="parameter"><code><span class="type">gdouble</span> dpi</code></em>);</pre>
140
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
141
<h3 class="title">Warning</h3>
142
<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>
231
<a name="clutter-backend-set-resolution"></a><h3>clutter_backend_set_resolution ()</h3>
232
<pre class="programlisting"><span class="returnvalue">void</span>
233
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>,
234
<em class="parameter"><code><span class="type">gdouble</span> dpi</code></em>);</pre>
235
<div class="warning">
236
<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.</p>
237
<p>Use <a class="link" href="ClutterSettings.html#ClutterSettings--font-dpi" title="The “font-dpi” property"><span class="type">“font-dpi”</span></a> instead</p>
145
Sets the resolution for font handling on the screen. This is a
239
<p>Sets the resolution for font handling on the screen. This is a
146
240
scale factor between points specified in a <span class="type">PangoFontDescription</span>
147
241
and cairo units. The default value is 96, meaning that a 10 point
148
font will be 13 units high. (10 * 96. / 72. = 13.3).
151
Applications should never need to call this function.
153
<div class="variablelist"><table border="0" class="variablelist">
242
font will be 13 units high. (10 * 96. / 72. = 13.3).</p>
243
<p>Applications should never need to call this function.</p>
244
<div class="refsect3">
245
<a name="id-1.8.3.8.3.8"></a><h4>Parameters</h4>
246
<div class="informaltable"><table width="100%" border="0">
155
<col align="left" valign="top">
248
<col width="150px" class="parameters_name">
249
<col class="parameters_description">
250
<col width="200px" class="parameters_annotations">
160
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
161
<td>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a>
254
<td class="parameter_name"><p>backend</p></td>
255
<td class="parameter_description"><p>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a></p></td>
256
<td class="parameter_annotations"> </td>
165
<td><p><span class="term"><em class="parameter"><code>dpi</code></em> :</span></p></td>
166
<td>the resolution in "dots per inch" (Physical inches aren't
167
actually involved; the terminology is conventional).</td>
259
<td class="parameter_name"><p>dpi</p></td>
260
<td class="parameter_description"><p>the resolution in "dots per inch" (Physical inches aren't
261
actually involved; the terminology is conventional).</p></td>
262
<td class="parameter_annotations"> </td>
171
267
<p class="since">Since 0.4</p>
174
270
<div class="refsect2">
175
<a name="clutter-backend-get-resolution"></a><h3>clutter_backend_get_resolution ()</h3>
176
<pre class="programlisting"><span class="returnvalue">gdouble</span> 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>
178
Gets the resolution for font handling on the screen.
181
The resolution is a scale factor between points specified in a
271
<a name="clutter-backend-get-resolution"></a><h3>clutter_backend_get_resolution ()</h3>
272
<pre class="programlisting"><span class="returnvalue">gdouble</span>
273
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>
274
<p>Gets the resolution for font handling on the screen.</p>
275
<p>The resolution is a scale factor between points specified in a
182
276
<span class="type">PangoFontDescription</span> and cairo units. The default value is 96.0,
183
277
meaning that a 10 point font will be 13 units
184
high (10 * 96. / 72. = 13.3).
187
Clutter will set the resolution using the current backend when
278
high (10 * 96. / 72. = 13.3).</p>
279
<p>Clutter will set the resolution using the current backend when
188
280
initializing; the resolution is also stored in the
189
<a class="link" href="ClutterSettings.html#ClutterSettings--font-dpi" title='The "font-dpi" property'><span class="type">"font-dpi"</span></a> property.
191
<div class="variablelist"><table border="0" class="variablelist">
193
<col align="left" valign="top">
198
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
199
<td>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a>
203
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
204
<td>the current resolution, or -1 if no resolution
209
<p class="since">Since 0.4</p>
212
<div class="refsect2">
213
<a name="clutter-backend-set-double-click-time"></a><h3>clutter_backend_set_double_click_time ()</h3>
214
<pre class="programlisting"><span class="returnvalue">void</span> clutter_backend_set_double_click_time
215
(<em class="parameter"><code><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend</code></em>,
216
<em class="parameter"><code><span class="type">guint</span> msec</code></em>);</pre>
217
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
218
<h3 class="title">Warning</h3>
219
<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>
222
Sets the maximum time between two button press events, used to
223
verify whether it's a double click event or not.
225
<div class="variablelist"><table border="0" class="variablelist">
227
<col align="left" valign="top">
232
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
233
<td>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a>
237
<td><p><span class="term"><em class="parameter"><code>msec</code></em> :</span></p></td>
238
<td>milliseconds between two button press events</td>
242
<p class="since">Since 0.4</p>
245
<div class="refsect2">
246
<a name="clutter-backend-get-double-click-time"></a><h3>clutter_backend_get_double_click_time ()</h3>
247
<pre class="programlisting"><span class="returnvalue">guint</span> clutter_backend_get_double_click_time
248
(<em class="parameter"><code><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend</code></em>);</pre>
249
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
250
<h3 class="title">Warning</h3>
251
<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>
254
Gets the maximum time between two button press events, as set
255
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>.
257
<div class="variablelist"><table border="0" class="variablelist">
259
<col align="left" valign="top">
264
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
265
<td>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a>
269
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
270
<td>a time in milliseconds</td>
274
<p class="since">Since 0.4</p>
277
<div class="refsect2">
278
<a name="clutter-backend-set-double-click-distance"></a><h3>clutter_backend_set_double_click_distance ()</h3>
279
<pre class="programlisting"><span class="returnvalue">void</span> clutter_backend_set_double_click_distance
280
(<em class="parameter"><code><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend</code></em>,
281
<em class="parameter"><code><span class="type">guint</span> distance</code></em>);</pre>
282
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
283
<h3 class="title">Warning</h3>
284
<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>
287
Sets the maximum distance used to verify a double click event.
289
<div class="variablelist"><table border="0" class="variablelist">
291
<col align="left" valign="top">
296
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
297
<td>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a>
301
<td><p><span class="term"><em class="parameter"><code>distance</code></em> :</span></p></td>
302
<td>a distance, in pixels</td>
306
<p class="since">Since 0.4</p>
309
<div class="refsect2">
310
<a name="clutter-backend-get-double-click-distance"></a><h3>clutter_backend_get_double_click_distance ()</h3>
311
<pre class="programlisting"><span class="returnvalue">guint</span> clutter_backend_get_double_click_distance
312
(<em class="parameter"><code><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend</code></em>);</pre>
313
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
314
<h3 class="title">Warning</h3>
315
<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>
318
Retrieves the distance used to verify a double click event
320
<div class="variablelist"><table border="0" class="variablelist">
322
<col align="left" valign="top">
327
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
328
<td>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a>
332
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
333
<td>a distance, in pixels.</td>
337
<p class="since">Since 0.4</p>
340
<div class="refsect2">
341
<a name="clutter-backend-set-font-options"></a><h3>clutter_backend_set_font_options ()</h3>
342
<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>,
343
<em class="parameter"><code>const <a href="/home/ebassi/gnome/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>
345
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
346
copy the <a href="/home/ebassi/gnome/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>.
349
If <em class="parameter"><code>options</code></em> is <code class="literal">NULL</code>, the first following call to
350
<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
351
options for <em class="parameter"><code>backend</code></em>.
354
This function is intended for actors creating a Pango layout
355
using the PangoCairo API.
357
<div class="variablelist"><table border="0" class="variablelist">
359
<col align="left" valign="top">
364
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
365
<td>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a>
369
<td><p><span class="term"><em class="parameter"><code>options</code></em> :</span></p></td>
370
<td>Cairo font options for the backend, or <code class="literal">NULL</code>
375
<p class="since">Since 0.8</p>
378
<div class="refsect2">
379
<a name="clutter-backend-get-font-options"></a><h3>clutter_backend_get_font_options ()</h3>
380
<pre class="programlisting">const <a href="/home/ebassi/gnome/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
381
(<em class="parameter"><code><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend</code></em>);</pre>
383
Retrieves the font options for <em class="parameter"><code>backend</code></em>.
385
<div class="variablelist"><table border="0" class="variablelist">
387
<col align="left" valign="top">
392
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
393
<td>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a>
397
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
398
<td>the font options of the <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a>.
399
The returned <a href="/home/ebassi/gnome/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
400
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>
405
<p class="since">Since 0.8</p>
408
<div class="refsect2">
409
<a name="clutter-backend-set-font-name"></a><h3>clutter_backend_set_font_name ()</h3>
410
<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>,
411
<em class="parameter"><code>const <span class="type">gchar</span> *font_name</code></em>);</pre>
412
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
413
<h3 class="title">Warning</h3>
414
<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>
417
Sets the default font to be used by Clutter. The <em class="parameter"><code>font_name</code></em> string
281
<a class="link" href="ClutterSettings.html#ClutterSettings--font-dpi" title="The “font-dpi” property"><span class="type">“font-dpi”</span></a> property.</p>
282
<div class="refsect3">
283
<a name="id-1.8.3.8.4.7"></a><h4>Parameters</h4>
284
<div class="informaltable"><table width="100%" border="0">
286
<col width="150px" class="parameters_name">
287
<col class="parameters_description">
288
<col width="200px" class="parameters_annotations">
291
<td class="parameter_name"><p>backend</p></td>
292
<td class="parameter_description"><p>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a></p></td>
293
<td class="parameter_annotations"> </td>
297
<div class="refsect3">
298
<a name="id-1.8.3.8.4.8"></a><h4>Returns</h4>
299
<p> the current resolution, or -1 if no resolution
303
<p class="since">Since 0.4</p>
306
<div class="refsect2">
307
<a name="clutter-backend-set-double-click-time"></a><h3>clutter_backend_set_double_click_time ()</h3>
308
<pre class="programlisting"><span class="returnvalue">void</span>
309
clutter_backend_set_double_click_time (<em class="parameter"><code><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend</code></em>,
310
<em class="parameter"><code><span class="type">guint</span> msec</code></em>);</pre>
311
<div class="warning">
312
<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.</p>
313
<p>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>
315
<p>Sets the maximum time between two button press events, used to
316
verify whether it's a double click event or not.</p>
317
<div class="refsect3">
318
<a name="id-1.8.3.8.5.7"></a><h4>Parameters</h4>
319
<div class="informaltable"><table width="100%" border="0">
321
<col width="150px" class="parameters_name">
322
<col class="parameters_description">
323
<col width="200px" class="parameters_annotations">
327
<td class="parameter_name"><p>backend</p></td>
328
<td class="parameter_description"><p>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a></p></td>
329
<td class="parameter_annotations"> </td>
332
<td class="parameter_name"><p>msec</p></td>
333
<td class="parameter_description"><p>milliseconds between two button press events</p></td>
334
<td class="parameter_annotations"> </td>
339
<p class="since">Since 0.4</p>
342
<div class="refsect2">
343
<a name="clutter-backend-get-double-click-time"></a><h3>clutter_backend_get_double_click_time ()</h3>
344
<pre class="programlisting"><span class="returnvalue">guint</span>
345
clutter_backend_get_double_click_time (<em class="parameter"><code><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend</code></em>);</pre>
346
<div class="warning">
347
<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.</p>
348
<p>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>
350
<p>Gets the maximum time between two button press events, as set
351
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>.</p>
352
<div class="refsect3">
353
<a name="id-1.8.3.8.6.7"></a><h4>Parameters</h4>
354
<div class="informaltable"><table width="100%" border="0">
356
<col width="150px" class="parameters_name">
357
<col class="parameters_description">
358
<col width="200px" class="parameters_annotations">
361
<td class="parameter_name"><p>backend</p></td>
362
<td class="parameter_description"><p>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a></p></td>
363
<td class="parameter_annotations"> </td>
367
<div class="refsect3">
368
<a name="id-1.8.3.8.6.8"></a><h4>Returns</h4>
369
<p> a time in milliseconds</p>
372
<p class="since">Since 0.4</p>
375
<div class="refsect2">
376
<a name="clutter-backend-set-double-click-distance"></a><h3>clutter_backend_set_double_click_distance ()</h3>
377
<pre class="programlisting"><span class="returnvalue">void</span>
378
clutter_backend_set_double_click_distance
379
(<em class="parameter"><code><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend</code></em>,
380
<em class="parameter"><code><span class="type">guint</span> distance</code></em>);</pre>
381
<div class="warning">
382
<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.</p>
383
<p>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>
385
<p>Sets the maximum distance used to verify a double click event.</p>
386
<div class="refsect3">
387
<a name="id-1.8.3.8.7.7"></a><h4>Parameters</h4>
388
<div class="informaltable"><table width="100%" border="0">
390
<col width="150px" class="parameters_name">
391
<col class="parameters_description">
392
<col width="200px" class="parameters_annotations">
396
<td class="parameter_name"><p>backend</p></td>
397
<td class="parameter_description"><p>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a></p></td>
398
<td class="parameter_annotations"> </td>
401
<td class="parameter_name"><p>distance</p></td>
402
<td class="parameter_description"><p>a distance, in pixels</p></td>
403
<td class="parameter_annotations"> </td>
408
<p class="since">Since 0.4</p>
411
<div class="refsect2">
412
<a name="clutter-backend-get-double-click-distance"></a><h3>clutter_backend_get_double_click_distance ()</h3>
413
<pre class="programlisting"><span class="returnvalue">guint</span>
414
clutter_backend_get_double_click_distance
415
(<em class="parameter"><code><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend</code></em>);</pre>
416
<div class="warning">
417
<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.</p>
418
<p>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>
420
<p>Retrieves the distance used to verify a double click event</p>
421
<div class="refsect3">
422
<a name="id-1.8.3.8.8.7"></a><h4>Parameters</h4>
423
<div class="informaltable"><table width="100%" border="0">
425
<col width="150px" class="parameters_name">
426
<col class="parameters_description">
427
<col width="200px" class="parameters_annotations">
430
<td class="parameter_name"><p>backend</p></td>
431
<td class="parameter_description"><p>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a></p></td>
432
<td class="parameter_annotations"> </td>
436
<div class="refsect3">
437
<a name="id-1.8.3.8.8.8"></a><h4>Returns</h4>
438
<p> a distance, in pixels.</p>
441
<p class="since">Since 0.4</p>
444
<div class="refsect2">
445
<a name="clutter-backend-set-font-options"></a><h3>clutter_backend_set_font_options ()</h3>
446
<pre class="programlisting"><span class="returnvalue">void</span>
447
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>,
448
<em class="parameter"><code>const <a href="/usr/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>
449
<p>Sets the new font options for <em class="parameter"><code>backend</code></em>
450
. The <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> will
451
copy the <a href="/usr/share/gtk-doc/html/cairo/cairo-cairo-font-options-t.html#cairo-font-options-t"><span class="type">cairo_font_options_t</span></a>.</p>
452
<p>If <em class="parameter"><code>options</code></em>
453
is <code class="literal">NULL</code>, the first following call to
454
<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
455
options for <em class="parameter"><code>backend</code></em>
457
<p>This function is intended for actors creating a Pango layout
458
using the PangoCairo API.</p>
459
<div class="refsect3">
460
<a name="id-1.8.3.8.9.7"></a><h4>Parameters</h4>
461
<div class="informaltable"><table width="100%" border="0">
463
<col width="150px" class="parameters_name">
464
<col class="parameters_description">
465
<col width="200px" class="parameters_annotations">
469
<td class="parameter_name"><p>backend</p></td>
470
<td class="parameter_description"><p>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a></p></td>
471
<td class="parameter_annotations"> </td>
474
<td class="parameter_name"><p>options</p></td>
475
<td class="parameter_description"><p>Cairo font options for the backend, or <code class="literal">NULL</code></p></td>
476
<td class="parameter_annotations"> </td>
481
<p class="since">Since 0.8</p>
484
<div class="refsect2">
485
<a name="clutter-backend-get-font-options"></a><h3>clutter_backend_get_font_options ()</h3>
486
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/cairo/cairo-cairo-font-options-t.html#cairo-font-options-t"><span class="returnvalue">cairo_font_options_t</span></a> *
487
clutter_backend_get_font_options (<em class="parameter"><code><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend</code></em>);</pre>
488
<p>Retrieves the font options for <em class="parameter"><code>backend</code></em>
490
<div class="refsect3">
491
<a name="id-1.8.3.8.10.5"></a><h4>Parameters</h4>
492
<div class="informaltable"><table width="100%" border="0">
494
<col width="150px" class="parameters_name">
495
<col class="parameters_description">
496
<col width="200px" class="parameters_annotations">
499
<td class="parameter_name"><p>backend</p></td>
500
<td class="parameter_description"><p>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a></p></td>
501
<td class="parameter_annotations"> </td>
505
<div class="refsect3">
506
<a name="id-1.8.3.8.10.6"></a><h4>Returns</h4>
507
<p> the font options of the <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a>.
508
The returned <a href="/usr/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
509
not be modified or freed. </p>
510
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
512
<p class="since">Since 0.8</p>
515
<div class="refsect2">
516
<a name="clutter-backend-set-font-name"></a><h3>clutter_backend_set_font_name ()</h3>
517
<pre class="programlisting"><span class="returnvalue">void</span>
518
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>,
519
<em class="parameter"><code>const <span class="type">gchar</span> *font_name</code></em>);</pre>
520
<div class="warning">
521
<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.</p>
522
<p>Use <a class="link" href="ClutterSettings.html#ClutterSettings--font-name" title="The “font-name” property"><span class="type">“font-name”</span></a> instead</p>
524
<p>Sets the default font to be used by Clutter. The <em class="parameter"><code>font_name</code></em>
418
526
must either be <code class="literal">NULL</code>, which means that the font name from the
419
527
default <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> will be used; or be something that can
420
be parsed by the <code class="function">pango_font_description_from_string()</code> function.
422
<div class="variablelist"><table border="0" class="variablelist">
424
<col align="left" valign="top">
429
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
430
<td>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a>
434
<td><p><span class="term"><em class="parameter"><code>font_name</code></em> :</span></p></td>
435
<td>the name of the font</td>
439
<p class="since">Since 1.0</p>
442
<div class="refsect2">
443
<a name="clutter-backend-get-font-name"></a><h3>clutter_backend_get_font_name ()</h3>
444
<pre class="programlisting">const <span class="returnvalue">gchar</span> * 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>
445
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
446
<h3 class="title">Warning</h3>
447
<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>
450
Retrieves the default font name as set by
451
<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>.
453
<div class="variablelist"><table border="0" class="variablelist">
455
<col align="left" valign="top">
460
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
461
<td>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a>
465
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
466
<td>the font name for the backend. The returned string is
467
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>
471
<p class="since">Since 1.0</p>
474
<div class="refsect2">
475
<a name="clutter-backend-get-cogl-context"></a><h3>clutter_backend_get_cogl_context ()</h3>
476
<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>
478
Retrieves the <span class="type">CoglContext</span> associated with the given clutter
479
<em class="parameter"><code>backend</code></em>. A <span class="type">CoglContext</span> is required when using some of the
480
experimental 2.0 Cogl API.
484
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
485
<h3 class="title">Note</h3>Since CoglContext is itself experimental API this API should
486
be considered experimental too.</div>
491
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
492
<h3 class="title">Note</h3>This API is not yet supported on OSX because OSX still
528
be parsed by the <code class="function">pango_font_description_from_string()</code> function.</p>
529
<div class="refsect3">
530
<a name="id-1.8.3.8.11.7"></a><h4>Parameters</h4>
531
<div class="informaltable"><table width="100%" border="0">
533
<col width="150px" class="parameters_name">
534
<col class="parameters_description">
535
<col width="200px" class="parameters_annotations">
539
<td class="parameter_name"><p>backend</p></td>
540
<td class="parameter_description"><p>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a></p></td>
541
<td class="parameter_annotations"> </td>
544
<td class="parameter_name"><p>font_name</p></td>
545
<td class="parameter_description"><p>the name of the font</p></td>
546
<td class="parameter_annotations"> </td>
551
<p class="since">Since 1.0</p>
554
<div class="refsect2">
555
<a name="clutter-backend-get-font-name"></a><h3>clutter_backend_get_font_name ()</h3>
556
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
557
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>
558
<div class="warning">
559
<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.</p>
560
<p>Use <a class="link" href="ClutterSettings.html#ClutterSettings--font-name" title="The “font-name” property"><span class="type">“font-name”</span></a> instead</p>
562
<p>Retrieves the default font name as set by
563
<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>.</p>
564
<div class="refsect3">
565
<a name="id-1.8.3.8.12.7"></a><h4>Parameters</h4>
566
<div class="informaltable"><table width="100%" border="0">
568
<col width="150px" class="parameters_name">
569
<col class="parameters_description">
570
<col width="200px" class="parameters_annotations">
573
<td class="parameter_name"><p>backend</p></td>
574
<td class="parameter_description"><p>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a></p></td>
575
<td class="parameter_annotations"> </td>
579
<div class="refsect3">
580
<a name="id-1.8.3.8.12.8"></a><h4>Returns</h4>
581
<p> the font name for the backend. The returned string is
582
owned by the <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> and should never be modified or freed</p>
585
<p class="since">Since 1.0</p>
588
<div class="refsect2">
589
<a name="clutter-backend-get-cogl-context"></a><h3>clutter_backend_get_cogl_context ()</h3>
590
<pre class="programlisting"><span class="returnvalue">CoglContext</span> *
591
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>
592
<p>Retrieves the <span class="type">CoglContext</span> associated with the given clutter
593
<em class="parameter"><code>backend</code></em>
594
. A <span class="type">CoglContext</span> is required when using some of the
595
experimental 2.0 Cogl API.</p>
596
<p>Since CoglContext is itself experimental API this API should
597
be considered experimental too.</p>
598
<p>This API is not yet supported on OSX because OSX still
493
599
uses the stub Cogl winsys and the Clutter backend doesn't
494
explicitly create a CoglContext.</div>
497
<div class="variablelist"><table border="0" class="variablelist">
600
explicitly create a CoglContext.</p>
601
<div class="refsect3">
602
<a name="id-1.8.3.8.13.7"></a><h4>Parameters</h4>
603
<div class="informaltable"><table width="100%" border="0">
499
<col align="left" valign="top">
605
<col width="150px" class="parameters_name">
606
<col class="parameters_description">
607
<col width="200px" class="parameters_annotations">
504
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
505
<td>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a>
509
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
510
<td>The <span class="type">CoglContext</span> associated with <em class="parameter"><code>backend</code></em>.</td>
610
<td class="parameter_name"><p>backend</p></td>
611
<td class="parameter_description"><p>a <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a></p></td>
612
<td class="parameter_annotations"> </td>
616
<div class="refsect3">
617
<a name="id-1.8.3.8.13.8"></a><h4>Returns</h4>
618
<p> The <span class="type">CoglContext</span> associated with <em class="parameter"><code>backend</code></em>
620
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
514
622
<p class="since">Since 1.8</p>
515
<p class="stability">Stability Level: Unstable</p>
623
<p class="stability">Stability Level: <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
624
give outside developers early access to new or rapidly changing technology, or
625
to provide an interim solution to a problem where a more general solution is
626
anticipated. No claims are made about either source or binary compatibility from
627
one minor release to the next.
629
The Unstable interface level is a warning that these interfaces are subject to
630
change without warning and should not be used in unbundled products.
632
Given such caveats, customer impact need not be a factor when considering
633
incompatible changes to an Unstable interface in a major or minor release.
634
Nonetheless, when such changes are introduced, the changes should still be
635
mentioned in the release notes for the affected release.
636
"><span class="acronym">Unstable</span></acronym></p>
518
639
<div class="refsect2">
519
<a name="clutter-check-windowing-backend"></a><h3>clutter_check_windowing_backend ()</h3>
520
<pre class="programlisting"><span class="returnvalue">gboolean</span> clutter_check_windowing_backend (<em class="parameter"><code>const <span class="type">char</span> *backend_type</code></em>);</pre>
522
Checks the run-time name of the Clutter windowing system backend, using
640
<a name="clutter-check-windowing-backend"></a><h3>clutter_check_windowing_backend ()</h3>
641
<pre class="programlisting"><span class="returnvalue">gboolean</span>
642
clutter_check_windowing_backend (<em class="parameter"><code>const <span class="type">char</span> *backend_type</code></em>);</pre>
643
<p>Checks the run-time name of the Clutter windowing system backend, using
523
644
the symbolic macros like <code class="literal">CLUTTER_WINDOWING_WIN32</code> or
524
<code class="literal">CLUTTER_WINDOWING_X11</code>.
527
This function should be used in conjuction with the compile-time macros
645
<code class="literal">CLUTTER_WINDOWING_X11</code>.</p>
646
<p>This function should be used in conjuction with the compile-time macros
528
647
inside applications and libraries that are using the platform-specific
529
648
windowing system API, to ensure that they are running on the correct
530
windowing system; for instance:
649
windowing system; for instance:</p>
534
650
<div class="informalexample">
535
651
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
575
<div class="variablelist"><table border="0" class="variablelist">
690
<div class="refsect3">
691
<a name="id-1.8.3.8.14.8"></a><h4>Parameters</h4>
692
<div class="informaltable"><table width="100%" border="0">
577
<col align="left" valign="top">
694
<col width="150px" class="parameters_name">
695
<col class="parameters_description">
696
<col width="200px" class="parameters_annotations">
582
<td><p><span class="term"><em class="parameter"><code>backend_type</code></em> :</span></p></td>
583
<td>the name of the backend to check</td>
586
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
588
<code class="literal">TRUE</code> if the current Clutter windowing system backend is
589
the one checked, and <code class="literal">FALSE</code> otherwise</td>
699
<td class="parameter_name"><p>backend_type</p></td>
700
<td class="parameter_description"><p>the name of the backend to check</p></td>
701
<td class="parameter_annotations"> </td>
705
<div class="refsect3">
706
<a name="id-1.8.3.8.14.9"></a><h4>Returns</h4>
707
<p> <code class="literal">TRUE</code> if the current Clutter windowing system backend is
708
the one checked, and <code class="literal">FALSE</code> otherwise</p>
593
711
<p class="since">Since 1.10</p>
714
<div class="refsect2">
715
<a name="clutter-set-windowing-backend"></a><h3>clutter_set_windowing_backend ()</h3>
716
<pre class="programlisting"><span class="returnvalue">void</span>
717
clutter_set_windowing_backend (<em class="parameter"><code>const <span class="type">char</span> *backend_type</code></em>);</pre>
718
<p>Restricts clutter to only use the specified backend.
719
This must be called before the first API call to clutter, including
720
<code class="function">clutter_get_option_context()</code></p>
721
<div class="refsect3">
722
<a name="id-1.8.3.8.15.5"></a><h4>Parameters</h4>
723
<div class="informaltable"><table width="100%" border="0">
725
<col width="150px" class="parameters_name">
726
<col class="parameters_description">
727
<col width="200px" class="parameters_annotations">
730
<td class="parameter_name"><p>backend_type</p></td>
731
<td class="parameter_description"><p>the name of a clutter window backend</p></td>
732
<td class="parameter_annotations"> </td>
736
<p class="since">Since 1.16</p>
739
<div class="refsect1">
740
<a name="ClutterBackend.other_details"></a><h2>Types and Values</h2>
741
<div class="refsect2">
742
<a name="ClutterBackend-struct"></a><h3>ClutterBackend</h3>
743
<pre class="programlisting">typedef struct _ClutterBackend ClutterBackend;</pre>
744
<p><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> is an opaque structure whose
745
members cannot be directly accessed.</p>
746
<p class="since">Since 0.4</p>
596
749
<div class="refsect1">
597
750
<a name="ClutterBackend.signal-details"></a><h2>Signal Details</h2>
598
751
<div class="refsect2">
599
<a name="ClutterBackend-font-changed"></a><h3>The <code class="literal">"font-changed"</code> signal</h3>
600
<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,
601
<span class="type">gpointer</span> user_data) : <code class="literal">Run First</code></pre>
603
The ::font-changed signal is emitted each time the font options
604
have been changed through <a class="link" href="ClutterSettings.html" title="ClutterSettings"><span class="type">ClutterSettings</span></a>.
606
<div class="variablelist"><table border="0" class="variablelist">
608
<col align="left" valign="top">
613
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
614
<td>the <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> that emitted the signal</td>
617
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
618
<td>user data set when the signal handler was connected.</td>
622
<p class="since">Since 1.0</p>
625
<div class="refsect2">
626
<a name="ClutterBackend-resolution-changed"></a><h3>The <code class="literal">"resolution-changed"</code> signal</h3>
627
<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,
628
<span class="type">gpointer</span> user_data) : <code class="literal">Run First</code></pre>
630
The ::resolution-changed signal is emitted each time the font
631
resolutions has been changed through <a class="link" href="ClutterSettings.html" title="ClutterSettings"><span class="type">ClutterSettings</span></a>.
633
<div class="variablelist"><table border="0" class="variablelist">
635
<col align="left" valign="top">
640
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
641
<td>the <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> that emitted the signal</td>
644
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
645
<td>user data set when the signal handler was connected.</td>
649
<p class="since">Since 1.0</p>
652
<div class="refsect2">
653
<a name="ClutterBackend-settings-changed"></a><h3>The <code class="literal">"settings-changed"</code> signal</h3>
654
<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,
655
<span class="type">gpointer</span> user_data) : <code class="literal">Run First</code></pre>
657
The ::settings-changed signal is emitted each time the <a class="link" href="ClutterSettings.html" title="ClutterSettings"><span class="type">ClutterSettings</span></a>
658
properties have been changed.
660
<div class="variablelist"><table border="0" class="variablelist">
662
<col align="left" valign="top">
667
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
668
<td>the <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> that emitted the signal</td>
671
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
672
<td>user data set when the signal handler was connected.</td>
752
<a name="ClutterBackend-font-changed"></a><h3>The <code class="literal">“font-changed”</code> signal</h3>
753
<pre class="programlisting"><span class="returnvalue">void</span>
754
user_function (<a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend,
755
<span class="type">gpointer</span> user_data)</pre>
756
<p>The ::font-changed signal is emitted each time the font options
757
have been changed through <a class="link" href="ClutterSettings.html" title="ClutterSettings"><span class="type">ClutterSettings</span></a>.</p>
758
<div class="refsect3">
759
<a name="id-1.8.3.10.2.5"></a><h4>Parameters</h4>
760
<div class="informaltable"><table width="100%" border="0">
762
<col width="150px" class="parameters_name">
763
<col class="parameters_description">
764
<col width="200px" class="parameters_annotations">
768
<td class="parameter_name"><p>backend</p></td>
769
<td class="parameter_description"><p>the <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> that emitted the signal</p></td>
770
<td class="parameter_annotations"> </td>
773
<td class="parameter_name"><p>user_data</p></td>
774
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
775
<td class="parameter_annotations"> </td>
780
<p>Flags: Run First</p>
781
<p class="since">Since 1.0</p>
784
<div class="refsect2">
785
<a name="ClutterBackend-resolution-changed"></a><h3>The <code class="literal">“resolution-changed”</code> signal</h3>
786
<pre class="programlisting"><span class="returnvalue">void</span>
787
user_function (<a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend,
788
<span class="type">gpointer</span> user_data)</pre>
789
<p>The ::resolution-changed signal is emitted each time the font
790
resolutions has been changed through <a class="link" href="ClutterSettings.html" title="ClutterSettings"><span class="type">ClutterSettings</span></a>.</p>
791
<div class="refsect3">
792
<a name="id-1.8.3.10.3.5"></a><h4>Parameters</h4>
793
<div class="informaltable"><table width="100%" border="0">
795
<col width="150px" class="parameters_name">
796
<col class="parameters_description">
797
<col width="200px" class="parameters_annotations">
801
<td class="parameter_name"><p>backend</p></td>
802
<td class="parameter_description"><p>the <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> that emitted the signal</p></td>
803
<td class="parameter_annotations"> </td>
806
<td class="parameter_name"><p>user_data</p></td>
807
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
808
<td class="parameter_annotations"> </td>
813
<p>Flags: Run First</p>
814
<p class="since">Since 1.0</p>
817
<div class="refsect2">
818
<a name="ClutterBackend-settings-changed"></a><h3>The <code class="literal">“settings-changed”</code> signal</h3>
819
<pre class="programlisting"><span class="returnvalue">void</span>
820
user_function (<a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *backend,
821
<span class="type">gpointer</span> user_data)</pre>
822
<p>The ::settings-changed signal is emitted each time the <a class="link" href="ClutterSettings.html" title="ClutterSettings"><span class="type">ClutterSettings</span></a>
823
properties have been changed.</p>
824
<div class="refsect3">
825
<a name="id-1.8.3.10.4.5"></a><h4>Parameters</h4>
826
<div class="informaltable"><table width="100%" border="0">
828
<col width="150px" class="parameters_name">
829
<col class="parameters_description">
830
<col width="200px" class="parameters_annotations">
834
<td class="parameter_name"><p>backend</p></td>
835
<td class="parameter_description"><p>the <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> that emitted the signal</p></td>
836
<td class="parameter_annotations"> </td>
839
<td class="parameter_name"><p>user_data</p></td>
840
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
841
<td class="parameter_annotations"> </td>
846
<p>Flags: Run First</p>
676
847
<p class="since">Since 1.4</p>
680
851
<div class="footer">
682
Generated by GTK-Doc V1.18.1</div>
853
Generated by GTK-Doc V1.20.1</div>
b'\\ No newline at end of file'