33
30
<h2><span class="refentrytitle"><a name="libs-GstVaapiSubpicture.top_of_page"></a>GstVaapiSubpicture</span></h2>
34
31
<p>GstVaapiSubpicture — VA subpicture abstraction</p>
36
<td valign="top" align="right"></td>
33
<td class="gallery_image" valign="top" align="right"></td>
37
34
</tr></table></div>
38
<div class="refsynopsisdiv">
39
<a name="libs-GstVaapiSubpicture.synopsis"></a><h2>Synopsis</h2>
40
<pre class="synopsis"> <a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture">GstVaapiSubpicture</a>;
41
<a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="returnvalue">GstVaapiSubpicture</span></a> * <a class="link" href="libs-GstVaapiSubpicture.html#gst-vaapi-subpicture-new" title="gst_vaapi_subpicture_new ()">gst_vaapi_subpicture_new</a> (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>,
42
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> flags</code></em>);
43
<a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="returnvalue">GstVaapiSubpicture</span></a> * <a class="link" href="libs-GstVaapiSubpicture.html#gst-vaapi-subpicture-new-from-overlay-rectangle" title="gst_vaapi_subpicture_new_from_overlay_rectangle ()">gst_vaapi_subpicture_new_from_overlay_rectangle</a>
44
(<em class="parameter"><code><a class="link" href="libs-GstVaapiDisplay.html#GstVaapiDisplay" title="GstVaapiDisplay"><span class="type">GstVaapiDisplay</span></a> *display</code></em>,
45
<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rect</code></em>);
46
<a class="link" href="libs-Basic-data-structures.html#GstVaapiID" title="GstVaapiID"><span class="returnvalue">GstVaapiID</span></a> <a class="link" href="libs-GstVaapiSubpicture.html#gst-vaapi-subpicture-get-id" title="gst_vaapi_subpicture_get_id ()">gst_vaapi_subpicture_get_id</a> (<em class="parameter"><code><a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a> *subpicture</code></em>);
47
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> <a class="link" href="libs-GstVaapiSubpicture.html#gst-vaapi-subpicture-get-flags" title="gst_vaapi_subpicture_get_flags ()">gst_vaapi_subpicture_get_flags</a> (<em class="parameter"><code><a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a> *subpicture</code></em>);
48
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a> <a class="link" href="libs-GstVaapiSubpicture.html#gst-vaapi-subpicture-get-global-alpha" title="gst_vaapi_subpicture_get_global_alpha ()">gst_vaapi_subpicture_get_global_alpha</a>
49
(<em class="parameter"><code><a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a> *subpicture</code></em>);
50
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libs-GstVaapiSubpicture.html#gst-vaapi-subpicture-set-global-alpha" title="gst_vaapi_subpicture_set_global_alpha ()">gst_vaapi_subpicture_set_global_alpha</a>
51
(<em class="parameter"><code><a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a> *subpicture</code></em>,
52
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> global_alpha</code></em>);
53
<a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="returnvalue">GstVaapiImage</span></a> * <a class="link" href="libs-GstVaapiSubpicture.html#gst-vaapi-subpicture-get-image" title="gst_vaapi_subpicture_get_image ()">gst_vaapi_subpicture_get_image</a> (<em class="parameter"><code><a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a> *subpicture</code></em>);
54
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libs-GstVaapiSubpicture.html#gst-vaapi-subpicture-set-image" title="gst_vaapi_subpicture_set_image ()">gst_vaapi_subpicture_set_image</a> (<em class="parameter"><code><a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a> *subpicture</code></em>,
55
<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);
35
<div class="refsect1">
36
<a name="libs-GstVaapiSubpicture.functions"></a><h2>Functions</h2>
37
<div class="informaltable"><table width="100%" border="0">
39
<col width="150px" class="functions_return">
40
<col class="functions_name">
44
<td class="function_type">
45
<a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="returnvalue">GstVaapiSubpicture</span></a> *
47
<td class="function_name">
48
<a class="link" href="libs-GstVaapiSubpicture.html#gst-vaapi-subpicture-new" title="gst_vaapi_subpicture_new ()">gst_vaapi_subpicture_new</a> <span class="c_punctuation">()</span>
52
<td class="function_type">
53
<a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="returnvalue">GstVaapiSubpicture</span></a> *
55
<td class="function_name">
56
<a class="link" href="libs-GstVaapiSubpicture.html#gst-vaapi-subpicture-new-from-overlay-rectangle" title="gst_vaapi_subpicture_new_from_overlay_rectangle ()">gst_vaapi_subpicture_new_from_overlay_rectangle</a> <span class="c_punctuation">()</span>
60
<td class="function_type">
61
<a class="link" href="libs-Basic-data-structures.html#GstVaapiID" title="GstVaapiID"><span class="returnvalue">GstVaapiID</span></a>
63
<td class="function_name">
64
<a class="link" href="libs-GstVaapiSubpicture.html#gst-vaapi-subpicture-get-id" title="gst_vaapi_subpicture_get_id ()">gst_vaapi_subpicture_get_id</a> <span class="c_punctuation">()</span>
68
<td class="function_type">
69
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
71
<td class="function_name">
72
<a class="link" href="libs-GstVaapiSubpicture.html#gst-vaapi-subpicture-get-flags" title="gst_vaapi_subpicture_get_flags ()">gst_vaapi_subpicture_get_flags</a> <span class="c_punctuation">()</span>
76
<td class="function_type">
77
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a>
79
<td class="function_name">
80
<a class="link" href="libs-GstVaapiSubpicture.html#gst-vaapi-subpicture-get-global-alpha" title="gst_vaapi_subpicture_get_global_alpha ()">gst_vaapi_subpicture_get_global_alpha</a> <span class="c_punctuation">()</span>
84
<td class="function_type">
85
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
87
<td class="function_name">
88
<a class="link" href="libs-GstVaapiSubpicture.html#gst-vaapi-subpicture-set-global-alpha" title="gst_vaapi_subpicture_set_global_alpha ()">gst_vaapi_subpicture_set_global_alpha</a> <span class="c_punctuation">()</span>
92
<td class="function_type">
93
<a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="returnvalue">GstVaapiImage</span></a> *
95
<td class="function_name">
96
<a class="link" href="libs-GstVaapiSubpicture.html#gst-vaapi-subpicture-get-image" title="gst_vaapi_subpicture_get_image ()">gst_vaapi_subpicture_get_image</a> <span class="c_punctuation">()</span>
100
<td class="function_type">
101
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
103
<td class="function_name">
104
<a class="link" href="libs-GstVaapiSubpicture.html#gst-vaapi-subpicture-set-image" title="gst_vaapi_subpicture_set_image ()">gst_vaapi_subpicture_set_image</a> <span class="c_punctuation">()</span>
110
<div class="refsect1">
111
<a name="libs-GstVaapiSubpicture.other"></a><h2>Types and Values</h2>
112
<div class="informaltable"><table width="100%" border="0">
114
<col width="150px" class="name">
115
<col class="description">
118
<td class="datatype_keyword"> </td>
119
<td class="function_name"><a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture">GstVaapiSubpicture</a></td>
123
<div class="refsect1">
124
<a name="libs-GstVaapiSubpicture.object-hierarchy"></a><h2>Object Hierarchy</h2>
58
128
<div class="refsect1">
59
129
<a name="libs-GstVaapiSubpicture.description"></a><h2>Description</h2>
61
131
<div class="refsect1">
62
<a name="libs-GstVaapiSubpicture.details"></a><h2>Details</h2>
132
<a name="libs-GstVaapiSubpicture.functions_details"></a><h2>Functions</h2>
133
<div class="refsect2">
134
<a name="gst-vaapi-subpicture-new"></a><h3>gst_vaapi_subpicture_new ()</h3>
135
<pre class="programlisting"><a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="returnvalue">GstVaapiSubpicture</span></a> *
136
gst_vaapi_subpicture_new (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>,
137
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> flags</code></em>);</pre>
138
<p>Creates a new <a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a> with <em class="parameter"><code>image</code></em>
139
as source pixels. The
140
newly created object holds a reference on <em class="parameter"><code>image</code></em>
142
<div class="refsect3">
143
<a name="id-1.2.15.7.2.5"></a><h4>Parameters</h4>
144
<div class="informaltable"><table width="100%" border="0">
146
<col width="150px" class="parameters_name">
147
<col class="parameters_description">
148
<col width="200px" class="parameters_annotations">
152
<td class="parameter_name"><p>image</p></td>
153
<td class="parameter_description"><p>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a></p></td>
154
<td class="parameter_annotations"> </td>
157
<td class="parameter_name"><p>flags</p></td>
158
<td class="parameter_description"><p><span class="type">GstVaapiSubpictureFlags</span>, or zero</p></td>
159
<td class="parameter_annotations"> </td>
164
<div class="refsect3">
165
<a name="id-1.2.15.7.2.6"></a><h4>Returns</h4>
166
<p> the newly allocated <a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a> object</p>
171
<div class="refsect2">
172
<a name="gst-vaapi-subpicture-new-from-overlay-rectangle"></a><h3>gst_vaapi_subpicture_new_from_overlay_rectangle ()</h3>
173
<pre class="programlisting"><a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="returnvalue">GstVaapiSubpicture</span></a> *
174
gst_vaapi_subpicture_new_from_overlay_rectangle
175
(<em class="parameter"><code><a class="link" href="libs-GstVaapiDisplay.html#GstVaapiDisplay" title="GstVaapiDisplay"><span class="type">GstVaapiDisplay</span></a> *display</code></em>,
176
<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rect</code></em>);</pre>
177
<p>Helper function that creates a new <a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a> from a
178
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a>. A new <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> is also created
179
along the way and attached to the resulting subpicture. The
180
subpicture holds a unique reference to the underlying image.</p>
181
<div class="refsect3">
182
<a name="id-1.2.15.7.3.5"></a><h4>Parameters</h4>
183
<div class="informaltable"><table width="100%" border="0">
185
<col width="150px" class="parameters_name">
186
<col class="parameters_description">
187
<col width="200px" class="parameters_annotations">
191
<td class="parameter_name"><p>display</p></td>
192
<td class="parameter_description"><p>a <a class="link" href="libs-GstVaapiDisplay.html#GstVaapiDisplay" title="GstVaapiDisplay"><span class="type">GstVaapiDisplay</span></a></p></td>
193
<td class="parameter_annotations"> </td>
196
<td class="parameter_name"><p>rect</p></td>
197
<td class="parameter_description"><p>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a></p></td>
198
<td class="parameter_annotations"> </td>
203
<div class="refsect3">
204
<a name="id-1.2.15.7.3.6"></a><h4>Returns</h4>
205
<p> the newly allocated <a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a> object</p>
210
<div class="refsect2">
211
<a name="gst-vaapi-subpicture-get-id"></a><h3>gst_vaapi_subpicture_get_id ()</h3>
212
<pre class="programlisting"><a class="link" href="libs-Basic-data-structures.html#GstVaapiID" title="GstVaapiID"><span class="returnvalue">GstVaapiID</span></a>
213
gst_vaapi_subpicture_get_id (<em class="parameter"><code><a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a> *subpicture</code></em>);</pre>
214
<p>Returns the underlying VASubpictureID of the <em class="parameter"><code>subpicture</code></em>
216
<div class="refsect3">
217
<a name="id-1.2.15.7.4.5"></a><h4>Parameters</h4>
218
<div class="informaltable"><table width="100%" border="0">
220
<col width="150px" class="parameters_name">
221
<col class="parameters_description">
222
<col width="200px" class="parameters_annotations">
225
<td class="parameter_name"><p>subpicture</p></td>
226
<td class="parameter_description"><p>a <a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a></p></td>
227
<td class="parameter_annotations"> </td>
231
<div class="refsect3">
232
<a name="id-1.2.15.7.4.6"></a><h4>Returns</h4>
233
<p> the underlying VA subpicture id</p>
238
<div class="refsect2">
239
<a name="gst-vaapi-subpicture-get-flags"></a><h3>gst_vaapi_subpicture_get_flags ()</h3>
240
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
241
gst_vaapi_subpicture_get_flags (<em class="parameter"><code><a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a> *subpicture</code></em>);</pre>
242
<p>Returns the <em class="parameter"><code>subpicture</code></em>
244
<div class="refsect3">
245
<a name="id-1.2.15.7.5.5"></a><h4>Parameters</h4>
246
<div class="informaltable"><table width="100%" border="0">
248
<col width="150px" class="parameters_name">
249
<col class="parameters_description">
250
<col width="200px" class="parameters_annotations">
253
<td class="parameter_name"><p>subpicture</p></td>
254
<td class="parameter_description"><p>a <a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a></p></td>
255
<td class="parameter_annotations"> </td>
259
<div class="refsect3">
260
<a name="id-1.2.15.7.5.6"></a><h4>Returns</h4>
261
<p> the <em class="parameter"><code>subpicture</code></em>
267
<div class="refsect2">
268
<a name="gst-vaapi-subpicture-get-global-alpha"></a><h3>gst_vaapi_subpicture_get_global_alpha ()</h3>
269
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a>
270
gst_vaapi_subpicture_get_global_alpha (<em class="parameter"><code><a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a> *subpicture</code></em>);</pre>
271
<p>Returns the value of global_alpha, set for this <em class="parameter"><code>subpicture</code></em>
273
<div class="refsect3">
274
<a name="id-1.2.15.7.6.5"></a><h4>Parameters</h4>
275
<div class="informaltable"><table width="100%" border="0">
277
<col width="150px" class="parameters_name">
278
<col class="parameters_description">
279
<col width="200px" class="parameters_annotations">
282
<td class="parameter_name"><p>subpicture</p></td>
283
<td class="parameter_description"><p>a <a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a></p></td>
284
<td class="parameter_annotations"> </td>
288
<div class="refsect3">
289
<a name="id-1.2.15.7.6.6"></a><h4>Returns</h4>
290
<p> the global_alpha value of this <em class="parameter"><code>subpicture</code></em>
296
<div class="refsect2">
297
<a name="gst-vaapi-subpicture-set-global-alpha"></a><h3>gst_vaapi_subpicture_set_global_alpha ()</h3>
298
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
299
gst_vaapi_subpicture_set_global_alpha (<em class="parameter"><code><a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a> *subpicture</code></em>,
300
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> global_alpha</code></em>);</pre>
301
<p>Sets the global_alpha value of <em class="parameter"><code>subpicture</code></em>
302
. This function calls
303
<code class="function">vaSetSubpictureGlobalAlpha()</code> if the format of <em class="parameter"><code>subpicture</code></em>
305
the current VA driver supports it.</p>
306
<div class="refsect3">
307
<a name="id-1.2.15.7.7.5"></a><h4>Parameters</h4>
308
<div class="informaltable"><table width="100%" border="0">
310
<col width="150px" class="parameters_name">
311
<col class="parameters_description">
312
<col width="200px" class="parameters_annotations">
316
<td class="parameter_name"><p>subpicture</p></td>
317
<td class="parameter_description"><p>a <a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a></p></td>
318
<td class="parameter_annotations"> </td>
321
<td class="parameter_name"><p>global_alpha</p></td>
322
<td class="parameter_description"><p>value for global-alpha (range: 0.0 to 1.0, inclusive)</p></td>
323
<td class="parameter_annotations"> </td>
328
<div class="refsect3">
329
<a name="id-1.2.15.7.7.6"></a><h4>Returns</h4>
330
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if global_alpha could be set, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</p>
335
<div class="refsect2">
336
<a name="gst-vaapi-subpicture-get-image"></a><h3>gst_vaapi_subpicture_get_image ()</h3>
337
<pre class="programlisting"><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="returnvalue">GstVaapiImage</span></a> *
338
gst_vaapi_subpicture_get_image (<em class="parameter"><code><a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a> *subpicture</code></em>);</pre>
339
<p>Returns the <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> this <em class="parameter"><code>subpicture</code></em>
341
<div class="refsect3">
342
<a name="id-1.2.15.7.8.5"></a><h4>Parameters</h4>
343
<div class="informaltable"><table width="100%" border="0">
345
<col width="150px" class="parameters_name">
346
<col class="parameters_description">
347
<col width="200px" class="parameters_annotations">
350
<td class="parameter_name"><p>subpicture</p></td>
351
<td class="parameter_description"><p>a <a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a></p></td>
352
<td class="parameter_annotations"> </td>
356
<div class="refsect3">
357
<a name="id-1.2.15.7.8.6"></a><h4>Returns</h4>
358
<p> the <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> this <em class="parameter"><code>subpicture</code></em>
364
<div class="refsect2">
365
<a name="gst-vaapi-subpicture-set-image"></a><h3>gst_vaapi_subpicture_set_image ()</h3>
366
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
367
gst_vaapi_subpicture_set_image (<em class="parameter"><code><a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a> *subpicture</code></em>,
368
<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);</pre>
369
<p>Binds a new <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> to the <em class="parameter"><code>subpicture</code></em>
370
. The reference to the
371
previous image is released and a new one is acquired on <em class="parameter"><code>image</code></em>
373
<div class="refsect3">
374
<a name="id-1.2.15.7.9.5"></a><h4>Parameters</h4>
375
<div class="informaltable"><table width="100%" border="0">
377
<col width="150px" class="parameters_name">
378
<col class="parameters_description">
379
<col width="200px" class="parameters_annotations">
383
<td class="parameter_name"><p>subpicture</p></td>
384
<td class="parameter_description"><p>a <a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a></p></td>
385
<td class="parameter_annotations"> </td>
388
<td class="parameter_name"><p>image</p></td>
389
<td class="parameter_description"><p>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a></p></td>
390
<td class="parameter_annotations"> </td>
395
<div class="refsect3">
396
<a name="id-1.2.15.7.9.6"></a><h4>Returns</h4>
397
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success</p>
402
<div class="refsect1">
403
<a name="libs-GstVaapiSubpicture.other_details"></a><h2>Types and Values</h2>
63
404
<div class="refsect2">
64
405
<a name="GstVaapiSubpicture"></a><h3>GstVaapiSubpicture</h3>
65
406
<pre class="programlisting">typedef struct _GstVaapiSubpicture GstVaapiSubpicture;</pre>
67
A VA subpicture wrapper
71
<div class="refsect2">
72
<a name="gst-vaapi-subpicture-new"></a><h3>gst_vaapi_subpicture_new ()</h3>
73
<pre class="programlisting"><a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="returnvalue">GstVaapiSubpicture</span></a> * gst_vaapi_subpicture_new (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>,
74
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> flags</code></em>);</pre>
76
Creates a new <a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a> with <em class="parameter"><code>image</code></em> as source pixels. The
77
newly created object holds a reference on <em class="parameter"><code>image</code></em>.
79
<div class="variablelist"><table border="0" class="variablelist">
81
<col align="left" valign="top">
86
<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td>
87
<td>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a>
91
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
93
<span class="type">GstVaapiSubpictureFlags</span>, or zero</td>
96
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
97
<td>the newly allocated <a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a> object</td>
103
<div class="refsect2">
104
<a name="gst-vaapi-subpicture-new-from-overlay-rectangle"></a><h3>gst_vaapi_subpicture_new_from_overlay_rectangle ()</h3>
105
<pre class="programlisting"><a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="returnvalue">GstVaapiSubpicture</span></a> * gst_vaapi_subpicture_new_from_overlay_rectangle
106
(<em class="parameter"><code><a class="link" href="libs-GstVaapiDisplay.html#GstVaapiDisplay" title="GstVaapiDisplay"><span class="type">GstVaapiDisplay</span></a> *display</code></em>,
107
<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rect</code></em>);</pre>
109
Helper function that creates a new <a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a> from a
110
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a>. A new <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> is also created
111
along the way and attached to the resulting subpicture. The
112
subpicture holds a unique reference to the underlying image.
114
<div class="variablelist"><table border="0" class="variablelist">
116
<col align="left" valign="top">
121
<td><p><span class="term"><em class="parameter"><code>display</code></em> :</span></p></td>
122
<td>a <a class="link" href="libs-GstVaapiDisplay.html#GstVaapiDisplay" title="GstVaapiDisplay"><span class="type">GstVaapiDisplay</span></a>
126
<td><p><span class="term"><em class="parameter"><code>rect</code></em> :</span></p></td>
127
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a>
131
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
132
<td>the newly allocated <a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a> object</td>
138
<div class="refsect2">
139
<a name="gst-vaapi-subpicture-get-id"></a><h3>gst_vaapi_subpicture_get_id ()</h3>
140
<pre class="programlisting"><a class="link" href="libs-Basic-data-structures.html#GstVaapiID" title="GstVaapiID"><span class="returnvalue">GstVaapiID</span></a> gst_vaapi_subpicture_get_id (<em class="parameter"><code><a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a> *subpicture</code></em>);</pre>
142
Returns the underlying VASubpictureID of the <em class="parameter"><code>subpicture</code></em>.
144
<div class="variablelist"><table border="0" class="variablelist">
146
<col align="left" valign="top">
151
<td><p><span class="term"><em class="parameter"><code>subpicture</code></em> :</span></p></td>
152
<td>a <a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a>
156
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
157
<td>the underlying VA subpicture id</td>
163
<div class="refsect2">
164
<a name="gst-vaapi-subpicture-get-flags"></a><h3>gst_vaapi_subpicture_get_flags ()</h3>
165
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> gst_vaapi_subpicture_get_flags (<em class="parameter"><code><a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a> *subpicture</code></em>);</pre>
167
Returns the <em class="parameter"><code>subpicture</code></em> flags.
169
<div class="variablelist"><table border="0" class="variablelist">
171
<col align="left" valign="top">
176
<td><p><span class="term"><em class="parameter"><code>subpicture</code></em> :</span></p></td>
177
<td>a <a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a>
181
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
182
<td>the <em class="parameter"><code>subpicture</code></em> flags</td>
188
<div class="refsect2">
189
<a name="gst-vaapi-subpicture-get-global-alpha"></a><h3>gst_vaapi_subpicture_get_global_alpha ()</h3>
190
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a> gst_vaapi_subpicture_get_global_alpha
191
(<em class="parameter"><code><a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a> *subpicture</code></em>);</pre>
193
Returns the value of global_alpha, set for this <em class="parameter"><code>subpicture</code></em>.
195
<div class="variablelist"><table border="0" class="variablelist">
197
<col align="left" valign="top">
202
<td><p><span class="term"><em class="parameter"><code>subpicture</code></em> :</span></p></td>
203
<td>a <a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a>
207
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
208
<td>the global_alpha value of this <em class="parameter"><code>subpicture</code></em>
215
<div class="refsect2">
216
<a name="gst-vaapi-subpicture-set-global-alpha"></a><h3>gst_vaapi_subpicture_set_global_alpha ()</h3>
217
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_vaapi_subpicture_set_global_alpha
218
(<em class="parameter"><code><a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a> *subpicture</code></em>,
219
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> global_alpha</code></em>);</pre>
221
Sets the global_alpha value of <em class="parameter"><code>subpicture</code></em>. This function calls
222
<code class="function">vaSetSubpictureGlobalAlpha()</code> if the format of <em class="parameter"><code>subpicture</code></em>, i.e.
223
the current VA driver supports it.
225
<div class="variablelist"><table border="0" class="variablelist">
227
<col align="left" valign="top">
232
<td><p><span class="term"><em class="parameter"><code>subpicture</code></em> :</span></p></td>
233
<td>a <a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a>
237
<td><p><span class="term"><em class="parameter"><code>global_alpha</code></em> :</span></p></td>
238
<td>value for global-alpha (range: 0.0 to 1.0, inclusive)</td>
241
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
243
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if global_alpha could be set, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td>
249
<div class="refsect2">
250
<a name="gst-vaapi-subpicture-get-image"></a><h3>gst_vaapi_subpicture_get_image ()</h3>
251
<pre class="programlisting"><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="returnvalue">GstVaapiImage</span></a> * gst_vaapi_subpicture_get_image (<em class="parameter"><code><a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a> *subpicture</code></em>);</pre>
253
Returns the <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> this <em class="parameter"><code>subpicture</code></em> is bound to.
255
<div class="variablelist"><table border="0" class="variablelist">
257
<col align="left" valign="top">
262
<td><p><span class="term"><em class="parameter"><code>subpicture</code></em> :</span></p></td>
263
<td>a <a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a>
267
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
268
<td>the <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> this <em class="parameter"><code>subpicture</code></em> is bound to</td>
274
<div class="refsect2">
275
<a name="gst-vaapi-subpicture-set-image"></a><h3>gst_vaapi_subpicture_set_image ()</h3>
276
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_vaapi_subpicture_set_image (<em class="parameter"><code><a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a> *subpicture</code></em>,
277
<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);</pre>
279
Binds a new <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> to the <em class="parameter"><code>subpicture</code></em>. The reference to the
280
previous image is released and a new one is acquired on <em class="parameter"><code>image</code></em>.
282
<div class="variablelist"><table border="0" class="variablelist">
284
<col align="left" valign="top">
289
<td><p><span class="term"><em class="parameter"><code>subpicture</code></em> :</span></p></td>
290
<td>a <a class="link" href="libs-GstVaapiSubpicture.html#GstVaapiSubpicture" title="GstVaapiSubpicture"><span class="type">GstVaapiSubpicture</span></a>
294
<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td>
295
<td>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a>
299
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
301
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success</td>
407
<p>A VA subpicture wrapper</p>
308
411
<div class="footer">
310
Generated by GTK-Doc V1.19</div>
413
Generated by GTK-Doc V1.20</div>
b'\\ No newline at end of file'