/usr/share/doc/gstreamer0.10-vaapi/libs/GstVaapiDisplayX11.html is in gstreamer0.10-vaapi-doc 0.3.6-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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GstVaapiDisplayX11</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GStreamer VA-API Plugins 0.10 Library Reference Manual">
<link rel="up" href="ch01.html" title="gst-plugins-vaapi Library">
<link rel="prev" href="GstVaapiDisplay.html" title="GstVaapiDisplay">
<link rel="next" href="GstVaapiDisplayGLX.html" title="GstVaapiDisplayGLX">
<meta name="generator" content="GTK-Doc V1.18 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="GstVaapiDisplay.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.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">GStreamer VA-API Plugins 0.10 Library Reference Manual</th>
<td><a accesskey="n" href="GstVaapiDisplayGLX.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GstVaapiDisplayX11.synopsis" class="shortcut">Top</a>
|
<a href="#GstVaapiDisplayX11.description" class="shortcut">Description</a>
|
<a href="#GstVaapiDisplayX11.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GstVaapiDisplayX11.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="GstVaapiDisplayX11"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GstVaapiDisplayX11.top_of_page"></a>GstVaapiDisplayX11</span></h2>
<p>GstVaapiDisplayX11 — VA/X11 display abstraction</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GstVaapiDisplayX11.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="GstVaapiDisplayX11.html#GstVaapiDisplayX11-struct" title="struct GstVaapiDisplayX11">GstVaapiDisplayX11</a>;
struct <a class="link" href="GstVaapiDisplayX11.html#GstVaapiDisplayX11Class" title="struct GstVaapiDisplayX11Class">GstVaapiDisplayX11Class</a>;
<a class="link" href="GstVaapiDisplay.html" title="GstVaapiDisplay"><span class="returnvalue">GstVaapiDisplay</span></a> * <a class="link" href="GstVaapiDisplayX11.html#gst-vaapi-display-x11-new" title="gst_vaapi_display_x11_new ()">gst_vaapi_display_x11_new</a> (<em class="parameter"><code>const <span class="type">gchar</span> *display_name</code></em>);
<a class="link" href="GstVaapiDisplay.html" title="GstVaapiDisplay"><span class="returnvalue">GstVaapiDisplay</span></a> * <a class="link" href="GstVaapiDisplayX11.html#gst-vaapi-display-x11-new-with-display" title="gst_vaapi_display_x11_new_with_display ()">gst_vaapi_display_x11_new_with_display</a>
(<em class="parameter"><code><span class="type">Display</span> *x11_display</code></em>);
<span class="returnvalue">Display</span> * <a class="link" href="GstVaapiDisplayX11.html#gst-vaapi-display-x11-get-display" title="gst_vaapi_display_x11_get_display ()">gst_vaapi_display_x11_get_display</a> (<em class="parameter"><code><a class="link" href="GstVaapiDisplayX11.html" title="GstVaapiDisplayX11"><span class="type">GstVaapiDisplayX11</span></a> *display</code></em>);
<span class="returnvalue">int</span> <a class="link" href="GstVaapiDisplayX11.html#gst-vaapi-display-x11-get-screen" title="gst_vaapi_display_x11_get_screen ()">gst_vaapi_display_x11_get_screen</a> (<em class="parameter"><code><a class="link" href="GstVaapiDisplayX11.html" title="GstVaapiDisplayX11"><span class="type">GstVaapiDisplayX11</span></a> *display</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GstVaapiDisplayX11.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----<a class="link" href="GstVaapiDisplay.html" title="GstVaapiDisplay">GstVaapiDisplay</a>
+----GstVaapiDisplayX11
+----<a class="link" href="GstVaapiDisplayGLX.html" title="GstVaapiDisplayGLX">GstVaapiDisplayGLX</a>
</pre>
</div>
<div class="refsect1">
<a name="GstVaapiDisplayX11.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GstVaapiDisplayX11.html#GstVaapiDisplayX11--display-name" title='The "display-name" property'>display-name</a>" <span class="type">gchar</span>* : Read / Write / Construct Only
"<a class="link" href="GstVaapiDisplayX11.html#GstVaapiDisplayX11--synchronous" title='The "synchronous" property'>synchronous</a>" <span class="type">gboolean</span> : Read / Write
"<a class="link" href="GstVaapiDisplayX11.html#GstVaapiDisplayX11--x11-display" title='The "x11-display" property'>x11-display</a>" <span class="type">gpointer</span> : Read / Write / Construct Only
"<a class="link" href="GstVaapiDisplayX11.html#GstVaapiDisplayX11--x11-screen" title='The "x11-screen" property'>x11-screen</a>" <span class="type">gint</span> : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1">
<a name="GstVaapiDisplayX11.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="GstVaapiDisplayX11.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GstVaapiDisplayX11-struct"></a><h3>struct GstVaapiDisplayX11</h3>
<pre class="programlisting">struct GstVaapiDisplayX11;</pre>
<p>
VA/X11 display wrapper.
</p>
</div>
<hr>
<div class="refsect2">
<a name="GstVaapiDisplayX11Class"></a><h3>struct GstVaapiDisplayX11Class</h3>
<pre class="programlisting">struct GstVaapiDisplayX11Class {
};
</pre>
<p>
VA/X11 display wrapper clas.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-vaapi-display-x11-new"></a><h3>gst_vaapi_display_x11_new ()</h3>
<pre class="programlisting"><a class="link" href="GstVaapiDisplay.html" title="GstVaapiDisplay"><span class="returnvalue">GstVaapiDisplay</span></a> * gst_vaapi_display_x11_new (<em class="parameter"><code>const <span class="type">gchar</span> *display_name</code></em>);</pre>
<p>
Opens an X11 <span class="type">Display</span> using <em class="parameter"><code>display_name</code></em> and returns a newly
allocated <a class="link" href="GstVaapiDisplay.html" title="GstVaapiDisplay"><span class="type">GstVaapiDisplay</span></a> object. The X11 display will be cloed
when the reference count of the object reaches zero.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>display_name</code></em> :</span></p></td>
<td>the X11 display name</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly allocated <a class="link" href="GstVaapiDisplay.html" title="GstVaapiDisplay"><span class="type">GstVaapiDisplay</span></a> object</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gst-vaapi-display-x11-new-with-display"></a><h3>gst_vaapi_display_x11_new_with_display ()</h3>
<pre class="programlisting"><a class="link" href="GstVaapiDisplay.html" title="GstVaapiDisplay"><span class="returnvalue">GstVaapiDisplay</span></a> * gst_vaapi_display_x11_new_with_display
(<em class="parameter"><code><span class="type">Display</span> *x11_display</code></em>);</pre>
<p>
Creates a <a class="link" href="GstVaapiDisplay.html" title="GstVaapiDisplay"><span class="type">GstVaapiDisplay</span></a> based on the X11 <em class="parameter"><code>x11_display</code></em>
display. The caller still owns the display and must call
<code class="function">XCloseDisplay()</code> when all <a class="link" href="GstVaapiDisplay.html" title="GstVaapiDisplay"><span class="type">GstVaapiDisplay</span></a> references are
released. Doing so too early can yield undefined behaviour.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>x11_display</code></em> :</span></p></td>
<td>an X11 <span class="type">Display</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly allocated <a class="link" href="GstVaapiDisplay.html" title="GstVaapiDisplay"><span class="type">GstVaapiDisplay</span></a> object</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gst-vaapi-display-x11-get-display"></a><h3>gst_vaapi_display_x11_get_display ()</h3>
<pre class="programlisting"><span class="returnvalue">Display</span> * gst_vaapi_display_x11_get_display (<em class="parameter"><code><a class="link" href="GstVaapiDisplayX11.html" title="GstVaapiDisplayX11"><span class="type">GstVaapiDisplayX11</span></a> *display</code></em>);</pre>
<p>
Returns the underlying X11 <span class="type">Display</span> that was created by
<a class="link" href="GstVaapiDisplayX11.html#gst-vaapi-display-x11-new" title="gst_vaapi_display_x11_new ()"><code class="function">gst_vaapi_display_x11_new()</code></a> or that was bound from
<a class="link" href="GstVaapiDisplayX11.html#gst-vaapi-display-x11-new-with-display" title="gst_vaapi_display_x11_new_with_display ()"><code class="function">gst_vaapi_display_x11_new_with_display()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>display</code></em> :</span></p></td>
<td>a <a class="link" href="GstVaapiDisplayX11.html" title="GstVaapiDisplayX11"><span class="type">GstVaapiDisplayX11</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the X11 <span class="type">Display</span> attached to <em class="parameter"><code>display</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gst-vaapi-display-x11-get-screen"></a><h3>gst_vaapi_display_x11_get_screen ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> gst_vaapi_display_x11_get_screen (<em class="parameter"><code><a class="link" href="GstVaapiDisplayX11.html" title="GstVaapiDisplayX11"><span class="type">GstVaapiDisplayX11</span></a> *display</code></em>);</pre>
<p>
Returns the default X11 screen that was created by
<a class="link" href="GstVaapiDisplayX11.html#gst-vaapi-display-x11-new" title="gst_vaapi_display_x11_new ()"><code class="function">gst_vaapi_display_x11_new()</code></a> or that was bound from
<a class="link" href="GstVaapiDisplayX11.html#gst-vaapi-display-x11-new-with-display" title="gst_vaapi_display_x11_new_with_display ()"><code class="function">gst_vaapi_display_x11_new_with_display()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>display</code></em> :</span></p></td>
<td>a <a class="link" href="GstVaapiDisplayX11.html" title="GstVaapiDisplayX11"><span class="type">GstVaapiDisplayX11</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the X11 <span class="type">Display</span> attached to <em class="parameter"><code>display</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="GstVaapiDisplayX11.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GstVaapiDisplayX11--display-name"></a><h3>The <code class="literal">"display-name"</code> property</h3>
<pre class="programlisting"> "display-name" <span class="type">gchar</span>* : Read / Write / Construct Only</pre>
<p>
The X11 display name.
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GstVaapiDisplayX11--synchronous"></a><h3>The <code class="literal">"synchronous"</code> property</h3>
<pre class="programlisting"> "synchronous" <span class="type">gboolean</span> : Read / Write</pre>
<p>
When enabled, runs the X display in synchronous mode. Note that
this is used only for debugging.
</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GstVaapiDisplayX11--x11-display"></a><h3>The <code class="literal">"x11-display"</code> property</h3>
<pre class="programlisting"> "x11-display" <span class="type">gpointer</span> : Read / Write / Construct Only</pre>
<p>
The X11 <span class="type">Display</span> that was created by <a class="link" href="GstVaapiDisplayX11.html#gst-vaapi-display-x11-new" title="gst_vaapi_display_x11_new ()"><code class="function">gst_vaapi_display_x11_new()</code></a>
or that was bound from <a class="link" href="GstVaapiDisplayX11.html#gst-vaapi-display-x11-new-with-display" title="gst_vaapi_display_x11_new_with_display ()"><code class="function">gst_vaapi_display_x11_new_with_display()</code></a>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="GstVaapiDisplayX11--x11-screen"></a><h3>The <code class="literal">"x11-screen"</code> property</h3>
<pre class="programlisting"> "x11-screen" <span class="type">gint</span> : Read / Write / Construct Only</pre>
<p>
The X11 screen that was created by <a class="link" href="GstVaapiDisplayX11.html#gst-vaapi-display-x11-new" title="gst_vaapi_display_x11_new ()"><code class="function">gst_vaapi_display_x11_new()</code></a>
or that was bound from <a class="link" href="GstVaapiDisplayX11.html#gst-vaapi-display-x11-new-with-display" title="gst_vaapi_display_x11_new_with_display ()"><code class="function">gst_vaapi_display_x11_new_with_display()</code></a>.
</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|