This file is indexed.

/usr/share/gtk-doc/html/pigment/PgmImageSink.html is in libpigment0.3-dev 0.3.17-1ubuntu1.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PgmImageSink</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="Pigment 0.3 Reference Manual">
<link rel="up" href="pigment-core.html" title="Part II. Pigment Core Reference">
<link rel="prev" href="PgmImage.html" title="PgmImage">
<link rel="next" href="pigment-PgmLinearAlgebra.html" title="PgmLinearAlgebra">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="preface" href="introduction.html" title="Introduction">
<link rel="part" href="pigment-overview.html" title="Part I. Pigment Overview">
<link rel="part" href="pigment-core.html" title="Part II. Pigment Core Reference">
<link rel="part" href="pigment-library.html" title="Part III. Pigment Library Reference">
<link rel="index" href="pigment-hierarchy.html" title="Object Hierarchy">
<link rel="index" href="api-index.html" title="Index">
</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="2">
<tr valign="middle">
<td><a accesskey="p" href="PgmImage.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="pigment-core.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Pigment 0.3
 Reference Manual</th>
<td><a accesskey="n" href="pigment-PgmLinearAlgebra.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#PgmImageSink.synopsis" class="shortcut">Top</a>
                 | 
                <a href="#PgmImageSink.description" class="shortcut">Description</a>
                 | 
                <a href="#PgmImageSink.object-hierarchy" class="shortcut">Object Hierarchy</a>
                 | 
                <a href="#PgmImageSink.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry" lang="en">
<a name="PgmImageSink"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="PgmImageSink.top_of_page"></a>PgmImageSink</span></h2>
<p>PgmImageSink — A GStreamer image sink outputing frames to image
drawables.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="PgmImageSink.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">

#include &lt;pgm/pgm.h&gt;

enum                <a class="link" href="PgmImageSink.html#PgmImageSinkEventMask" title="enum PgmImageSinkEventMask">PgmImageSinkEventMask</a>;
                    <a class="link" href="PgmImageSink.html#PgmImageSink-struct" title="PgmImageSink">PgmImageSink</a>;
GstElement *        <a class="link" href="PgmImageSink.html#pgm-image-sink-new" title="pgm_image_sink_new ()">pgm_image_sink_new</a>                  (const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *name);
<a class="link" href="pigment-PgmCommon.html#PgmError" title="enum PgmError">PgmError</a>            <a class="link" href="PgmImageSink.html#pgm-image-sink-set-image" title="pgm_image_sink_set_image ()">pgm_image_sink_set_image</a>            (<a class="link" href="PgmImageSink.html" title="PgmImageSink">PgmImageSink</a> *sink,
                                                         <a class="link" href="PgmImage.html" title="PgmImage">PgmImage</a> *image);
<a class="link" href="pigment-PgmCommon.html#PgmError" title="enum PgmError">PgmError</a>            <a class="link" href="PgmImageSink.html#pgm-image-sink-get-image" title="pgm_image_sink_get_image ()">pgm_image_sink_get_image</a>            (<a class="link" href="PgmImageSink.html" title="PgmImageSink">PgmImageSink</a> *sink,
                                                         <a class="link" href="PgmImage.html" title="PgmImage">PgmImage</a> **image);
<a class="link" href="pigment-PgmCommon.html#PgmError" title="enum PgmError">PgmError</a>            <a class="link" href="PgmImageSink.html#pgm-image-sink-set-events" title="pgm_image_sink_set_events ()">pgm_image_sink_set_events</a>           (<a class="link" href="PgmImageSink.html" title="PgmImageSink">PgmImageSink</a> *sink,
                                                         <a class="link" href="PgmImageSink.html#PgmImageSinkEventMask" title="enum PgmImageSinkEventMask">PgmImageSinkEventMask</a> events);
<a class="link" href="pigment-PgmCommon.html#PgmError" title="enum PgmError">PgmError</a>            <a class="link" href="PgmImageSink.html#pgm-image-sink-get-events" title="pgm_image_sink_get_events ()">pgm_image_sink_get_events</a>           (<a class="link" href="PgmImageSink.html" title="PgmImageSink">PgmImageSink</a> *sink,
                                                         <a class="link" href="PgmImageSink.html#PgmImageSinkEventMask" title="enum PgmImageSinkEventMask">PgmImageSinkEventMask</a> *events);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="PgmImageSink.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
   +----GstObject
         +----GstElement
               +----GstBaseSink
                     +----GstVideoSink
                           +----PgmImageSink
