gstreamer1.0-vaapi-doc 0.5.9-2 / usr / share / doc / gstreamer1.0-vaapi / libs / libs-GstVaapiPixmapX11.html

This file is indexed.

/usr/share/doc/gstreamer1.0-vaapi/libs/libs-GstVaapiPixmapX11.html is in gstreamer1.0-vaapi-doc 0.5.9-2.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GStreamer VA-API Plugins 1.4 Library Reference Manual: GstVaapiPixmapX11</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GStreamer VA-API Plugins 1.4 Library Reference Manual">
<link rel="up" href="ch01.html" title="gst-plugins-vaapi Library">
<link rel="prev" href="libs-GstVaapiPixmap.html" title="GstVaapiPixmap">
<link rel="next" href="libs-GstVaapiObject.html" title="GstVaapiObject">
<meta name="generator" content="GTK-Doc V1.21 (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="#libs-GstVaapiPixmapX11.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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libs-GstVaapiPixmap.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libs-GstVaapiObject.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libs-GstVaapiPixmapX11"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libs-GstVaapiPixmapX11.top_of_page"></a>GstVaapiPixmapX11</span></h2>
<p>GstVaapiPixmapX11 — X11 pixmap abstraction</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libs-GstVaapiPixmapX11.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="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="libs-GstVaapiPixmapX11.html#GST-VAAPI-PIXMAP-XPIXMAP:CAPS" title="GST_VAAPI_PIXMAP_XPIXMAP()">GST_VAAPI_PIXMAP_XPIXMAP</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libs-GstVaapiPixmap.html#GstVaapiPixmap" title="GstVaapiPixmap"><span class="returnvalue">GstVaapiPixmap</span></a> *
</td>
<td class="function_name">
<a class="link" href="libs-GstVaapiPixmapX11.html#gst-vaapi-pixmap-x11-new" title="gst_vaapi_pixmap_x11_new ()">gst_vaapi_pixmap_x11_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libs-GstVaapiPixmap.html#GstVaapiPixmap" title="GstVaapiPixmap"><span class="returnvalue">GstVaapiPixmap</span></a> *
</td>
<td class="function_name">
<a class="link" href="libs-GstVaapiPixmapX11.html#gst-vaapi-pixmap-x11-new-with-xid" title="gst_vaapi_pixmap_x11_new_with_xid ()">gst_vaapi_pixmap_x11_new_with_xid</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">Pixmap</span>
</td>
<td class="function_name">
<a class="link" href="libs-GstVaapiPixmapX11.html#gst-vaapi-pixmap-x11-get-xid" title="gst_vaapi_pixmap_x11_get_xid ()">gst_vaapi_pixmap_x11_get_xid</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="libs-GstVaapiPixmapX11.html#gst-vaapi-pixmap-x11-is-foreign-xid" title="gst_vaapi_pixmap_x11_is_foreign_xid ()">gst_vaapi_pixmap_x11_is_foreign_xid</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libs-GstVaapiPixmapX11.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"> </td>
<td class="function_name"><a class="link" href="libs-GstVaapiPixmapX11.html#GstVaapiPixmapX11" title="GstVaapiPixmapX11">GstVaapiPixmapX11</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libs-GstVaapiPixmapX11.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libs-GstVaapiPixmapX11.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="GST-VAAPI-PIXMAP-XPIXMAP:CAPS"></a><h3>GST_VAAPI_PIXMAP_XPIXMAP()</h3>
<pre class="programlisting">#define             GST_VAAPI_PIXMAP_XPIXMAP(pixmap)</pre>
<p>Macro that evaluates to the underlying X11 <span class="type">Pixmap</span> of <em class="parameter"><code>pixmap</code></em>
</p>
<div class="refsect3">
<a name="id-1.2.11.6.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>pixmap</p></td>
<td class="parameter_description"><p>a <a class="link" href="libs-GstVaapiPixmap.html#GstVaapiPixmap" title="GstVaapiPixmap"><span class="type">GstVaapiPixmap</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gst-vaapi-pixmap-x11-new"></a><h3>gst_vaapi_pixmap_x11_new ()</h3>
<pre class="programlisting"><a class="link" href="libs-GstVaapiPixmap.html#GstVaapiPixmap" title="GstVaapiPixmap"><span class="returnvalue">GstVaapiPixmap</span></a> *
gst_vaapi_pixmap_x11_new (<em class="parameter"><code><a class="link" href="libs-GstVaapiDisplay.html#GstVaapiDisplay" title="GstVaapiDisplay"><span class="type">GstVaapiDisplay</span></a> *display</code></em>,
                          <em class="parameter"><code><span class="type">GstVideoFormat</span> format</code></em>,
                          <em class="parameter"><code><span class="type">guint</span> width</code></em>,
                          <em class="parameter"><code><span class="type">guint</span> height</code></em>);</pre>
<p>Creates a pixmap with the specified <em class="parameter"><code>format</code></em>
, <em class="parameter"><code>width</code></em>
 and
