← Back to branch summary

~ubuntu-branches/ubuntu/vivid/clutter-1.0/vivid-proposed

« back to all changes in this revision

Viewing changes to doc/reference/clutter/html/ClutterBackend.html

  • Committer: Package Import Robot
  • Author(s): Emilio Pozuelo Monfort
  • Date: 2014-03-26 11:51:28 UTC
  • mfrom: (1.5.1) (4.1.30 experimental)
  • Revision ID: package-import@ubuntu.com-20140326115128-timmbsde8734o6wz
Tags: 1.18.0-1
* New upstream release.
* debian/control.in:
  + Bump gtk-doc-tools build dependency.
  + Also break libcogl15.
  + Standards-Version is 3.9.5, no changes needed.
* debian/libclutter-1.0-0.symbols:
  + Drop a few symbols that were accidentally exported in the DSO because
    they had a clutter_ prefix but were not in the public headers.
  + Add one new symbol.
  + Drop unnecessary debian revisions from some symbols.
* debian/control.in,
  debian/rules,
  debian/libclutter-1.0-0.symbols:
  + Temporarily disable evdev input support. It was only enabled in 1.17.6-1
    in experimental and there is nothing using it yet, and I would like to
    wait a bit before uploading libinput to unstable as the ABI isn't stable
    yet.
* d/p/0001-wayland-Add-missing-CLUTTER_AVAILABLE-annotations.patch:
  + Add missing annotations so that a few symbols are exported in the DSO.

* Upload to unstable.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/clutter/html/ClutterBackend.html
2
2
<html>
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>ClutterBackend</title>
 
5
<title>Clutter Reference Manual: ClutterBackend</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="Clutter Reference Manual">
8
8
<link rel="up" href="clutterbackends.html" title="Part VII. Clutter Backends">
9
9
<link rel="prev" href="clutterbackends.html" title="Part VII. Clutter Backends">
10
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)">
 
11
<meta name="generator" content="GTK-Doc V1.20.1 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
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>
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
 
16
<td width="100%" align="left" class="shortcuts">
 
17
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
 
18
                  <a href="#ClutterBackend.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
 
19
                  <a href="#ClutterBackend.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_signals">  <span class="dim">|</span> 
 
20
                  <a href="#ClutterBackend.signals" class="shortcut">Signals</a></span>
 
21
</td>
 
22
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
 
23
<td><a accesskey="u" href="clutterbackends.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
 
24
<td><a accesskey="p" href="clutterbackends.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
 
25
<td><a accesskey="n" href="clutter-X11-Specific-Support.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
 
26
</tr></table>
33
27
<div class="refentry">
34
28
<a name="ClutterBackend"></a><div class="titlepage"></div>
35
29
<div class="refnamediv"><table width="100%"><tr>
37
31
<h2><span class="refentrytitle"><a name="ClutterBackend.top_of_page"></a>ClutterBackend</span></h2>
38
32
<p>ClutterBackend — Backend abstraction</p>
39
33
</td>
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>);
67
 
 
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>);
69
 
</pre>
 
36
<div class="refsect1">
 
37
<a name="ClutterBackend.functions"></a><h2>Functions</h2>
 
38
<div class="informaltable"><table width="100%" border="0">
 
39
<colgroup>
 
40
<col width="150px" class="functions_return">
 
41
<col class="functions_name">
 
42
</colgroup>
 
43
<tbody>
 
44
<tr>
 
45
<td class="function_type">
 
46
<a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="returnvalue">ClutterBackend</span></a> *
 
47
</td>
 
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>
 
50
</td>
 
51
</tr>
 
52
<tr>
 
53
<td class="function_type">
 
54
<span class="returnvalue">void</span>
 
55
</td>
 
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>
 
58
</td>
 
59
</tr>
 
60
<tr>
 
61
<td class="function_type">
 
62
<span class="returnvalue">gdouble</span>
 
63
</td>
 
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>
 
66
</td>
 
67
</tr>
 
68
<tr>
 
69
<td class="function_type">
 
70
<span class="returnvalue">void</span>
 
71
</td>
 
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>
 
74
</td>
 
75
</tr>
 
76
<tr>
 
77
<td class="function_type">
 
78
<span class="returnvalue">guint</span>
 
79
</td>
 
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>
 
82
</td>
 
83
</tr>
 
84
<tr>
 
85
<td class="function_type">
 
86
<span class="returnvalue">void</span>
 
87
</td>
 
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>
 
90
</td>
 