</pre>
</div>
<div class="refsect1" lang="en">
<a name="PgmImageSink.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="PgmImageSink.html#PgmImageSink--events" title='The "events" property'>events</a>"                   <a class="link" href="PgmImageSink.html#PgmImageSinkEventMask" title="enum PgmImageSinkEventMask">PgmImageSinkEventMask</a>  : Read / Write
  "<a class="link" href="PgmImageSink.html#PgmImageSink--image" title='The "image" property'>image</a>"                    <a class="link" href="PgmImage.html" title="PgmImage">PgmImage</a>*             : Read / Write
</pre>
</div>
<div class="refsect1" lang="en">
<a name="PgmImageSink.description"></a><h2>Description</h2>
<p>
<a class="link" href="PgmImageSink.html" title="PgmImageSink"><span class="type">PgmImageSink</span></a> is a GStreamer image sink element allowing to build GStreamer
pipelines outputing frames directly to <a class="link" href="PgmImage.html" title="PgmImage"><span class="type">PgmImage</span></a>.
</p>
<p>
You can explicitly use the <a class="link" href="PgmImageSink.html#pgm-image-sink-new" title="pgm_image_sink_new ()"><code class="function">pgm_image_sink_new()</code></a> function to instanciate a
new sink, but you can alos use the standard GStreamer functions using
<code class="function">gst_element_factory_make()</code> or <code class="function">gst_parse_launch()</code>, the factory name of the
sink being "pgmimagesink".
</p>
<p>
Internally, the sink is simply outputing GStreamer buffers (<span class="type">GstBuffer</span>) to
images (<a class="link" href="PgmImage.html" title="PgmImage"><span class="type">PgmImage</span></a>) using the <a class="link" href="PgmImage.html#pgm-image-set-from-gst-buffer" title="pgm_image_set_from_gst_buffer ()"><code class="function">pgm_image_set_from_gst_buffer()</code></a> function.
</p>
<p>
Last reviewed on 2008-01-28 (0.3.4)</p>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="PgmImageSink.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="PgmImageSinkEventMask"></a><h3>enum PgmImageSinkEventMask</h3>
<pre class="programlisting">typedef enum {
    PGM_IMAGE_SINK_MOTION   = (1 &lt;&lt; 0),
    PGM_IMAGE_SINK_PRESSED  = (1 &lt;&lt; 1),
    PGM_IMAGE_SINK_RELEASED = (1 &lt;&lt; 2)
} PgmImageSinkEventMask;
</pre>
<p>
The event mask flags.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="PGM-IMAGE-SINK-MOTION--CAPS"></a><span class="term"><code class="literal">PGM_IMAGE_SINK_MOTION</code></span></p></td>
<td> The motion event flag.
</td>
</tr>
<tr>
<td><p><a name="PGM-IMAGE-SINK-PRESSED--CAPS"></a><span class="term"><code class="literal">PGM_IMAGE_SINK_PRESSED</code></span></p></td>
<td> The pressed event flag.
</td>
</tr>
<tr>
<td><p><a name="PGM-IMAGE-SINK-RELEASED--CAPS"></a><span class="term"><code class="literal">PGM_IMAGE_SINK_RELEASED</code></span></p></td>
<td> The released event flag.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="PgmImageSink-struct"></a><h3>PgmImageSink</h3>
<pre class="programlisting">typedef struct _PgmImageSink PgmImageSink;</pre>
<p>
The opaque <a class="link" href="PgmImageSink.html" title="PgmImageSink"><span class="type">PgmImageSink</span></a> data structure.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="pgm-image-sink-new"></a><h3>pgm_image_sink_new ()</h3>
<pre class="programlisting">GstElement *        pgm_image_sink_new                  (const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *name);</pre>
<p>
Creates a new image sink with the given name.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td> the name of the new image sink.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a new <a class="link" href="PgmImageSink.html" title="PgmImageSink"><span class="type">PgmImageSink</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="pgm-image-sink-set-image"></a><h3>pgm_image_sink_set_image ()</h3>
<pre class="programlisting"><a class="link" href="pigment-PgmCommon.html#PgmError" title="enum PgmError">PgmError</a>            pgm_image_sink_set_image            (<a class="link" href="PgmImageSink.html" title="PgmImageSink">PgmImageSink</a> *sink,
                                                         <a class="link" href="PgmImage.html" title="PgmImage">PgmImage</a> *image);</pre>
<p>
Sets <em class="parameter"><code>image</code></em> as the <a class="link" href="PgmImage.html" title="PgmImage"><span class="type">PgmImage</span></a> object which will receive the frames
(<span class="type">GstBuffer</span>) outputed by <em class="parameter"><code>sink</code></em>.
</p>
<p>
MT Safe.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
<td> a <a class="link" href="PgmImageSink.html" title="PgmImageSink"><span class="type">PgmImageSink</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td>
<td> the <a class="link" href="PgmImage.html" title="PgmImage"><span class="type">PgmImage</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a <a class="link" href="pigment-PgmCommon.html#PgmError" title="enum PgmError"><span class="type">PgmError</span></a> indicating success/failure.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="pgm-image-sink-get-image"></a><h3>pgm_image_sink_get_image ()</h3>
<pre class="programlisting"><a class="link" href="pigment-PgmCommon.html#PgmError" title="enum PgmError">PgmError</a>            pgm_image_sink_get_image            (<a class="link" href="PgmImageSink.html" title="PgmImageSink">PgmImageSink</a> *sink,
                                                         <a class="link" href="PgmImage.html" title="PgmImage">PgmImage</a> **image);</pre>