<em class="parameter"><code>height</code></em>
. The pixmap will be attached to the <em class="parameter"><code>display</code></em>
.</p>
<div class="refsect3">
<a name="id-1.2.11.6.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>display</p></td>
<td class="parameter_description"><p>a <a class="link" href="libs-GstVaapiDisplay.html#GstVaapiDisplay" title="GstVaapiDisplay"><span class="type">GstVaapiDisplay</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>format</p></td>
<td class="parameter_description"><p>the requested pixmap format</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>the requested pixmap width, in pixels</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>the requested windo height, in pixels</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.11.6.3.6"></a><h4>Returns</h4>
<p> the newly allocated <a class="link" href="libs-GstVaapiPixmap.html#GstVaapiPixmap" title="GstVaapiPixmap"><span class="type">GstVaapiPixmap</span></a> object</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gst-vaapi-pixmap-x11-new-with-xid"></a><h3>gst_vaapi_pixmap_x11_new_with_xid ()</h3>
<pre class="programlisting"><a class="link" href="libs-GstVaapiPixmap.html#GstVaapiPixmap" title="GstVaapiPixmap"><span class="returnvalue">GstVaapiPixmap</span></a> *
gst_vaapi_pixmap_x11_new_with_xid (<em class="parameter"><code><a class="link" href="libs-GstVaapiDisplay.html#GstVaapiDisplay" title="GstVaapiDisplay"><span class="type">GstVaapiDisplay</span></a> *display</code></em>,
                                   <em class="parameter"><code><span class="type">Pixmap</span> xid</code></em>);</pre>
<p>Creates a <a class="link" href="libs-GstVaapiPixmap.html#GstVaapiPixmap" title="GstVaapiPixmap"><span class="type">GstVaapiPixmap</span></a> using the X11 Pixmap <em class="parameter"><code>xid</code></em>
. The caller
still owns the pixmap and must call <code class="function">XFreePixmap()</code> when all
<a class="link" href="libs-GstVaapiPixmap.html#GstVaapiPixmap" title="GstVaapiPixmap"><span class="type">GstVaapiPixmap</span></a> references are released. Doing so too early can
yield undefined behaviour.</p>
<div class="refsect3">
<a name="id-1.2.11.6.4.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>display</p></td>
<td class="parameter_description"><p>a <a class="link" href="libs-GstVaapiDisplay.html#GstVaapiDisplay" title="GstVaapiDisplay"><span class="type">GstVaapiDisplay</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>xid</p></td>
<td class="parameter_description"><p>an X11 <span class="type">Pixmap</span> id</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.11.6.4.6"></a><h4>Returns</h4>
<p> the newly allocated <a class="link" href="libs-GstVaapiPixmap.html#GstVaapiPixmap" title="GstVaapiPixmap"><span class="type">GstVaapiPixmap</span></a> object</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gst-vaapi-pixmap-x11-get-xid"></a><h3>gst_vaapi_pixmap_x11_get_xid ()</h3>
<pre class="programlisting"><span class="returnvalue">Pixmap</span>
gst_vaapi_pixmap_x11_get_xid (<em class="parameter"><code><a class="link" href="libs-GstVaapiPixmapX11.html#GstVaapiPixmapX11" title="GstVaapiPixmapX11"><span class="type">GstVaapiPixmapX11</span></a> *pixmap</code></em>);</pre>
<p>Returns the underlying X11 Pixmap that was created by
<a class="link" href="libs-GstVaapiPixmapX11.html#gst-vaapi-pixmap-x11-new" title="gst_vaapi_pixmap_x11_new ()"><code class="function">gst_vaapi_pixmap_x11_new()</code></a> or that was bound with
<a class="link" href="libs-GstVaapiPixmapX11.html#gst-vaapi-pixmap-x11-new-with-xid" title="gst_vaapi_pixmap_x11_new_with_xid ()"><code class="function">gst_vaapi_pixmap_x11_new_with_xid()</code></a>.</p>
<div class="refsect3">
<a name="id-1.2.11.6.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>pixmap</p></td>
<td class="parameter_description"><p>a <a class="link" href="libs-GstVaapiPixmapX11.html#GstVaapiPixmapX11" title="GstVaapiPixmapX11"><span class="type">GstVaapiPixmapX11</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.11.6.5.6"></a><h4>Returns</h4>
<p> the underlying X11 Pixmap bound to <em class="parameter"><code>pixmap</code></em>
.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gst-vaapi-pixmap-x11-is-foreign-xid"></a><h3>gst_vaapi_pixmap_x11_is_foreign_xid ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gst_vaapi_pixmap_x11_is_foreign_xid (<em class="parameter"><code><a class="link" href="libs-GstVaapiPixmapX11.html#GstVaapiPixmapX11" title="GstVaapiPixmapX11"><span class="type">GstVaapiPixmapX11</span></a> *pixmap</code></em>);</pre>
<p>Checks whether the <em class="parameter"><code>pixmap</code></em>
 XID was created by <a class="link" href="libs-GstVaapiPixmapX11.html#gst-vaapi-pixmap-x11-new" title="gst_vaapi_pixmap_x11_new ()"><code class="function">gst_vaapi_pixmap_x11_new()</code></a>
or was bound with <a class="link" href="libs-GstVaapiPixmapX11.html#gst-vaapi-pixmap-x11-new-with-xid" title="gst_vaapi_pixmap_x11_new_with_xid ()"><code class="function">gst_vaapi_pixmap_x11_new_with_xid()</code></a>.</p>
<div class="refsect3">
<a name="id-1.2.11.6.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>pixmap</p></td>
<td class="parameter_description"><p>a <a class="link" href="libs-GstVaapiPixmapX11.html#GstVaapiPixmapX11" title="GstVaapiPixmapX11"><span class="type">GstVaapiPixmapX11</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.11.6.6.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the underlying X pixmap is owned by the
caller (foreign pixmap)</p>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="libs-GstVaapiPixmapX11.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GstVaapiPixmapX11"></a><h3>GstVaapiPixmapX11</h3>
<pre class="programlisting">typedef struct _GstVaapiPixmapX11 GstVaapiPixmapX11;</pre>
<p>
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.21</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.