91
</tr>
 
92
<tr>
 
93
<td class="function_type">
 
94
<span class="returnvalue">guint</span>
 
95
</td>
 
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>
 
98
</td>
 
99
</tr>
 
100
<tr>
 
101
<td class="function_type">
 
102
<span class="returnvalue">void</span>
 
103
</td>
 
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>
 
106
</td>
 
107
</tr>
 
108
<tr>
 
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> *
 
110
</td>
 
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>
 
113
</td>
 
114
</tr>
 
115
<tr>
 
116
<td class="function_type">
 
117
<span class="returnvalue">void</span>
 
118
</td>
 
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>
 
121
</td>
 
122
</tr>
 
123
<tr>
 
124
<td class="function_type">const <span class="returnvalue">gchar</span> *
 
125
</td>
 
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>
 
128
</td>
 
129
</tr>
 
130
<tr>
 
131
<td class="function_type">
 
132
<span class="returnvalue">CoglContext</span> *
 
133
</td>
 
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>
 
136
</td>
 
137
</tr>
 
138
<tr>
 
139
<td class="function_type">
 
140
<span class="returnvalue">gboolean</span>
 
141
</td>
 
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>
 
144
</td>
 
145
</tr>
 
146
<tr>
 
147
<td class="function_type">
 
148
<span class="returnvalue">void</span>
 
149
</td>
 
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>
 
152
</td>
 
153
</tr>
 
154
</tbody>
 
155
</table></div>
 
156
</div>
 
157
<div class="refsect1">
 
158
<a name="ClutterBackend.signals"></a><h2>Signals</h2>
 
159
<div class="informaltable"><table border="0">
 
160
<colgroup>
 
161
<col width="150px" class="signals_return">
 
162
<col width="300px" class="signals_name">
 
163
<col width="200px" class="signals_flags">
 
164
</colgroup>
 
165
<tbody>
 
166
<tr>
 
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>
 
170
</tr>
 
171
<tr>
 
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>
 
175
</tr>
 
176
<tr>
 
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>
 
180
</tr>
 
181
</tbody>
 
182
</table></div>
 
183
</div>
 
184
<div class="refsect1">
 
185
<a name="ClutterBackend.other"></a><h2>Types and Values</h2>
 
186
<div class="informaltable"><table width="100%" border="0">
 
187
<colgroup>
 
188
<col width="150px" class="name">
 
189
<col class="description">
 
190
</colgroup>
 
191
<tbody><tr>
 
192
<td class="datatype_keyword"> </td>
 
193
<td class="function_name"><a class="link" href="ClutterBackend.html#ClutterBackend-struct" title="ClutterBackend">ClutterBackend</a></td>
 
194
</tr></tbody>
 
195
</table></div>
70
196
</div>
71
197
<div class="refsect1">
72
198
<a name="ClutterBackend.object-hierarchy"></a><h2>Object Hierarchy</h2>
73
 
<pre class="synopsis">
74
 
  GObject
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>"                                   : <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
84
201
</pre>
85
202
</div>
86
203
<div class="refsect1">
87
204
<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;
 
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
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>
 
209
and settings.</p>
 
210
<p><a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> is available since Clutter 0.4</p>
100
211
</div>
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>
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" class="variablelist">
121
 
<colgroup>
122
 
<col align="left" valign="top">
123
 
<col>
124
 
</colgroup>
125
 
<tbody><tr>
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>
130
 
</td>
131
 
</tr></tbody>
132
 
</table></div>
 
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>
 
226
</div>
133
227
<p class="since">Since 0.4</p>
134
228
</div>
135
229
<hr>
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>
143
238
</div>
144
 
<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).
149
 
</p>
150
 
<p>
151
 
Applications should never need to call this function.
152
 
</p>
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">
154
247
<colgroup>
155
 
<col align="left" valign="top">
156
 
<col>
 
248
<col width="150px" class="parameters_name">
 
249
<col class="parameters_description">
 
250
<col width="200px" class="parameters_annotations">
157
251
</colgroup>
158
252
<tbody>
159
253
<tr>
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>
162
 
</td>
 
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>
163
257
</tr>
164
258
<tr>
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>
168
263
</tr>
169
264
</tbody>
170
265
</table></div>
 
266
</div>
171
267
<p class="since">Since 0.4</p>
172
268
</div>
173
269
<hr>
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>
177
 
<p>
178
 
Gets the resolution for font handling on the screen.
179
 
</p>
180
 
<p>
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).
185
 