<p>
Retrieves the <a class="link" href="PgmImage.html" title="PgmImage"><span class="type">PgmImage</span></a> object in <em class="parameter"><code>image</code></em> which <em class="parameter"><code>sink</code></em> is using to output its
frames (<span class="type">GstBuffer</span>).
</p>
<p>
MT Safe.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
<td> a <a class="link" href="PgmImageSink.html" title="PgmImageSink"><span class="type">PgmImageSink</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td>
<td> a pointer to a <a class="link" href="PgmImage.html" title="PgmImage"><span class="type">PgmImage</span></a> pointer where the image will be stored.
Unref after usage.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a <a class="link" href="pigment-PgmCommon.html#PgmError" title="enum PgmError"><span class="type">PgmError</span></a> indicating success/failure.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="pgm-image-sink-set-events"></a><h3>pgm_image_sink_set_events ()</h3>
<pre class="programlisting"><a class="link" href="pigment-PgmCommon.html#PgmError" title="enum PgmError">PgmError</a>            pgm_image_sink_set_events           (<a class="link" href="PgmImageSink.html" title="PgmImageSink">PgmImageSink</a> *sink,
                                                         <a class="link" href="PgmImageSink.html#PgmImageSinkEventMask" title="enum PgmImageSinkEventMask">PgmImageSinkEventMask</a> events);</pre>
<p>
Sets the mouse events interacting with the currently set image that will be
sent upstream in the pipeline.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
<td> a <a class="link" href="PgmImageSink.html" title="PgmImageSink"><span class="type">PgmImageSink</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>events</code></em> :</span></p></td>
<td> a <a class="link" href="PgmImageSink.html#PgmImageSinkEventMask" title="enum PgmImageSinkEventMask"><span class="type">PgmImageSinkEventMask</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a <a class="link" href="pigment-PgmCommon.html#PgmError" title="enum PgmError"><span class="type">PgmError</span></a> indicating success/failure.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="pgm-image-sink-get-events"></a><h3>pgm_image_sink_get_events ()</h3>
<pre class="programlisting"><a class="link" href="pigment-PgmCommon.html#PgmError" title="enum PgmError">PgmError</a>            pgm_image_sink_get_events           (<a class="link" href="PgmImageSink.html" title="PgmImageSink">PgmImageSink</a> *sink,
                                                         <a class="link" href="PgmImageSink.html#PgmImageSinkEventMask" title="enum PgmImageSinkEventMask">PgmImageSinkEventMask</a> *events);</pre>
<p>
Retrieves in <em class="parameter"><code>events</code></em> the mouse events sent upstream in the pipeline.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
<td> a <a class="link" href="PgmImageSink.html" title="PgmImageSink"><span class="type">PgmImageSink</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>events</code></em> :</span></p></td>
<td> a <a class="link" href="PgmImageSink.html#PgmImageSinkEventMask" title="enum PgmImageSinkEventMask"><span class="type">PgmImageSinkEventMask</span></a> pointer where the event mask will be
stored.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a <a class="link" href="pigment-PgmCommon.html#PgmError" title="enum PgmError"><span class="type">PgmError</span></a> indicating success/failure.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="PgmImageSink.property-details"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="PgmImageSink--events"></a><h3>The <code class="literal">"events"</code> property</h3>
<pre class="programlisting">  "events"                   <a class="link" href="PgmImageSink.html#PgmImageSinkEventMask" title="enum PgmImageSinkEventMask">PgmImageSinkEventMask</a>  : Read / Write</pre>
<p>
A <a class="link" href="PgmImageSink.html#PgmImageSinkEventMask" title="enum PgmImageSinkEventMask"><span class="type">PgmImageSinkEventMask</span></a> specifying what input events should be sent
upstream in the pipeline.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="PgmImageSink--image"></a><h3>The <code class="literal">"image"</code> property</h3>
<pre class="programlisting">  "image"                    <a class="link" href="PgmImage.html" title="PgmImage">PgmImage</a>*             : Read / Write</pre>
<p>
A <a class="link" href="PgmImage.html" title="PgmImage"><span class="type">PgmImage</span></a> on which the sink output video frames.</p>
<p>
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="PgmImageSink.see-also"></a><h2>See Also</h2>
#PgmImage
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.11</div>
</body>
</html>