1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GDK Specific Support: Clutter Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Clutter Reference Manual">
<link rel="up" href="clutterbackends.html" title="Part VII. Clutter Backends">
<link rel="prev" href="clutter-Intel-CE3100-CE4100-Specific-Support.html" title="Intel CE3100, CE4100 Specific Support">
<link rel="next" href="clutter-Wayland-specific-support.html" title="Wayland specific support">
<meta name="generator" content="GTK-Doc V1.29 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#clutter-GDK-Specific-Support.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="clutterbackends.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="clutter-Intel-CE3100-CE4100-Specific-Support.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="clutter-Wayland-specific-support.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="clutter-GDK-Specific-Support"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="clutter-GDK-Specific-Support.top_of_page"></a>GDK Specific Support</span></h2>
<p>GDK Specific Support — GDK specific API</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="clutter-GDK-Specific-Support.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="clutter-GDK-Specific-Support.html#clutter-gdk-disable-event-retrieval" title="clutter_gdk_disable_event_retrieval ()">clutter_gdk_disable_event_retrieval</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *
</td>
<td class="function_name">
<a class="link" href="clutter-GDK-Specific-Support.html#clutter-gdk-get-stage-from-window" title="clutter_gdk_get_stage_from_window ()">clutter_gdk_get_stage_from_window</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GdkWindow</span> *
</td>
<td class="function_name">
<a class="link" href="clutter-GDK-Specific-Support.html#clutter-gdk-get-stage-window" title="clutter_gdk_get_stage_window ()">clutter_gdk_get_stage_window</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GdkFilterReturn</span>
</td>
<td class="function_name">
<a class="link" href="clutter-GDK-Specific-Support.html#clutter-gdk-handle-event" title="clutter_gdk_handle_event ()">clutter_gdk_handle_event</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="clutter-GDK-Specific-Support.html#clutter-gdk-set-display" title="clutter_gdk_set_display ()">clutter_gdk_set_display</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GdkDisplay</span> *
</td>
<td class="function_name">
<a class="link" href="clutter-GDK-Specific-Support.html#clutter-gdk-get-default-display" title="clutter_gdk_get_default_display ()">clutter_gdk_get_default_display</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="clutter-GDK-Specific-Support.html#clutter-gdk-set-stage-foreign" title="clutter_gdk_set_stage_foreign ()">clutter_gdk_set_stage_foreign</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GdkVisual</span> *
</td>
<td class="function_name">
<a class="link" href="clutter-GDK-Specific-Support.html#clutter-gdk-get-visual" title="clutter_gdk_get_visual ()">clutter_gdk_get_visual</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="clutter-GDK-Specific-Support.description"></a><h2>Description</h2>
<p>The GDK backend for Clutter provides some specific API, allowing
integration with the GDK API for manipulating the stage window and
handling events outside of Clutter.</p>
</div>
<div class="refsect1">
<a name="clutter-GDK-Specific-Support.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="clutter-gdk-disable-event-retrieval"></a><h3>clutter_gdk_disable_event_retrieval ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_gdk_disable_event_retrieval (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Disable the event retrieval in Clutter.</p>
<p>Callers of this function have to set up an event filter using the
GDK API, and call <a class="link" href="clutter-GDK-Specific-Support.html#clutter-gdk-handle-event" title="clutter_gdk_handle_event ()"><code class="function">clutter_gdk_handle_event()</code></a>.</p>
<p>This function should only be used when embedding Clutter into
a GDK based toolkit.</p>
<p class="since">Since: <a class="link" href="ix12.html#api-index-1.10">1.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-gdk-get-stage-from-window"></a><h3>clutter_gdk_get_stage_from_window ()</h3>
<pre class="programlisting"><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *
clutter_gdk_get_stage_from_window (<em class="parameter"><code><span class="type">GdkWindow</span> *window</code></em>);</pre>
<p>Gets the stage for a particular X window.</p>
<div class="refsect3">
<a name="clutter-gdk-get-stage-from-window.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>window</p></td>
<td class="parameter_description"><p>a <span class="type">GtkWindow</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-gdk-get-stage-from-window.returns"></a><h4>Returns</h4>
<p>A <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>, or% NULL if a stage
does not exist for the window. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix12.html#api-index-1.10">1.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-gdk-get-stage-window"></a><h3>clutter_gdk_get_stage_window ()</h3>
<pre class="programlisting"><span class="returnvalue">GdkWindow</span> *
clutter_gdk_get_stage_window (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
<p>Gets the stages GdkWindow.</p>
<div class="refsect3">
<a name="clutter-gdk-get-stage-window.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-gdk-get-stage-window.returns"></a><h4>Returns</h4>
<p>A GdkWindow* for the stage window. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix12.html#api-index-1.10">1.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-gdk-handle-event"></a><h3>clutter_gdk_handle_event ()</h3>
<pre class="programlisting"><span class="returnvalue">GdkFilterReturn</span>
clutter_gdk_handle_event (<em class="parameter"><code><span class="type">GdkEvent</span> *event</code></em>);</pre>
<p>This function processes a single GDK event; it can be used to hook
into external event processing</p>
<div class="refsect3">
<a name="clutter-gdk-handle-event.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>event</p></td>
<td class="parameter_description"><p>a <span class="type">GdkEvent</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-gdk-handle-event.returns"></a><h4>Returns</h4>
<p> <span class="type">GdkFilterReturn</span>. <code class="literal">GDK_FILTER_REMOVE</code> indicates that
Clutter has internally handled the event and the caller should do
no further processing. <code class="literal">GDK_FILTER_CONTINUE</code> indicates that Clutter
is either not interested in the event, or has used the event to
update internal state without taking any exclusive action.
<code class="literal">GDK_FILTER_TRANSLATE</code> will not occur.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="clutter-gdk-set-display"></a><h3>clutter_gdk_set_display ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_gdk_set_display (<em class="parameter"><code><span class="type">GdkDisplay</span> *display</code></em>);</pre>
<p>Sets the display connection Clutter should use; must be called
before <a class="link" href="clutter-General.html#clutter-init" title="clutter_init ()"><code class="function">clutter_init()</code></a>, <a class="link" href="clutter-General.html#clutter-init-with-args" title="clutter_init_with_args ()"><code class="function">clutter_init_with_args()</code></a> or other functions
pertaining Clutter's initialization process.</p>
<p>If you are parsing the command line arguments by retrieving Clutter's
<span class="type">GOptionGroup</span> with <a class="link" href="clutter-General.html#clutter-get-option-group" title="clutter_get_option_group ()"><code class="function">clutter_get_option_group()</code></a> and calling
<code class="function">g_option_context_parse()</code> yourself, you should also call
<a class="link" href="clutter-GDK-Specific-Support.html#clutter-gdk-set-display" title="clutter_gdk_set_display ()"><code class="function">clutter_gdk_set_display()</code></a> before <code class="function">g_option_context_parse()</code>.</p>
<div class="refsect3">
<a name="clutter-gdk-set-display.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>display</p></td>
<td class="parameter_description"><p>pointer to a GDK display connection.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-gdk-get-default-display"></a><h3>clutter_gdk_get_default_display ()</h3>
<pre class="programlisting"><span class="returnvalue">GdkDisplay</span> *
clutter_gdk_get_default_display (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Retrieves the pointer to the default display.</p>
<div class="refsect3">
<a name="clutter-gdk-get-default-display.returns"></a><h4>Returns</h4>
<p>the default display. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-gdk-set-stage-foreign"></a><h3>clutter_gdk_set_stage_foreign ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_gdk_set_stage_foreign (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
<em class="parameter"><code><span class="type">GdkWindow</span> *window</code></em>);</pre>
<p>Target the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> to use an existing external <span class="type">GdkWindow</span></p>
<div class="refsect3">
<a name="clutter-gdk-set-stage-foreign.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>window</p></td>
<td class="parameter_description"><p>an existing <span class="type">GdkWindow</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-gdk-set-stage-foreign.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if foreign window is valid</p>
</div>
<p class="since">Since: <a class="link" href="ix12.html#api-index-1.10">1.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-gdk-get-visual"></a><h3>clutter_gdk_get_visual ()</h3>
<pre class="programlisting"><span class="returnvalue">GdkVisual</span> *
clutter_gdk_get_visual (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Retrieves the <span class="type">GdkVisual</span> used by Clutter.</p>
<p>This function should be used when embedding Clutter inside GDK-based
foreign toolkits, to ensure that the visual applied to the <span class="type">GdkWindow</span>
used to render the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> is the correct one.</p>
<div class="refsect3">
<a name="clutter-gdk-get-visual.returns"></a><h4>Returns</h4>
<p>a <span class="type">GdkVisual</span> instance. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix18.html#api-index-1.22">1.22</a></p>
</div>
</div>
<div class="refsect1">
<a name="clutter-GDK-Specific-Support.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.29</div>
</body>
</html>
|
