This file is indexed.

/usr/share/gtk-doc/html/clutter/clutter-ClutterWaylandSurface.html is in libclutter-1.0-doc 1.16.4-0ubuntu2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Clutter Reference Manual: ClutterWaylandSurface</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<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-Wayland-compositor-specific-support.html" title="Wayland compositor specific support">
<link rel="next" href="migration.html" title="Part VIII. Migrating from previous version of Clutter">
<meta name="generator" content="GTK-Doc V1.20 (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="10"><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-ClutterWaylandSurface.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
                  <a href="#clutter-ClutterWaylandSurface.object-hierarchy" class="shortcut">Object Hierarchy</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-Wayland-compositor-specific-support.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="migration.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="clutter-ClutterWaylandSurface"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="clutter-ClutterWaylandSurface.top_of_page"></a>ClutterWaylandSurface</span></h2>
<p>ClutterWaylandSurface — An actor which displays the content of a client surface</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="clutter-ClutterWaylandSurface.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
</td>
<td class="function_name">
<a class="link" href="clutter-ClutterWaylandSurface.html#clutter-wayland-surface-new" title="clutter_wayland_surface_new ()">clutter_wayland_surface_new</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-ClutterWaylandSurface.html#clutter-wayland-surface-attach-buffer" title="clutter_wayland_surface_attach_buffer ()">clutter_wayland_surface_attach_buffer</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-ClutterWaylandSurface.html#clutter-wayland-surface-damage-buffer" title="clutter_wayland_surface_damage_buffer ()">clutter_wayland_surface_damage_buffer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">CoglTexture</span> *
</td>
<td class="function_name">
<a class="link" href="clutter-ClutterWaylandSurface.html#clutter-wayland-surface-get-cogl-texture" title="clutter_wayland_surface_get_cogl_texture ()">clutter_wayland_surface_get_cogl_texture</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">struct <span class="returnvalue">wl_surface</span> *
</td>
<td class="function_name">
<a class="link" href="clutter-ClutterWaylandSurface.html#clutter-wayland-surface-get-surface" title="clutter_wayland_surface_get_surface ()">clutter_wayland_surface_get_surface</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-ClutterWaylandSurface.html#clutter-wayland-surface-set-surface" title="clutter_wayland_surface_set_surface ()">clutter_wayland_surface_set_surface</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="clutter-ClutterWaylandSurface.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface">ClutterWaylandSurface</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurfaceClass" title="struct ClutterWaylandSurfaceClass">ClutterWaylandSurfaceClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="clutter-ClutterWaylandSurface.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">
</pre>
</div>
<div class="refsect1">
<a name="clutter-ClutterWaylandSurface.description"></a><h2>Description</h2>
<p><a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a> is an actor for displaying the contents of a client
surface. It is intended to support developers implementing Clutter based
wayland compositors.</p>
</div>
<div class="refsect1">
<a name="clutter-ClutterWaylandSurface.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="clutter-wayland-surface-new"></a><h3>clutter_wayland_surface_new ()</h3>
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
clutter_wayland_surface_new (<em class="parameter"><code><span class="type">struct wl_surface</span> *surface</code></em>);</pre>
<p>Creates a new <a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a> for <em class="parameter"><code>surface</code></em>
</p>
<div class="refsect3">
<a name="id-1.8.13.7.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>surface</p></td>
<td class="parameter_description"><p>the Wayland surface this actor should represent</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.8.13.7.2.6"></a><h4>Returns</h4>
<p> A new <a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a> representing <em class="parameter"><code>surface</code></em>
</p>
<p></p>
</div>
<p class="since">Since 1.8</p>
<p class="stability">Stability Level: Unstable</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-wayland-surface-attach-buffer"></a><h3>clutter_wayland_surface_attach_buffer ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_wayland_surface_attach_buffer (<em class="parameter"><code><a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a> *self</code></em>,
                                       <em class="parameter"><code><span class="type">struct wl_resource</span> *buffer</code></em>,
                                       <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>This associates a client's buffer with the <a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a>
actor <em class="parameter"><code>self</code></em>
. This will automatically result in <em class="parameter"><code>self</code></em>
 being re-drawn