</p>
186
 
<p>
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.
190
 
</p>
191
 
<div class="variablelist"><table border="0" class="variablelist">
192
 
<colgroup>
193
 
<col align="left" valign="top">
194
 
<col>
195
 
</colgroup>
196
 
<tbody>
197
 
<tr>
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>
200
 
</td>
201
 
</tr>
202
 
<tr>
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
205
 
has been set.</td>
206
 
</tr>
207
 
</tbody>
208
 
</table></div>
209
 
<p class="since">Since 0.4</p>
210
 
</div>
211
 
<hr>
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>
220
 
</div>
221
 
<p>
222
 
Sets the maximum time between two button press events, used to
223
 
verify whether it's a double click event or not.
224
 
</p>
225
 
<div class="variablelist"><table border="0" class="variablelist">
226
 
<colgroup>
227
 
<col align="left" valign="top">
228
 
<col>
229
 
</colgroup>
230
 
<tbody>
231
 
<tr>
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>
234
 
</td>
235
 
</tr>
236
 
<tr>
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>
239
 
</tr>
240
 
</tbody>
241
 
</table></div>
242
 
<p class="since">Since 0.4</p>
243
 
</div>
244
 
<hr>
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>
252
 
</div>
253
 
<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>.
256
 
</p>
257
 
<div class="variablelist"><table border="0" class="variablelist">
258
 
<colgroup>
259
 
<col align="left" valign="top">
260
 
<col>
261
 
</colgroup>
262
 
<tbody>
263
 
<tr>
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>
266
 
</td>
267
 
</tr>
268
 
<tr>
269
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
270
 
<td>a time in milliseconds</td>
271
 
</tr>
272
 
</tbody>
273
 
</table></div>
274
 
<p class="since">Since 0.4</p>
275
 
</div>
276
 
<hr>
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>
285
 
</div>
286
 
<p>
287
 
Sets the maximum distance used to verify a double click event.
288
 
</p>
289
 
<div class="variablelist"><table border="0" class="variablelist">
290
 
<colgroup>
291
 
<col align="left" valign="top">
292
 
<col>
293
 
</colgroup>
294
 
<tbody>
295
 
<tr>
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>
298
 
</td>
299
 
</tr>
300
 
<tr>
301
 
<td><p><span class="term"><em class="parameter"><code>distance</code></em> :</span></p></td>
302
 
<td>a distance, in pixels</td>
303
 
</tr>
304
 
</tbody>
305
 
</table></div>
306
 
<p class="since">Since 0.4</p>
307
 
</div>
308
 
<hr>
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>
316
 
</div>
317
 
<p>
318
 
Retrieves the distance used to verify a double click event
319
 
</p>
320
 
<div class="variablelist"><table border="0" class="variablelist">
321
 
<colgroup>
322
 
<col align="left" valign="top">
323
 
<col>
324
 
</colgroup>
325
 
<tbody>
326
 
<tr>
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>
329
 
</td>
330
 
</tr>
331
 
<tr>
332
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
333
 
<td>a distance, in pixels.</td>
334
 
</tr>
335
 
</tbody>
336
 
</table></div>
337
 
<p class="since">Since 0.4</p>
338
 
</div>
339
 
<hr>
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>
344
 
<p>
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>.
347
 
</p>
348
 
<p>
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>.
352
 
</p>
353
 
<p>
354
 
This function is intended for actors creating a Pango layout
355
 
using the PangoCairo API.
356
 
</p>
357
 
<div class="variablelist"><table border="0" class="variablelist">
358
 
<colgroup>
359
 
<col align="left" valign="top">
360
 
<col>
361
 
</colgroup>
362
 
<tbody>
363
 
<tr>
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>
366
 
</td>
367
 
</tr>
368
 
<tr>
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>
371
 
</td>
372
 
</tr>
373
 
</tbody>
374
 
</table></div>
375
 
<p class="since">Since 0.8</p>
376
 
</div>
377
 
<hr>
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>
382
 
<p>
383
 
Retrieves the font options for <em class="parameter"><code>backend</code></em>.
384
 
</p>
385
 
<div class="variablelist"><table border="0" class="variablelist">
386
 
<colgroup>
387
 
<col align="left" valign="top">
388
 
<col>
389
 
</colgroup>
390
 
<tbody>
391
 
<tr>
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>
394
 
</td>
395
 
</tr>
396
 
<tr>
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>
401
 
</td>
402
 
</tr>
403
 
</tbody>
404
 
