gstreamer0.10-plugins-bad-doc 0.10.23-7.2ubuntu1 / usr / share / gtk-doc / html / gst-plugins-bad-libs-0.10 / gst-plugins-bad-libs-GstSurfaceBuffer.html

This file is indexed.

/usr/share/gtk-doc/html/gst-plugins-bad-libs-0.10/gst-plugins-bad-libs-GstSurfaceBuffer.html is in gstreamer0.10-plugins-bad-doc 0.10.23-7.2ubuntu1.

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
<!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 Bad Plugins 0.10 Library Reference Manual: GstSurfaceBuffer</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GStreamer Bad Plugins 0.10 Library Reference Manual">
<link rel="up" href="video.html" title="Base video element classes">
<link rel="prev" href="gst-plugins-bad-libs-GstVideoContextInterface.html" title="GstVideoContextInterface">
<link rel="next" href="gst-plugins-bad-libs-GstSurfaceConverter.html" title="GstSurfaceConverter">
<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="#gst-plugins-bad-libs-GstSurfaceBuffer.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
                  <a href="#gst-plugins-bad-libs-GstSurfaceBuffer.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="video.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gst-plugins-bad-libs-GstVideoContextInterface.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gst-plugins-bad-libs-GstSurfaceConverter.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gst-plugins-bad-libs-GstSurfaceBuffer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gst-plugins-bad-libs-GstSurfaceBuffer.top_of_page"></a>GstSurfaceBuffer</span></h2>