with the new buffer contents.</p>
<div class="refsect3">
<a name="id-1.8.13.7.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>self</p></td>
<td class="parameter_description"><p>A <a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a> actor</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>buffer</p></td>
<td class="parameter_description"><p>A compositor side resource representing a wl_buffer</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>A <span class="type">GError</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 1.8</p>
<p class="stability">Stability Level: Unstable</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-wayland-surface-damage-buffer"></a><h3>clutter_wayland_surface_damage_buffer ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_wayland_surface_damage_buffer (<em class="parameter"><code><a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a> *self</code></em>,
                                       <em class="parameter"><code><span class="type">struct wl_resource</span> *buffer</code></em>,
                                       <em class="parameter"><code><span class="type">gint32</span> x</code></em>,
                                       <em class="parameter"><code><span class="type">gint32</span> y</code></em>,
                                       <em class="parameter"><code><span class="type">gint32</span> width</code></em>,
                                       <em class="parameter"><code><span class="type">gint32</span> height</code></em>);</pre>
<p>This marks a region of the given <em class="parameter"><code>buffer</code></em>
 has having been changed by
the client. This will automatically result in the corresponding damaged
region of the actor <em class="parameter"><code>self</code></em>
 being redrawn.</p>
<p>If multiple regions are changed then this should be called multiple
times with different damage rectangles.</p>
<div class="refsect3">
<a name="id-1.8.13.7.4.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>self</p></td>
<td class="parameter_description"><p>A <a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a> actor</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>buffer</p></td>
<td class="parameter_description"><p>A wayland resource for a buffer</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x</p></td>
<td class="parameter_description"><p>The x coordinate of the damaged rectangle</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y</p></td>
<td class="parameter_description"><p>The y coordinate of the damaged rectangle</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>The width of the damaged rectangle</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>The height of the damaged rectangle</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 1.8</p>
<p class="stability">Stability Level: Unstable</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-wayland-surface-get-cogl-texture"></a><h3>clutter_wayland_surface_get_cogl_texture ()</h3>
<pre class="programlisting"><span class="returnvalue">CoglTexture</span> *
clutter_wayland_surface_get_cogl_texture
                               (<em class="parameter"><code><a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a> *self</code></em>);</pre>
<p>Retrieves the Cogl texture with the contents of the Wayland surface.</p>
<div class="refsect3">
<a name="id-1.8.13.7.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.8.13.7.5.6"></a><h4>Returns</h4>
<p> a Cogl texture, or <code class="literal">NULL</code>. </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 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-wayland-surface-get-surface"></a><h3>clutter_wayland_surface_get_surface ()</h3>
<pre class="programlisting">struct <span class="returnvalue">wl_surface</span> *
clutter_wayland_surface_get_surface (<em class="parameter"><code><a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a> *self</code></em>);</pre>
<p>Retrieves a point to the Wayland surface used by the actor.</p>
<div class="refsect3">
<a name="id-1.8.13.7.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.8.13.7.6.6"></a><h4>Returns</h4>
<p> a wl_surface pointer, or <code class="literal">NULL</code>. </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 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-wayland-surface-set-surface"></a><h3>clutter_wayland_surface_set_surface ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_wayland_surface_set_surface (<em class="parameter"><code><a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a> *self</code></em>,
                                     <em class="parameter"><code><span class="type">struct wl_surface</span> *surface</code></em>);</pre>
<p>Sets the Wayland surface to be used by the actor.</p>
<div class="refsect3">
<a name="id-1.8.13.7.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>surface</p></td>
<td class="parameter_description"><p>a Wayland wl_surface pointer</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 1.10</p>
</div>
</div>
<div class="refsect1">
<a name="clutter-ClutterWaylandSurface.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ClutterWaylandSurface"></a><h3>struct ClutterWaylandSurface</h3>
<pre class="programlisting">struct ClutterWaylandSurface {
};
</pre>
<p>The <a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a> structure contains only private data</p>
<p class="since">Since 1.10</p>
<p class="stability">Stability Level: Unstable</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterWaylandSurfaceClass"></a><h3>struct ClutterWaylandSurfaceClass</h3>
<pre class="programlisting">struct ClutterWaylandSurfaceClass {
  void (*queue_damage_redraw) (ClutterWaylandSurface *texture,
                               gint x,
                               gint y,
                               gint width,
                               gint height);
};
</pre>
<p>The <a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurfaceClass" title="struct ClutterWaylandSurfaceClass"><span class="type">ClutterWaylandSurfaceClass</span></a> structure contains only private data</p>
<div class="refsect3">
<a name="id-1.8.13.8.3.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody><tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterWaylandSurfaceClass.queue-damage-redraw"></a>queue_damage_redraw</code></em> ()</p></td>
<td class="struct_member_description"><p>class handler of the <span class="type">“queue-damage-redraw”</span> signal</p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since 1.10</p>
<p class="stability">Stability Level: Unstable</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.20</div>
</body>
</html>