</table></div>
405
 
<p class="since">Since 0.8</p>
406
 
</div>
407
 
<hr>
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>
415
 
</div>
416
 
<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">
 
285
<colgroup>
 
286
<col width="150px" class="parameters_name">
 
287
<col class="parameters_description">
 
288
<col width="200px" class="parameters_annotations">
 
289
</colgroup>
 
290
<tbody><tr>
 
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>
 
294
</tr></tbody>
 
295
</table></div>
 
296
</div>
 
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
 
300
has been set.</p>
 
301
<p></p>
 
302
</div>
 
303
<p class="since">Since 0.4</p>
 
304
</div>
 
305
<hr>
 
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>
 
314
</div>
 
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">
 
320
<colgroup>
 
321
<col width="150px" class="parameters_name">
 
322
<col class="parameters_description">
 
323
<col width="200px" class="parameters_annotations">
 
324
</colgroup>
 
325
<tbody>
 
326
<tr>
 
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>
 
330
</tr>
 
331
<tr>
 
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>
 
335
</tr>
 
336
</tbody>
 
337
</table></div>
 
338
</div>
 
339
<p class="since">Since 0.4</p>
 
340
</div>
 
341
<hr>
 
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>
 
349
</div>
 
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">
 
355
<colgroup>
 
356
<col width="150px" class="parameters_name">
 
357
<col class="parameters_description">
 
358
<col width="200px" class="parameters_annotations">
 
359
</colgroup>
 
360
<tbody><tr>
 
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>
 
364
</tr></tbody>
 
365
</table></div>
 
366
</div>
 
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>
 
370
<p></p>
 
371
</div>
 
372
<p class="since">Since 0.4</p>
 
373
</div>
 
374
<hr>
 
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>
 
384
</div>
 
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">
 
389
<colgroup>
 
390
<col width="150px" class="parameters_name">
 
391
<col class="parameters_description">
 
392
<col width="200px" class="parameters_annotations">
 
393
</colgroup>
 
394
<tbody>
 
395
<tr>
 
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>
 
399
</tr>
 
400
<tr>
 
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>
 
404
</tr>
 
405
</tbody>
 
406
</table></div>
 
407
</div>
 
408
<p class="since">Since 0.4</p>
 
409
</div>
 
410
<hr>
 
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>
 
419
</div>
 
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">
 
424
<colgroup>
 
425
<col width="150px" class="parameters_name">
 
426
<col class="parameters_description">
 
427
<col width="200px" class="parameters_annotations">
 
428
</colgroup>
 
429
<tbody><tr>
 
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>
 
433
</tr></tbody>
 
434
</table></div>
 
435
</div>
 
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>
 
439
<p></p>
 
440
</div>
 
441
<p class="since">Since 0.4</p>
 
442
</div>
 
443
<hr>
 
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>
 
456
.</p>
 
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">
 
462
<colgroup>
 
463
<col width="150px" class="parameters_name">
 
464
<col class="parameters_description">
 
465
<col width="200px" class="parameters_annotations">
 
466
</colgroup>
 
467
<tbody>
 
468
<tr>
 
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>
 
472
</tr>
 
473
<tr>
 
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>
 
477
</tr>
 
478
</tbody>
 
479
</table></div>
 
480
</div>
 
481
<p class="since">Since 0.8</p>
 
482
</div>
 
483
<hr>
 
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>
 
489
.</p>
 
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">
 
493
<colgroup>
 
494
<col width="150px" class="parameters_name">
 
495
<col class="parameters_description">
 
496
<col width="200px" class="parameters_annotations">
 
497
</colgroup>
 
498
<tbody><tr>
 
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>
 
502
</tr></tbody>
 
503
</table></div>
 
504
</div>
 
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>
 
511
</div>
 
512
<p class="since">Since 0.8</p>
 
513
</div>
 
514
<hr>
 
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>
 
523
</div>
 
524
<p>Sets the default font to be used by Clutter. The <em class="parameter"><code>font_name</code></em>
 
525
 string
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.
421
 
</p>
422
 
<div class="variablelist"><table border="0" class="variablelist">
423
 
<colgroup>
424
 
<col align="left" valign="top">
425
 
<col>
426
 
</colgroup>
427
 
<tbody>
428
 
<tr>
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>
431
 
</td>
432
 
</tr>
433
 
<tr>
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>
436
 
</tr>
437
 
</tbody>
438
 
</table></div>
439
 
<p class="since">Since 1.0</p>
440
 