<p>GstSurfaceBuffer — Accelerated surface base class</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gst-plugins-bad-libs-GstSurfaceBuffer.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 href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>
</td>
<td class="function_name">
<a class="link" href="gst-plugins-bad-libs-GstSurfaceBuffer.html#gst-surface-buffer-get-type" title="gst_surface_buffer_get_type ()">gst_surface_buffer_get_type</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="gst-plugins-bad-libs-GstSurfaceConverter.html#GstSurfaceConverter" title="GstSurfaceConverter"><span class="returnvalue">GstSurfaceConverter</span></a> *
</td>
<td class="function_name">
<a class="link" href="gst-plugins-bad-libs-GstSurfaceBuffer.html#gst-surface-buffer-create-converter" title="gst_surface_buffer_create_converter ()">gst_surface_buffer_create_converter</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-libs-GstSurfaceBuffer.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="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gst-plugins-bad-libs-GstSurfaceBuffer.html#GST-VIDEO-CAPS-SURFACE:CAPS" title="GST_VIDEO_CAPS_SURFACE">GST_VIDEO_CAPS_SURFACE</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="gst-plugins-bad-libs-GstSurfaceBuffer.html#GstSurfaceBuffer" title="GstSurfaceBuffer">GstSurfaceBuffer</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="gst-plugins-bad-libs-GstSurfaceBuffer.html#GstSurfaceBufferClass" title="struct GstSurfaceBufferClass">GstSurfaceBufferClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-libs-GstSurfaceBuffer.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-libs-GstSurfaceBuffer.description"></a><h2>Description</h2>
<p>This base class is used to abstract hardware accelerated buffers and enable
generic convertion to standard type such as GL textures. The media type for
those buffers is defined by <a class="link" href="gst-plugins-bad-libs-GstSurfaceBuffer.html#GST-VIDEO-CAPS-SURFACE:CAPS" title="GST_VIDEO_CAPS_SURFACE"><span class="type">GST_VIDEO_CAPS_SURFACE</span></a>. An implementation
specific type must be set using the "type" key (e.g. type="vaapi").
Available convertion type are speficied using seperate boolean
arguement (e.g. opengl=true). Having this information in the capabilities
allow easy negotiating of such feature with other elements (e.g. a
ClutterGstVideoSink can claim accpeting caps "video/x-surface,opengl=true").</p>
<div class="note">
  The GstVideoContext interface is unstable API and may change in future.
  One can define GST_USE_UNSTABLE_API to acknowledge and avoid this warning.
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-libs-GstSurfaceBuffer.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gst-surface-buffer-get-type"></a><h3>gst_surface_buffer_get_type ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>
gst_surface_buffer_get_type (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gst-surface-buffer-create-converter"></a><h3>gst_surface_buffer_create_converter ()</h3>
<pre class="programlisting"><a class="link" href="gst-plugins-bad-libs-GstSurfaceConverter.html#GstSurfaceConverter" title="GstSurfaceConverter"><span class="returnvalue">GstSurfaceConverter</span></a> *
gst_surface_buffer_create_converter (<em class="parameter"><code><a class="link" href="gst-plugins-bad-libs-GstSurfaceBuffer.html#GstSurfaceBuffer" title="GstSurfaceBuffer"><span class="type">GstSurfaceBuffer</span></a> *buffer</code></em>,
                                     <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *type</code></em>,
                                     <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *dest</code></em>);</pre>
<p>This method is used to create a type specific converter. The converter will
serve as context to accelerate the data convertion. This converter object
shall be discarded when the pipeline state changes to NULL and renewed when
caps are changed.</p>
<div class="refsect3">
<a name="id-1.2.5.7.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>buffer</p></td>
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-bad-libs-GstSurfaceBuffer.html#GstSurfaceBuffer" title="GstSurfaceBuffer"><span class="type">GstSurfaceBuffer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type</p></td>
<td class="parameter_description"><p>the type to convert to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>dest</p></td>
<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> containing the destination to upload</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.5.7.7.3.6"></a><h4>Returns</h4>
<p> newly allocated <a class="link" href="gst-plugins-bad-libs-GstSurfaceConverter.html#GstSurfaceConverter" title="GstSurfaceConverter"><span class="type">GstSurfaceConverter</span></a></p>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-libs-GstSurfaceBuffer.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GST-VIDEO-CAPS-SURFACE:CAPS"></a><h3>GST_VIDEO_CAPS_SURFACE</h3>
<pre class="programlisting">#define GST_VIDEO_CAPS_SURFACE "video/x-surface"
</pre>
<p>Base caps for GstSurfaceBuffer. Implementation specific type must be marked
using the type attribute (e.g. type=vaapi). Available convertion shall be
specified using boolean attributes (e.g. opengl=true).</p>
</div>
<hr>
<div class="refsect2">
<a name="GstSurfaceBuffer"></a><h3>GstSurfaceBuffer</h3>
<pre class="programlisting">typedef struct {
  GstBuffer parent;
} GstSurfaceBuffer;
</pre>
<div class="refsect3">
<a name="id-1.2.5.7.8.3.4"></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><a href="/usr/share/gtk-doc/html/gstreamer-0.10/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> <em class="structfield"><code><a name="GstSurfaceBuffer.parent"></a>parent</code></em>;</p></td>
<td class="struct_member_description"><p>parent object</p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="GstSurfaceBufferClass"></a><h3>struct GstSurfaceBufferClass</h3>
<pre class="programlisting">struct GstSurfaceBufferClass {
  GstBufferClass parent_class;

  GstSurfaceConverter * (*create_converter) (GstSurfaceBuffer *buffer,
                                             const gchar *type,
                                             GValue *dest);
};
</pre>
<p><a class="link" href="gst-plugins-bad-libs-GstVideoContextInterface.html#GstVideoContextInterface" title="struct GstVideoContextInterface"><span class="type">GstVideoContextInterface</span></a> interface.</p>
<div class="refsect3">
<a name="id-1.2.5.7.8.4.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><span class="type">GstBufferClass</span> <em class="structfield"><code><a name="GstSurfaceBufferClass.parent-class"></a>parent_class</code></em>;</p></td>
<td class="struct_member_description"><p>parent class type.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstSurfaceBufferClass.create-converter"></a>create_converter</code></em> ()</p></td>
<td class="struct_member_description"><p>vmethod to create a converter.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.20</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.