</div>
441
 
<hr>
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>
448
 
</div>
449
 
<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>.
452
 
</p>
453
 
<div class="variablelist"><table border="0" class="variablelist">
454
 
<colgroup>
455
 
<col align="left" valign="top">
456
 
<col>
457
 
</colgroup>
458
 
<tbody>
459
 
<tr>
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>
462
 
</td>
463
 
</tr>
464
 
<tr>
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>
468
 
</tr>
469
 
</tbody>
470
 
</table></div>
471
 
<p class="since">Since 1.0</p>
472
 
</div>
473
 
<hr>
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>
477
 
<p>
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.
481
 
</p>
482
 
<p>
483
 
</p>
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>
487
 
<p>
488
 
</p>
489
 
<p>
490
 
</p>
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">
 
532
<colgroup>
 
533
<col width="150px" class="parameters_name">
 
534
<col class="parameters_description">
 
535
<col width="200px" class="parameters_annotations">
 
536
</colgroup>
 
537
<tbody>
 
538
<tr>
 
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>
 
542
</tr>
 
543
<tr>
 
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>
 
547
</tr>
 
548
</tbody>
 
549
</table></div>
 
550
</div>
 
551
<p class="since">Since 1.0</p>
 
552
</div>
 
553
<hr>
 
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>
 
561
</div>
 
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">
 
567
<colgroup>
 
568
<col width="150px" class="parameters_name">
 
569
<col class="parameters_description">
 
570
<col width="200px" class="parameters_annotations">
 
571
</colgroup>
 
572
<tbody><tr>
 
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>
 
576
</tr></tbody>
 
577
</table></div>
 
578
</div>
 
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>
 
583
<p></p>
 
584
</div>
 
585
<p class="since">Since 1.0</p>
 
586
</div>
 
587
<hr>
 
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>
495
 
<p>
496
 
</p>
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">
498
604
<colgroup>
499
 
<col align="left" valign="top">
500
 
<col>
 
605
<col width="150px" class="parameters_name">
 
606
<col class="parameters_description">
 
607
<col width="200px" class="parameters_annotations">
501
608
</colgroup>
502
 
<tbody>
503
 
<tr>
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>
506
 
</td>
507
 
</tr>
508
 
<tr>
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>
511
 
</tr>
512
 
</tbody>
 
609
<tbody><tr>
 
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>
 
613
</tr></tbody>
513
614
</table></div>
 
615
</div>
 
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>
 
619
. </p>
 
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>
 
621
</div>
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.
 
628
 
 
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.
 
631
 
 
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>
516
637
</div>
517
638
<hr>
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>
521
 
<p>
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>.
525
 
</p>
526
 
<p>
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:
531
 
</p>
532
 
<p>
533
 
</p>
 
649
windowing system; for instance:</p>
534
650
<div class="informalexample">
535
651
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
536
652
    <tbody>
553
669
        <td class="listing_code"><pre class="programlisting"><span class="preproc">#ifdef</span><span class="normal"> CLUTTER_WINDOWING_X11</span>
554
670
<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>
555
671
<span class="normal">    </span><span class="cbracket">{</span>
556
 
<span class="normal">      </span><span class="comment">/* it is safe to use the clutter_x11_* API */</span>
 
672
<span class="normal">      </span><span class="comment">// it is safe to use the clutter_x11_* API</span>
557
673
<span class="normal">    </span><span class="cbracket">}</span>
558
674
<span class="normal">  </span><span class="keyword">else</span>
559
675
<span class="preproc">#endif</span>
560
676
<span class="preproc">#ifdef</span><span class="normal"> CLUTTER_WINDOWING_WIN32</span>
561
677
<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>
562
678
<span class="normal">    </span><span class="cbracket">{</span>
563
 
<span class="normal">      </span><span class="comment">/* it is safe to use the clutter_win32_* API */</span>
 
679
<span class="normal">      </span><span class="comment">// it is safe to use the clutter_win32_* API</span>
564
680
<span class="normal">    </span><span class="cbracket">}</span>
565
681
<span class="normal">  </span><span class="keyword">else</span>
566
682
<span class="preproc">#endif</span>
570
686
  </table>
571
687
</div>
572
688
 
573
 
<p>
574
 
</p>
575
 
<div class="variablelist"><table border="0" class="variablelist">
 
689
<p></p>
 
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">
576
693
<colgroup>
577
 
<col align="left" valign="top">
578
 
<col>
 
694
<col width="150px" class="parameters_name">
 
695
<col class="parameters_description">
 
696
<col width="200px" class="parameters_annotations">
579
697
</colgroup>
580
 
<tbody>
581
 
<tr>
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>
584
 
</tr>
585
 
<tr>
586
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
587
 
<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>
590
 
</tr>
591
 
</tbody>
 
698
<tbody><tr>
 
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>
 
702
</tr></tbody>
592
703
</table></div>
 
704
</div>
 
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>
 
709
<p></p>
 
710
</div>
593
711
<p class="since">Since 1.10</p>
594
712
</div>
 
713
<hr>
 
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">
 
724
<colgroup>
 
725
<col width="150px" class="parameters_name">
 
726
<col class="parameters_description">
 
727
<col width="200px" class="parameters_annotations">
 
728
</colgroup>
 
729
<tbody><tr>
 
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>
 
733
</tr></tbody>
 
734
</table></div>
 
735
</div>
 
736
<p class="since">Since 1.16</p>
 
737
</div>
 
738
</div>
 
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>
 
747
</div>
595
748
</div>
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>
602
 
<p>
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>.
605
 
</p>
606
 
<div class="variablelist"><table border="0" class="variablelist">
607
 
<colgroup>
608
 
<col align="left" valign="top">
609
 
<col>
610
 
</colgroup>
611
 
<tbody>
612
 
<tr>
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>
615
 
</tr>
616
 
<tr>
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>
619
 
</tr>
620
 
</tbody>
621
 
</table></div>
622
 
<p class="since">Since 1.0</p>
623
 
</div>
624
 
<hr>
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>
629
 
<p>
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>.
632
 
</p>
633
 
<div class="variablelist"><table border="0" class="variablelist">
634
 
<colgroup>
635
 
<col align="left" valign="top">
636
 
<col>
637
 
</colgroup>
638
 
<tbody>
639
 
<tr>
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>
642
 
</tr>
643
 
<tr>
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>
646
 
</tr>
647
 
</tbody>
648
 
</table></div>
649
 
<p class="since">Since 1.0</p>
650
 
</div>
651
 
<hr>
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>
656
 
<p>
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.
659
 
</p>
660
 
<div class="variablelist"><table border="0" class="variablelist">
661
 
<colgroup>
662
 
<col align="left" valign="top">
663
 
<col>
664
 
</colgroup>
665
 
<tbody>
666
 
<tr>
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>
669
 
</tr>
670
 
<tr>
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>
673
 
</tr>
674
 
</tbody>
675
 
</table></div>
 
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">
 
761
<colgroup>
 
762
<col width="150px" class="parameters_name">
 
763
<col class="parameters_description">
 
764
<col width="200px" class="parameters_annotations">
 
765
</colgroup>
 
766
<tbody>
 
767
<tr>
 
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>
 
771
</tr>
 
772
<tr>
 
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>
 
776
</tr>
 
777
</tbody>
 
778
</table></div>
 
779
</div>
 
780
<p>Flags: Run First</p>
 
781
<p class="since">Since 1.0</p>
 
782
</div>
 
783
<hr>
 
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">
 
794
<colgroup>
 
795
<col width="150px" class="parameters_name">
 
796
<col class="parameters_description">
 
797
<col width="200px" class="parameters_annotations">
 
798
</colgroup>
 
799
<tbody>
 
800
<tr>
 
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>
 
804
</tr>
 
805
<tr>
 
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>
 
809
</tr>
 
810
</tbody>
 
811
</table></div>
 
812
</div>
 
813
<p>Flags: Run First</p>
 
814
<p class="since">Since 1.0</p>
 
815
</div>
 
816
<hr>
 
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">
 
827
<colgroup>
 
828
<col width="150px" class="parameters_name">
 
829
<col class="parameters_description">
 
830
<col width="200px" class="parameters_annotations">
 
831
</colgroup>
 
832
<tbody>
 
833
<tr>
 
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>
 
837
</tr>
 
838
<tr>
 
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>
 
842
</tr>
 
843
</tbody>
 
844
</table></div>
 
845
</div>
 
846
<p>Flags: Run First</p>
676
847
<p class="since">Since 1.4</p>
677
848
</div>
678
849
</div>
679
850
</div>
680
851
<div class="footer">
681
852
<hr>
682
 
          Generated by GTK-Doc V1.18.1</div>
 
853
          Generated by GTK-Doc V1.20.1</div>
683
854
</body>
684
855
</html>
 
 
b'\\ No newline at end of file'