33
30
<h2><span class="refentrytitle"><a name="libs-gstvaapiimage.top_of_page"></a>GstVaapiImage</span></h2>
34
31
<p>GstVaapiImage — VA image 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-gstvaapiimage.synopsis"></a><h2>Synopsis</h2>
40
<pre class="synopsis">#define <a class="link" href="libs-gstvaapiimage.html#GST-VAAPI-IMAGE-FORMAT:CAPS" title="GST_VAAPI_IMAGE_FORMAT()">GST_VAAPI_IMAGE_FORMAT</a> (image)
41
#define <a class="link" href="libs-gstvaapiimage.html#GST-VAAPI-IMAGE-WIDTH:CAPS" title="GST_VAAPI_IMAGE_WIDTH()">GST_VAAPI_IMAGE_WIDTH</a> (image)
42
#define <a class="link" href="libs-gstvaapiimage.html#GST-VAAPI-IMAGE-HEIGHT:CAPS" title="GST_VAAPI_IMAGE_HEIGHT()">GST_VAAPI_IMAGE_HEIGHT</a> (image)
43
<a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage">GstVaapiImage</a>;
44
<a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="returnvalue">GstVaapiImage</span></a> * <a class="link" href="libs-gstvaapiimage.html#gst-vaapi-image-new" title="gst_vaapi_image_new ()">gst_vaapi_image_new</a> (<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-gstvideo.html#GstVideoFormat"><span class="type">GstVideoFormat</span></a> format</code></em>,
46
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> width</code></em>,
47
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> height</code></em>);
48
<a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="returnvalue">GstVaapiImage</span></a> * <a class="link" href="libs-gstvaapiimage.html#gst-vaapi-image-new-with-image" title="gst_vaapi_image_new_with_image ()">gst_vaapi_image_new_with_image</a> (<em class="parameter"><code><a class="link" href="libs-GstVaapiDisplay.html#GstVaapiDisplay" title="GstVaapiDisplay"><span class="type">GstVaapiDisplay</span></a> *display</code></em>,
49
<em class="parameter"><code><span class="type">VAImage</span> *va_image</code></em>);
50
<a class="link" href="libs-Basic-data-structures.html#GstVaapiID" title="GstVaapiID"><span class="returnvalue">GstVaapiID</span></a> <a class="link" href="libs-gstvaapiimage.html#gst-vaapi-image-get-id" title="gst_vaapi_image_get_id ()">gst_vaapi_image_get_id</a> (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);
51
<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-gstvaapiimage.html#gst-vaapi-image-get-image" title="gst_vaapi_image_get_image ()">gst_vaapi_image_get_image</a> (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>,
52
<em class="parameter"><code><span class="type">VAImage</span> *va_image</code></em>);
53
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideo.html#GstVideoFormat"><span class="returnvalue">GstVideoFormat</span></a> <a class="link" href="libs-gstvaapiimage.html#gst-vaapi-image-get-format" title="gst_vaapi_image_get_format ()">gst_vaapi_image_get_format</a> (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);
54
<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-gstvaapiimage.html#gst-vaapi-image-get-width" title="gst_vaapi_image_get_width ()">gst_vaapi_image_get_width</a> (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);
55
<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-gstvaapiimage.html#gst-vaapi-image-get-height" title="gst_vaapi_image_get_height ()">gst_vaapi_image_get_height</a> (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);
56
<span class="returnvalue">void</span> <a class="link" href="libs-gstvaapiimage.html#gst-vaapi-image-get-size" title="gst_vaapi_image_get_size ()">gst_vaapi_image_get_size</a> (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>,
57
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *pwidth</code></em>,
58
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *pheight</code></em>);
59
<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-gstvaapiimage.html#gst-vaapi-image-is-linear" title="gst_vaapi_image_is_linear ()">gst_vaapi_image_is_linear</a> (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);
60
<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-gstvaapiimage.html#gst-vaapi-image-is-mapped" title="gst_vaapi_image_is_mapped ()">gst_vaapi_image_is_mapped</a> (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);
61
<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-gstvaapiimage.html#gst-vaapi-image-map" title="gst_vaapi_image_map ()">gst_vaapi_image_map</a> (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);
62
<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-gstvaapiimage.html#gst-vaapi-image-unmap" title="gst_vaapi_image_unmap ()">gst_vaapi_image_unmap</a> (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);
63
<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-gstvaapiimage.html#gst-vaapi-image-get-plane-count" title="gst_vaapi_image_get_plane_count ()">gst_vaapi_image_get_plane_count</a> (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);
64
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="returnvalue">guchar</span></a> * <a class="link" href="libs-gstvaapiimage.html#gst-vaapi-image-get-plane" title="gst_vaapi_image_get_plane ()">gst_vaapi_image_get_plane</a> (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>,
65
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> plane</code></em>);
66
<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-gstvaapiimage.html#gst-vaapi-image-get-pitch" title="gst_vaapi_image_get_pitch ()">gst_vaapi_image_get_pitch</a> (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>,
67
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> plane</code></em>);
68
<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-gstvaapiimage.html#gst-vaapi-image-get-data-size" title="gst_vaapi_image_get_data_size ()">gst_vaapi_image_get_data_size</a> (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);
69
<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-gstvaapiimage.html#gst-vaapi-image-get-buffer" title="gst_vaapi_image_get_buffer ()">gst_vaapi_image_get_buffer</a> (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>,
70
<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buffer</code></em>,
71
<em class="parameter"><code><a class="link" href="libs-Basic-data-structures.html#GstVaapiRectangle" title="struct GstVaapiRectangle"><span class="type">GstVaapiRectangle</span></a> *rect</code></em>);
72
<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-gstvaapiimage.html#gst-vaapi-image-update-from-buffer" title="gst_vaapi_image_update_from_buffer ()">gst_vaapi_image_update_from_buffer</a> (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>,
73
<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buffer</code></em>,
74
<em class="parameter"><code><a class="link" href="libs-Basic-data-structures.html#GstVaapiRectangle" title="struct GstVaapiRectangle"><span class="type">GstVaapiRectangle</span></a> *rect</code></em>);
75
<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-gstvaapiimage.html#gst-vaapi-image-copy" title="gst_vaapi_image_copy ()">gst_vaapi_image_copy</a> (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *dst_image</code></em>,
76
<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *src_image</code></em>);
35
<div class="refsect1">
36
<a name="libs-gstvaapiimage.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="define_keyword">#define</td>
45
<td class="function_name">
46
<a class="link" href="libs-gstvaapiimage.html#GST-VAAPI-IMAGE-FORMAT:CAPS" title="GST_VAAPI_IMAGE_FORMAT()">GST_VAAPI_IMAGE_FORMAT</a><span class="c_punctuation">()</span>
50
<td class="define_keyword">#define</td>
51
<td class="function_name">
52
<a class="link" href="libs-gstvaapiimage.html#GST-VAAPI-IMAGE-WIDTH:CAPS" title="GST_VAAPI_IMAGE_WIDTH()">GST_VAAPI_IMAGE_WIDTH</a><span class="c_punctuation">()</span>
56
<td class="define_keyword">#define</td>
57
<td class="function_name">
58
<a class="link" href="libs-gstvaapiimage.html#GST-VAAPI-IMAGE-HEIGHT:CAPS" title="GST_VAAPI_IMAGE_HEIGHT()">GST_VAAPI_IMAGE_HEIGHT</a><span class="c_punctuation">()</span>
62
<td class="function_type">
63
<a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="returnvalue">GstVaapiImage</span></a> *
65
<td class="function_name">
66
<a class="link" href="libs-gstvaapiimage.html#gst-vaapi-image-new" title="gst_vaapi_image_new ()">gst_vaapi_image_new</a> <span class="c_punctuation">()</span>
70
<td class="function_type">
71
<a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="returnvalue">GstVaapiImage</span></a> *
73
<td class="function_name">
74
<a class="link" href="libs-gstvaapiimage.html#gst-vaapi-image-new-with-image" title="gst_vaapi_image_new_with_image ()">gst_vaapi_image_new_with_image</a> <span class="c_punctuation">()</span>
78
<td class="function_type">
79
<a class="link" href="libs-Basic-data-structures.html#GstVaapiID" title="GstVaapiID"><span class="returnvalue">GstVaapiID</span></a>
81
<td class="function_name">
82
<a class="link" href="libs-gstvaapiimage.html#gst-vaapi-image-get-id" title="gst_vaapi_image_get_id ()">gst_vaapi_image_get_id</a> <span class="c_punctuation">()</span>
86
<td class="function_type">
87
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
89
<td class="function_name">
90
<a class="link" href="libs-gstvaapiimage.html#gst-vaapi-image-get-image" title="gst_vaapi_image_get_image ()">gst_vaapi_image_get_image</a> <span class="c_punctuation">()</span>
94
<td class="function_type">
95
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideo.html#GstVideoFormat"><span class="returnvalue">GstVideoFormat</span></a>
97
<td class="function_name">
98
<a class="link" href="libs-gstvaapiimage.html#gst-vaapi-image-get-format" title="gst_vaapi_image_get_format ()">gst_vaapi_image_get_format</a> <span class="c_punctuation">()</span>
102
<td class="function_type">
103
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
105
<td class="function_name">
106
<a class="link" href="libs-gstvaapiimage.html#gst-vaapi-image-get-width" title="gst_vaapi_image_get_width ()">gst_vaapi_image_get_width</a> <span class="c_punctuation">()</span>
110
<td class="function_type">
111
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
113
<td class="function_name">
114
<a class="link" href="libs-gstvaapiimage.html#gst-vaapi-image-get-height" title="gst_vaapi_image_get_height ()">gst_vaapi_image_get_height</a> <span class="c_punctuation">()</span>
118
<td class="function_type">
119
<span class="returnvalue">void</span>
121
<td class="function_name">
122
<a class="link" href="libs-gstvaapiimage.html#gst-vaapi-image-get-size" title="gst_vaapi_image_get_size ()">gst_vaapi_image_get_size</a> <span class="c_punctuation">()</span>
126
<td class="function_type">
127
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
129
<td class="function_name">
130
<a class="link" href="libs-gstvaapiimage.html#gst-vaapi-image-is-linear" title="gst_vaapi_image_is_linear ()">gst_vaapi_image_is_linear</a> <span class="c_punctuation">()</span>
134
<td class="function_type">
135
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
137
<td class="function_name">
138
<a class="link" href="libs-gstvaapiimage.html#gst-vaapi-image-is-mapped" title="gst_vaapi_image_is_mapped ()">gst_vaapi_image_is_mapped</a> <span class="c_punctuation">()</span>
142
<td class="function_type">
143
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
145
<td class="function_name">
146
<a class="link" href="libs-gstvaapiimage.html#gst-vaapi-image-map" title="gst_vaapi_image_map ()">gst_vaapi_image_map</a> <span class="c_punctuation">()</span>
150
<td class="function_type">
151
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
153
<td class="function_name">
154
<a class="link" href="libs-gstvaapiimage.html#gst-vaapi-image-unmap" title="gst_vaapi_image_unmap ()">gst_vaapi_image_unmap</a> <span class="c_punctuation">()</span>
158
<td class="function_type">
159
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
161
<td class="function_name">
162
<a class="link" href="libs-gstvaapiimage.html#gst-vaapi-image-get-plane-count" title="gst_vaapi_image_get_plane_count ()">gst_vaapi_image_get_plane_count</a> <span class="c_punctuation">()</span>
166
<td class="function_type">
167
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="returnvalue">guchar</span></a> *
169
<td class="function_name">
170
<a class="link" href="libs-gstvaapiimage.html#gst-vaapi-image-get-plane" title="gst_vaapi_image_get_plane ()">gst_vaapi_image_get_plane</a> <span class="c_punctuation">()</span>
174
<td class="function_type">
175
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
177
<td class="function_name">
178
<a class="link" href="libs-gstvaapiimage.html#gst-vaapi-image-get-pitch" title="gst_vaapi_image_get_pitch ()">gst_vaapi_image_get_pitch</a> <span class="c_punctuation">()</span>
182
<td class="function_type">
183
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
185
<td class="function_name">
186
<a class="link" href="libs-gstvaapiimage.html#gst-vaapi-image-get-data-size" title="gst_vaapi_image_get_data_size ()">gst_vaapi_image_get_data_size</a> <span class="c_punctuation">()</span>
190
<td class="function_type">
191
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
193
<td class="function_name">
194
<a class="link" href="libs-gstvaapiimage.html#gst-vaapi-image-get-buffer" title="gst_vaapi_image_get_buffer ()">gst_vaapi_image_get_buffer</a> <span class="c_punctuation">()</span>
198
<td class="function_type">
199
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
201
<td class="function_name">
202
<a class="link" href="libs-gstvaapiimage.html#gst-vaapi-image-update-from-buffer" title="gst_vaapi_image_update_from_buffer ()">gst_vaapi_image_update_from_buffer</a> <span class="c_punctuation">()</span>
206
<td class="function_type">
207
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
209
<td class="function_name">
210
<a class="link" href="libs-gstvaapiimage.html#gst-vaapi-image-copy" title="gst_vaapi_image_copy ()">gst_vaapi_image_copy</a> <span class="c_punctuation">()</span>
216
<div class="refsect1">
217
<a name="libs-gstvaapiimage.other"></a><h2>Types and Values</h2>
218
<div class="informaltable"><table width="100%" border="0">
220
<col width="150px" class="name">
221
<col class="description">
224
<td class="datatype_keyword"> </td>
225
<td class="function_name"><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage">GstVaapiImage</a></td>
229
<div class="refsect1">
230
<a name="libs-gstvaapiimage.object-hierarchy"></a><h2>Object Hierarchy</h2>
79
234
<div class="refsect1">
80
235
<a name="libs-gstvaapiimage.description"></a><h2>Description</h2>
82
237
<div class="refsect1">
83
<a name="libs-gstvaapiimage.details"></a><h2>Details</h2>
238
<a name="libs-gstvaapiimage.functions_details"></a><h2>Functions</h2>
84
239
<div class="refsect2">
85
240
<a name="GST-VAAPI-IMAGE-FORMAT:CAPS"></a><h3>GST_VAAPI_IMAGE_FORMAT()</h3>
86
241
<pre class="programlisting">#define GST_VAAPI_IMAGE_FORMAT(image)</pre>
88
Macro that evaluates to the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideo.html#GstVideoFormat"><span class="type">GstVideoFormat</span></a> of <em class="parameter"><code>image</code></em>.
90
<div class="variablelist"><table border="0" class="variablelist">
242
<p>Macro that evaluates to the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideo.html#GstVideoFormat"><span class="type">GstVideoFormat</span></a> of <em class="parameter"><code>image</code></em>
244
<div class="refsect3">
245
<a name="id-1.2.14.7.2.5"></a><h4>Parameters</h4>
246
<div class="informaltable"><table width="100%" border="0">
92
<col align="left" valign="top">
248
<col width="150px" class="parameters_name">
249
<col class="parameters_description">
250
<col width="200px" class="parameters_annotations">
96
<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td>
97
<td>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a>
253
<td class="parameter_name"><p>image</p></td>
254
<td class="parameter_description"><p>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a></p></td>
255
<td class="parameter_annotations"> </td>
103
261
<div class="refsect2">
104
262
<a name="GST-VAAPI-IMAGE-WIDTH:CAPS"></a><h3>GST_VAAPI_IMAGE_WIDTH()</h3>
105
263
<pre class="programlisting">#define GST_VAAPI_IMAGE_WIDTH(image)</pre>
107
Macro that evaluates to the width of <em class="parameter"><code>image</code></em>.
109
<div class="variablelist"><table border="0" class="variablelist">
264
<p>Macro that evaluates to the width of <em class="parameter"><code>image</code></em>
266
<div class="refsect3">
267
<a name="id-1.2.14.7.3.5"></a><h4>Parameters</h4>
268
<div class="informaltable"><table width="100%" border="0">
111
<col align="left" valign="top">
270
<col width="150px" class="parameters_name">
271
<col class="parameters_description">
272
<col width="200px" class="parameters_annotations">
115
<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td>
116
<td>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a>
275
<td class="parameter_name"><p>image</p></td>
276
<td class="parameter_description"><p>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a></p></td>
277
<td class="parameter_annotations"> </td>
122
283
<div class="refsect2">
123
284
<a name="GST-VAAPI-IMAGE-HEIGHT:CAPS"></a><h3>GST_VAAPI_IMAGE_HEIGHT()</h3>
124
285
<pre class="programlisting">#define GST_VAAPI_IMAGE_HEIGHT(image)</pre>
126
Macro that evaluates to the height of <em class="parameter"><code>image</code></em>.
128
<div class="variablelist"><table border="0" class="variablelist">
130
<col align="left" valign="top">
134
<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td>
135
<td>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a>
286
<p>Macro that evaluates to the height of <em class="parameter"><code>image</code></em>
288
<div class="refsect3">
289
<a name="id-1.2.14.7.4.5"></a><h4>Parameters</h4>
290
<div class="informaltable"><table width="100%" border="0">
292
<col width="150px" class="parameters_name">
293
<col class="parameters_description">
294
<col width="200px" class="parameters_annotations">
297
<td class="parameter_name"><p>image</p></td>
298
<td class="parameter_description"><p>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a></p></td>
299
<td class="parameter_annotations"> </td>
305
<div class="refsect2">
306
<a name="gst-vaapi-image-new"></a><h3>gst_vaapi_image_new ()</h3>
307
<pre class="programlisting"><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="returnvalue">GstVaapiImage</span></a> *
308
gst_vaapi_image_new (<em class="parameter"><code><a class="link" href="libs-GstVaapiDisplay.html#GstVaapiDisplay" title="GstVaapiDisplay"><span class="type">GstVaapiDisplay</span></a> *display</code></em>,
309
<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideo.html#GstVideoFormat"><span class="type">GstVideoFormat</span></a> format</code></em>,
310
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> width</code></em>,
311
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> height</code></em>);</pre>
312
<p>Creates a new <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> with the specified format and
314
<div class="refsect3">
315
<a name="id-1.2.14.7.5.5"></a><h4>Parameters</h4>
316
<div class="informaltable"><table width="100%" border="0">
318
<col width="150px" class="parameters_name">
319
<col class="parameters_description">
320
<col width="200px" class="parameters_annotations">
324
<td class="parameter_name"><p>display</p></td>
325
<td class="parameter_description"><p>a <a class="link" href="libs-GstVaapiDisplay.html#GstVaapiDisplay" title="GstVaapiDisplay"><span class="type">GstVaapiDisplay</span></a></p></td>
326
<td class="parameter_annotations"> </td>
329
<td class="parameter_name"><p>format</p></td>
330
<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-gstvideo.html#GstVideoFormat"><span class="type">GstVideoFormat</span></a></p></td>
331
<td class="parameter_annotations"> </td>
334
<td class="parameter_name"><p>width</p></td>
335
<td class="parameter_description"><p>the requested image width</p></td>
336
<td class="parameter_annotations"> </td>
339
<td class="parameter_name"><p>height</p></td>
340
<td class="parameter_description"><p>the requested image height</p></td>
341
<td class="parameter_annotations"> </td>
346
<div class="refsect3">
347
<a name="id-1.2.14.7.5.6"></a><h4>Returns</h4>
348
<p> the newly allocated <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> object</p>
353
<div class="refsect2">
354
<a name="gst-vaapi-image-new-with-image"></a><h3>gst_vaapi_image_new_with_image ()</h3>
355
<pre class="programlisting"><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="returnvalue">GstVaapiImage</span></a> *
356
gst_vaapi_image_new_with_image (<em class="parameter"><code><a class="link" href="libs-GstVaapiDisplay.html#GstVaapiDisplay" title="GstVaapiDisplay"><span class="type">GstVaapiDisplay</span></a> *display</code></em>,
357
<em class="parameter"><code><span class="type">VAImage</span> *va_image</code></em>);</pre>
358
<p>Creates a new <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> from a foreign VA image. The image
359
format and dimensions will be extracted from <em class="parameter"><code>va_image</code></em>
361
function is mainly used by <a class="link" href="libs-gstvaapisurface.html#gst-vaapi-surface-derive-image" title="gst_vaapi_surface_derive_image ()"><code class="function">gst_vaapi_surface_derive_image()</code></a> to bind
362
a VA image to a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> object.</p>
363
<div class="refsect3">
364
<a name="id-1.2.14.7.6.5"></a><h4>Parameters</h4>
365
<div class="informaltable"><table width="100%" border="0">
367
<col width="150px" class="parameters_name">
368
<col class="parameters_description">
369
<col width="200px" class="parameters_annotations">
373
<td class="parameter_name"><p>display</p></td>
374
<td class="parameter_description"><p>a <a class="link" href="libs-GstVaapiDisplay.html#GstVaapiDisplay" title="GstVaapiDisplay"><span class="type">GstVaapiDisplay</span></a></p></td>
375
<td class="parameter_annotations"> </td>
378
<td class="parameter_name"><p>va_image</p></td>
379
<td class="parameter_description"><p>a VA image</p></td>
380
<td class="parameter_annotations"> </td>
385
<div class="refsect3">
386
<a name="id-1.2.14.7.6.6"></a><h4>Returns</h4>
387
<p> the newly allocated <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> object</p>
392
<div class="refsect2">
393
<a name="gst-vaapi-image-get-id"></a><h3>gst_vaapi_image_get_id ()</h3>
394
<pre class="programlisting"><a class="link" href="libs-Basic-data-structures.html#GstVaapiID" title="GstVaapiID"><span class="returnvalue">GstVaapiID</span></a>
395
gst_vaapi_image_get_id (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);</pre>
396
<p>Returns the underlying VAImageID of the <em class="parameter"><code>image</code></em>
398
<div class="refsect3">
399
<a name="id-1.2.14.7.7.5"></a><h4>Parameters</h4>
400
<div class="informaltable"><table width="100%" border="0">
402
<col width="150px" class="parameters_name">
403
<col class="parameters_description">
404
<col width="200px" class="parameters_annotations">
407
<td class="parameter_name"><p>image</p></td>
408
<td class="parameter_description"><p>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a></p></td>
409
<td class="parameter_annotations"> </td>
413
<div class="refsect3">
414
<a name="id-1.2.14.7.7.6"></a><h4>Returns</h4>
415
<p> the underlying VA image id</p>
420
<div class="refsect2">
421
<a name="gst-vaapi-image-get-image"></a><h3>gst_vaapi_image_get_image ()</h3>
422
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
423
gst_vaapi_image_get_image (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>,
424
<em class="parameter"><code><span class="type">VAImage</span> *va_image</code></em>);</pre>
425
<p>Fills <em class="parameter"><code>va_image</code></em>
426
with the VA image used internally.</p>
427
<div class="refsect3">
428
<a name="id-1.2.14.7.8.5"></a><h4>Parameters</h4>
429
<div class="informaltable"><table width="100%" border="0">
431
<col width="150px" class="parameters_name">
432
<col class="parameters_description">
433
<col width="200px" class="parameters_annotations">
437
<td class="parameter_name"><p>image</p></td>
438
<td class="parameter_description"><p>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a></p></td>
439
<td class="parameter_annotations"> </td>
442
<td class="parameter_name"><p>va_image</p></td>
443
<td class="parameter_description"><p>a VA image</p></td>
444
<td class="parameter_annotations"> </td>
449
<div class="refsect3">
450
<a name="id-1.2.14.7.8.6"></a><h4>Returns</h4>
451
<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>
456
<div class="refsect2">
457
<a name="gst-vaapi-image-get-format"></a><h3>gst_vaapi_image_get_format ()</h3>
458
<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideo.html#GstVideoFormat"><span class="returnvalue">GstVideoFormat</span></a>
459
gst_vaapi_image_get_format (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);</pre>
460
<p>Returns the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideo.html#GstVideoFormat"><span class="type">GstVideoFormat</span></a> the <em class="parameter"><code>image</code></em>
461
was created with.</p>
462
<div class="refsect3">
463
<a name="id-1.2.14.7.9.5"></a><h4>Parameters</h4>
464
<div class="informaltable"><table width="100%" border="0">
466
<col width="150px" class="parameters_name">
467
<col class="parameters_description">
468
<col width="200px" class="parameters_annotations">
471
<td class="parameter_name"><p>image</p></td>
472
<td class="parameter_description"><p>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a></p></td>
473
<td class="parameter_annotations"> </td>
477
<div class="refsect3">
478
<a name="id-1.2.14.7.9.6"></a><h4>Returns</h4>
479
<p> the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideo.html#GstVideoFormat"><span class="type">GstVideoFormat</span></a></p>
484
<div class="refsect2">
485
<a name="gst-vaapi-image-get-width"></a><h3>gst_vaapi_image_get_width ()</h3>
486
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
487
gst_vaapi_image_get_width (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);</pre>
488
<p>Returns the <em class="parameter"><code>image</code></em>
490
<div class="refsect3">
491
<a name="id-1.2.14.7.10.5"></a><h4>Parameters</h4>
492
<div class="informaltable"><table width="100%" border="0">
494
<col width="150px" class="parameters_name">
495
<col class="parameters_description">
496
<col width="200px" class="parameters_annotations">
499
<td class="parameter_name"><p>image</p></td>
500
<td class="parameter_description"><p>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a></p></td>
501
<td class="parameter_annotations"> </td>
505
<div class="refsect3">
506
<a name="id-1.2.14.7.10.6"></a><h4>Returns</h4>
507
<p> the image width, in pixels</p>
512
<div class="refsect2">
513
<a name="gst-vaapi-image-get-height"></a><h3>gst_vaapi_image_get_height ()</h3>
514
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
515
gst_vaapi_image_get_height (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);</pre>
516
<p>Returns the <em class="parameter"><code>image</code></em>
518
<div class="refsect3">
519
<a name="id-1.2.14.7.11.5"></a><h4>Parameters</h4>
520
<div class="informaltable"><table width="100%" border="0">
522
<col width="150px" class="parameters_name">
523
<col class="parameters_description">
524
<col width="200px" class="parameters_annotations">
527
<td class="parameter_name"><p>image</p></td>
528
<td class="parameter_description"><p>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a></p></td>
529
<td class="parameter_annotations"> </td>
533
<div class="refsect3">
534
<a name="id-1.2.14.7.11.6"></a><h4>Returns</h4>
535
<p> the image height, in pixels.</p>
540
<div class="refsect2">
541
<a name="gst-vaapi-image-get-size"></a><h3>gst_vaapi_image_get_size ()</h3>
542
<pre class="programlisting"><span class="returnvalue">void</span>
543
gst_vaapi_image_get_size (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>,
544
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *pwidth</code></em>,
545
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *pheight</code></em>);</pre>
546
<p>Retrieves the dimensions of a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a>.</p>
547
<div class="refsect3">
548
<a name="id-1.2.14.7.12.5"></a><h4>Parameters</h4>
549
<div class="informaltable"><table width="100%" border="0">
551
<col width="150px" class="parameters_name">
552
<col class="parameters_description">
553
<col width="200px" class="parameters_annotations">
557
<td class="parameter_name"><p>image</p></td>
558
<td class="parameter_description"><p>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a></p></td>
559
<td class="parameter_annotations"> </td>
562
<td class="parameter_name"><p>pwidth</p></td>
563
<td class="parameter_description"><p>return location for the width, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
564
<td class="parameter_annotations"> </td>
567
<td class="parameter_name"><p>pheight</p></td>
568
<td class="parameter_description"><p>return location for the height, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
569
<td class="parameter_annotations"> </td>
576
<div class="refsect2">
577
<a name="gst-vaapi-image-is-linear"></a><h3>gst_vaapi_image_is_linear ()</h3>
578
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
579
gst_vaapi_image_is_linear (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);</pre>
580
<p>Checks whether the <em class="parameter"><code>image</code></em>
581
has data planes allocated from a single
582
buffer and offsets into that buffer are in increasing order with
583
the number of planes.</p>
584
<div class="refsect3">
585
<a name="id-1.2.14.7.13.5"></a><h4>Parameters</h4>
586
<div class="informaltable"><table width="100%" border="0">
588
<col width="150px" class="parameters_name">
589
<col class="parameters_description">
590
<col width="200px" class="parameters_annotations">
593
<td class="parameter_name"><p>image</p></td>
594
<td class="parameter_description"><p>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a></p></td>
595
<td class="parameter_annotations"> </td>
599
<div class="refsect3">
600
<a name="id-1.2.14.7.13.6"></a><h4>Returns</h4>
601
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if image data planes are allocated from a single buffer</p>
606
<div class="refsect2">
607
<a name="gst-vaapi-image-is-mapped"></a><h3>gst_vaapi_image_is_mapped ()</h3>
608
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
609
gst_vaapi_image_is_mapped (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);</pre>
610
<p>Checks whether the <em class="parameter"><code>image</code></em>
611
is currently mapped or not.</p>
612
<div class="refsect3">
613
<a name="id-1.2.14.7.14.5"></a><h4>Parameters</h4>
614
<div class="informaltable"><table width="100%" border="0">
616
<col width="150px" class="parameters_name">
617
<col class="parameters_description">
618
<col width="200px" class="parameters_annotations">
621
<td class="parameter_name"><p>image</p></td>
622
<td class="parameter_description"><p>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a></p></td>
623
<td class="parameter_annotations"> </td>
627
<div class="refsect3">
628
<a name="id-1.2.14.7.14.6"></a><h4>Returns</h4>
629
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the <em class="parameter"><code>image</code></em>
635
<div class="refsect2">
636
<a name="gst-vaapi-image-map"></a><h3>gst_vaapi_image_map ()</h3>
637
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
638
gst_vaapi_image_map (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);</pre>
639
<p>Maps the image data buffer. The actual pixels are returned by the
640
<a class="link" href="libs-gstvaapiimage.html#gst-vaapi-image-get-plane" title="gst_vaapi_image_get_plane ()"><code class="function">gst_vaapi_image_get_plane()</code></a> function.</p>
641
<div class="refsect3">
642
<a name="id-1.2.14.7.15.5"></a><h4>Parameters</h4>
643
<div class="informaltable"><table width="100%" border="0">
645
<col width="150px" class="parameters_name">
646
<col class="parameters_description">
647
<col width="200px" class="parameters_annotations">
650
<td class="parameter_name"><p>image</p></td>
651
<td class="parameter_description"><p>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a></p></td>
652
<td class="parameter_annotations"> </td>
656
<div class="refsect3">
657
<a name="id-1.2.14.7.15.6"></a><h4>Returns</h4>
658
<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>
663
<div class="refsect2">
664
<a name="gst-vaapi-image-unmap"></a><h3>gst_vaapi_image_unmap ()</h3>
665
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
666
gst_vaapi_image_unmap (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);</pre>
667
<p>Unmaps the image data buffer. Pointers to pixels returned by
668
<a class="link" href="libs-gstvaapiimage.html#gst-vaapi-image-get-plane" title="gst_vaapi_image_get_plane ()"><code class="function">gst_vaapi_image_get_plane()</code></a> are then no longer valid.</p>
669
<div class="refsect3">
670
<a name="id-1.2.14.7.16.5"></a><h4>Parameters</h4>
671
<div class="informaltable"><table width="100%" border="0">
673
<col width="150px" class="parameters_name">
674
<col class="parameters_description">
675
<col width="200px" class="parameters_annotations">
678
<td class="parameter_name"><p>image</p></td>
679
<td class="parameter_description"><p>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a></p></td>
680
<td class="parameter_annotations"> </td>
684
<div class="refsect3">
685
<a name="id-1.2.14.7.16.6"></a><h4>Returns</h4>
686
<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>
691
<div class="refsect2">
692
<a name="gst-vaapi-image-get-plane-count"></a><h3>gst_vaapi_image_get_plane_count ()</h3>
693
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
694
gst_vaapi_image_get_plane_count (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);</pre>
695
<p>Retrieves the number of planes available in the <em class="parameter"><code>image</code></em>
696
. The <em class="parameter"><code>image</code></em>
698
must be mapped for this function to work properly.</p>
699
<div class="refsect3">
700
<a name="id-1.2.14.7.17.5"></a><h4>Parameters</h4>
701
<div class="informaltable"><table width="100%" border="0">
703
<col width="150px" class="parameters_name">
704
<col class="parameters_description">
705
<col width="200px" class="parameters_annotations">
708
<td class="parameter_name"><p>image</p></td>
709
<td class="parameter_description"><p>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a></p></td>
710
<td class="parameter_annotations"> </td>
714
<div class="refsect3">
715
<a name="id-1.2.14.7.17.6"></a><h4>Returns</h4>
716
<p> the number of planes available in the <em class="parameter"><code>image</code></em>
722
<div class="refsect2">
723
<a name="gst-vaapi-image-get-plane"></a><h3>gst_vaapi_image_get_plane ()</h3>
724
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="returnvalue">guchar</span></a> *
725
gst_vaapi_image_get_plane (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>,
726
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> plane</code></em>);</pre>
727
<p>Retrieves the pixels data to the specified <em class="parameter"><code>plane</code></em>
728
. The <em class="parameter"><code>image</code></em>
730
be mapped for this function to work properly.</p>
731
<div class="refsect3">
732
<a name="id-1.2.14.7.18.5"></a><h4>Parameters</h4>
733
<div class="informaltable"><table width="100%" border="0">
735
<col width="150px" class="parameters_name">
736
<col class="parameters_description">
737
<col width="200px" class="parameters_annotations">
741
<td class="parameter_name"><p>image</p></td>
742
<td class="parameter_description"><p>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a></p></td>
743
<td class="parameter_annotations"> </td>
746
<td class="parameter_name"><p>plane</p></td>
747
<td class="parameter_description"><p>the requested plane number</p></td>
748
<td class="parameter_annotations"> </td>
753
<div class="refsect3">
754
<a name="id-1.2.14.7.18.6"></a><h4>Returns</h4>
755
<p> the pixels data of the specified <em class="parameter"><code>plane</code></em>
761
<div class="refsect2">
762
<a name="gst-vaapi-image-get-pitch"></a><h3>gst_vaapi_image_get_pitch ()</h3>
763
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
764
gst_vaapi_image_get_pitch (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>,
765
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> plane</code></em>);</pre>
766
<p>Retrieves the line size (stride) of the specified <em class="parameter"><code>plane</code></em>
768
<em class="parameter"><code>image</code></em>
769
must be mapped for this function to work properly.</p>
770
<div class="refsect3">
771
<a name="id-1.2.14.7.19.5"></a><h4>Parameters</h4>
772
<div class="informaltable"><table width="100%" border="0">
774
<col width="150px" class="parameters_name">
775
<col class="parameters_description">
776
<col width="200px" class="parameters_annotations">
780
<td class="parameter_name"><p>image</p></td>
781
<td class="parameter_description"><p>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a></p></td>
782
<td class="parameter_annotations"> </td>
785
<td class="parameter_name"><p>plane</p></td>
786
<td class="parameter_description"><p>the requested plane number</p></td>
787
<td class="parameter_annotations"> </td>
792
<div class="refsect3">
793
<a name="id-1.2.14.7.19.6"></a><h4>Returns</h4>
794
<p> the line size (stride) of the specified plane</p>
799
<div class="refsect2">
800
<a name="gst-vaapi-image-get-data-size"></a><h3>gst_vaapi_image_get_data_size ()</h3>
801
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
802
gst_vaapi_image_get_data_size (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);</pre>
803
<p>Retrieves the underlying image data size. This function could be
804
used to determine whether the image has a compatible layout with
805
another image structure.</p>
806
<div class="refsect3">
807
<a name="id-1.2.14.7.20.5"></a><h4>Parameters</h4>
808
<div class="informaltable"><table width="100%" border="0">
810
<col width="150px" class="parameters_name">
811
<col class="parameters_description">
812
<col width="200px" class="parameters_annotations">
815
<td class="parameter_name"><p>image</p></td>
816
<td class="parameter_description"><p>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a></p></td>
817
<td class="parameter_annotations"> </td>
821
<div class="refsect3">
822
<a name="id-1.2.14.7.20.6"></a><h4>Returns</h4>
823
<p> the whole image data size of the <em class="parameter"><code>image</code></em>
829
<div class="refsect2">
830
<a name="gst-vaapi-image-get-buffer"></a><h3>gst_vaapi_image_get_buffer ()</h3>
831
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
832
gst_vaapi_image_get_buffer (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>,
833
<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buffer</code></em>,
834
<em class="parameter"><code><a class="link" href="libs-Basic-data-structures.html#GstVaapiRectangle" title="struct GstVaapiRectangle"><span class="type">GstVaapiRectangle</span></a> *rect</code></em>);</pre>
835
<p>Transfers pixels data contained in the <em class="parameter"><code>image</code></em>
836
into the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a>.
837
Both image structures shall have the same format.</p>
838
<div class="refsect3">
839
<a name="id-1.2.14.7.21.5"></a><h4>Parameters</h4>
840
<div class="informaltable"><table width="100%" border="0">
842
<col width="150px" class="parameters_name">
843
<col class="parameters_description">
844
<col width="200px" class="parameters_annotations">
848
<td class="parameter_name"><p>image</p></td>
849
<td class="parameter_description"><p>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a></p></td>
850
<td class="parameter_annotations"> </td>
853
<td class="parameter_name"><p>buffer</p></td>
854
<td class="parameter_description"><p>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a></p></td>
855
<td class="parameter_annotations"> </td>
858
<td class="parameter_name"><p>rect</p></td>
859
<td class="parameter_description"><p>a <a class="link" href="libs-Basic-data-structures.html#GstVaapiRectangle" title="struct GstVaapiRectangle"><span class="type">GstVaapiRectangle</span></a> expressing a region, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for the
861
<td class="parameter_annotations"> </td>
866
<div class="refsect3">
867
<a name="id-1.2.14.7.21.6"></a><h4>Returns</h4>
868
<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>
873
<div class="refsect2">
874
<a name="gst-vaapi-image-update-from-buffer"></a><h3>gst_vaapi_image_update_from_buffer ()</h3>
875
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
876
gst_vaapi_image_update_from_buffer (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>,
877
<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buffer</code></em>,
878
<em class="parameter"><code><a class="link" href="libs-Basic-data-structures.html#GstVaapiRectangle" title="struct GstVaapiRectangle"><span class="type">GstVaapiRectangle</span></a> *rect</code></em>);</pre>
879
<p>Transfers pixels data contained in the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> into the
880
<em class="parameter"><code>image</code></em>
881
. Both image structures shall have the same format.</p>
882
<div class="refsect3">
883
<a name="id-1.2.14.7.22.5"></a><h4>Parameters</h4>
884
<div class="informaltable"><table width="100%" border="0">
886
<col width="150px" class="parameters_name">
887
<col class="parameters_description">
888
<col width="200px" class="parameters_annotations">
892
<td class="parameter_name"><p>image</p></td>
893
<td class="parameter_description"><p>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a></p></td>
894
<td class="parameter_annotations"> </td>
897
<td class="parameter_name"><p>buffer</p></td>
898
<td class="parameter_description"><p>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a></p></td>
899
<td class="parameter_annotations"> </td>
902
<td class="parameter_name"><p>rect</p></td>
903
<td class="parameter_description"><p>a <a class="link" href="libs-Basic-data-structures.html#GstVaapiRectangle" title="struct GstVaapiRectangle"><span class="type">GstVaapiRectangle</span></a> expressing a region, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for the
905
<td class="parameter_annotations"> </td>
910
<div class="refsect3">
911
<a name="id-1.2.14.7.22.6"></a><h4>Returns</h4>
912
<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>
917
<div class="refsect2">
918
<a name="gst-vaapi-image-copy"></a><h3>gst_vaapi_image_copy ()</h3>
919
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
920
gst_vaapi_image_copy (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *dst_image</code></em>,
921
<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *src_image</code></em>);</pre>
922
<p>Copies pixels data from <em class="parameter"><code>src_image</code></em>
923
to <em class="parameter"><code>dst_image</code></em>
925
have the same format and size.</p>
926
<div class="refsect3">
927
<a name="id-1.2.14.7.23.5"></a><h4>Parameters</h4>
928
<div class="informaltable"><table width="100%" border="0">
930
<col width="150px" class="parameters_name">
931
<col class="parameters_description">
932
<col width="200px" class="parameters_annotations">
936
<td class="parameter_name"><p>dst_image</p></td>
937
<td class="parameter_description"><p>the target <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a></p></td>
938
<td class="parameter_annotations"> </td>
941
<td class="parameter_name"><p>src_image</p></td>
942
<td class="parameter_description"><p>the source <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a></p></td>
943
<td class="parameter_annotations"> </td>
948
<div class="refsect3">
949
<a name="id-1.2.14.7.23.6"></a><h4>Returns</h4>
950
<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>
955
<div class="refsect1">
956
<a name="libs-gstvaapiimage.other_details"></a><h2>Types and Values</h2>
141
957
<div class="refsect2">
142
958
<a name="GstVaapiImage"></a><h3>GstVaapiImage</h3>
143
959
<pre class="programlisting">typedef struct {
151
<div class="refsect2">
152
<a name="gst-vaapi-image-new"></a><h3>gst_vaapi_image_new ()</h3>
153
<pre class="programlisting"><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="returnvalue">GstVaapiImage</span></a> * gst_vaapi_image_new (<em class="parameter"><code><a class="link" href="libs-GstVaapiDisplay.html#GstVaapiDisplay" title="GstVaapiDisplay"><span class="type">GstVaapiDisplay</span></a> *display</code></em>,
154
<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideo.html#GstVideoFormat"><span class="type">GstVideoFormat</span></a> format</code></em>,
155
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> width</code></em>,
156
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> height</code></em>);</pre>
158
Creates a new <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> with the specified format and
161
<div class="variablelist"><table border="0" class="variablelist">
163
<col align="left" valign="top">
168
<td><p><span class="term"><em class="parameter"><code>display</code></em> :</span></p></td>
169
<td>a <a class="link" href="libs-GstVaapiDisplay.html#GstVaapiDisplay" title="GstVaapiDisplay"><span class="type">GstVaapiDisplay</span></a>
173
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
174
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideo.html#GstVideoFormat"><span class="type">GstVideoFormat</span></a>
178
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
179
<td>the requested image width</td>
182
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
183
<td>the requested image height</td>
186
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
187
<td>the newly allocated <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> object</td>
193
<div class="refsect2">
194
<a name="gst-vaapi-image-new-with-image"></a><h3>gst_vaapi_image_new_with_image ()</h3>
195
<pre class="programlisting"><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="returnvalue">GstVaapiImage</span></a> * gst_vaapi_image_new_with_image (<em class="parameter"><code><a class="link" href="libs-GstVaapiDisplay.html#GstVaapiDisplay" title="GstVaapiDisplay"><span class="type">GstVaapiDisplay</span></a> *display</code></em>,
196
<em class="parameter"><code><span class="type">VAImage</span> *va_image</code></em>);</pre>
198
Creates a new <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> from a foreign VA image. The image
199
format and dimensions will be extracted from <em class="parameter"><code>va_image</code></em>. This
200
function is mainly used by <a class="link" href="libs-gstvaapisurface.html#gst-vaapi-surface-derive-image" title="gst_vaapi_surface_derive_image ()"><code class="function">gst_vaapi_surface_derive_image()</code></a> to bind
201
a VA image to a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> object.
203
<div class="variablelist"><table border="0" class="variablelist">
205
<col align="left" valign="top">
210
<td><p><span class="term"><em class="parameter"><code>display</code></em> :</span></p></td>
211
<td>a <a class="link" href="libs-GstVaapiDisplay.html#GstVaapiDisplay" title="GstVaapiDisplay"><span class="type">GstVaapiDisplay</span></a>
215
<td><p><span class="term"><em class="parameter"><code>va_image</code></em> :</span></p></td>
219
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
220
<td>the newly allocated <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> object</td>
226
<div class="refsect2">
227
<a name="gst-vaapi-image-get-id"></a><h3>gst_vaapi_image_get_id ()</h3>
228
<pre class="programlisting"><a class="link" href="libs-Basic-data-structures.html#GstVaapiID" title="GstVaapiID"><span class="returnvalue">GstVaapiID</span></a> gst_vaapi_image_get_id (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);</pre>
230
Returns the underlying VAImageID of the <em class="parameter"><code>image</code></em>.
232
<div class="variablelist"><table border="0" class="variablelist">
234
<col align="left" valign="top">
239
<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td>
240
<td>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a>
244
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
245
<td>the underlying VA image id</td>
251
<div class="refsect2">
252
<a name="gst-vaapi-image-get-image"></a><h3>gst_vaapi_image_get_image ()</h3>
253
<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_image_get_image (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>,
254
<em class="parameter"><code><span class="type">VAImage</span> *va_image</code></em>);</pre>
256
Fills <em class="parameter"><code>va_image</code></em> with the VA image used internally.
258
<div class="variablelist"><table border="0" class="variablelist">
260
<col align="left" valign="top">
265
<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td>
266
<td>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a>
270
<td><p><span class="term"><em class="parameter"><code>va_image</code></em> :</span></p></td>
274
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
276
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success</td>
282
<div class="refsect2">
283
<a name="gst-vaapi-image-get-format"></a><h3>gst_vaapi_image_get_format ()</h3>
284
<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideo.html#GstVideoFormat"><span class="returnvalue">GstVideoFormat</span></a> gst_vaapi_image_get_format (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);</pre>
286
Returns the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideo.html#GstVideoFormat"><span class="type">GstVideoFormat</span></a> the <em class="parameter"><code>image</code></em> was created with.
288
<div class="variablelist"><table border="0" class="variablelist">
290
<col align="left" valign="top">
295
<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td>
296
<td>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a>
300
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
301
<td>the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideo.html#GstVideoFormat"><span class="type">GstVideoFormat</span></a>
308
<div class="refsect2">
309
<a name="gst-vaapi-image-get-width"></a><h3>gst_vaapi_image_get_width ()</h3>
310
<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_image_get_width (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);</pre>
312
Returns the <em class="parameter"><code>image</code></em> width.
314
<div class="variablelist"><table border="0" class="variablelist">
316
<col align="left" valign="top">
321
<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td>
322
<td>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a>
326
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
327
<td>the image width, in pixels</td>
333
<div class="refsect2">
334
<a name="gst-vaapi-image-get-height"></a><h3>gst_vaapi_image_get_height ()</h3>
335
<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_image_get_height (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);</pre>
337
Returns the <em class="parameter"><code>image</code></em> height.
339
<div class="variablelist"><table border="0" class="variablelist">
341
<col align="left" valign="top">
346
<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td>
347
<td>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a>
351
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
352
<td>the image height, in pixels.</td>
358
<div class="refsect2">
359
<a name="gst-vaapi-image-get-size"></a><h3>gst_vaapi_image_get_size ()</h3>
360
<pre class="programlisting"><span class="returnvalue">void</span> gst_vaapi_image_get_size (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>,
361
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *pwidth</code></em>,
362
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *pheight</code></em>);</pre>
364
Retrieves the dimensions of a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a>.
366
<div class="variablelist"><table border="0" class="variablelist">
368
<col align="left" valign="top">
373
<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td>
374
<td>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a>
378
<td><p><span class="term"><em class="parameter"><code>pwidth</code></em> :</span></p></td>
379
<td>return location for the width, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
383
<td><p><span class="term"><em class="parameter"><code>pheight</code></em> :</span></p></td>
384
<td>return location for the height, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
391
<div class="refsect2">
392
<a name="gst-vaapi-image-is-linear"></a><h3>gst_vaapi_image_is_linear ()</h3>
393
<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_image_is_linear (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);</pre>
395
Checks whether the <em class="parameter"><code>image</code></em> has data planes allocated from a single
396
buffer and offsets into that buffer are in increasing order with
397
the number of planes.
399
<div class="variablelist"><table border="0" class="variablelist">
401
<col align="left" valign="top">
406
<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td>
407
<td>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a>
411
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
413
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if image data planes are allocated from a single buffer</td>
419
<div class="refsect2">
420
<a name="gst-vaapi-image-is-mapped"></a><h3>gst_vaapi_image_is_mapped ()</h3>
421
<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_image_is_mapped (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);</pre>
423
Checks whether the <em class="parameter"><code>image</code></em> is currently mapped or not.
425
<div class="variablelist"><table border="0" class="variablelist">
427
<col align="left" valign="top">
432
<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td>
433
<td>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a>
437
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
439
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the <em class="parameter"><code>image</code></em> is mapped</td>
445
<div class="refsect2">
446
<a name="gst-vaapi-image-map"></a><h3>gst_vaapi_image_map ()</h3>
447
<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_image_map (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);</pre>
449
Maps the image data buffer. The actual pixels are returned by the
450
<a class="link" href="libs-gstvaapiimage.html#gst-vaapi-image-get-plane" title="gst_vaapi_image_get_plane ()"><code class="function">gst_vaapi_image_get_plane()</code></a> function.
452
<div class="variablelist"><table border="0" class="variablelist">
454
<col align="left" valign="top">
459
<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td>
460
<td>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a>
464
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
466
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success</td>
472
<div class="refsect2">
473
<a name="gst-vaapi-image-unmap"></a><h3>gst_vaapi_image_unmap ()</h3>
474
<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_image_unmap (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);</pre>
476
Unmaps the image data buffer. Pointers to pixels returned by
477
<a class="link" href="libs-gstvaapiimage.html#gst-vaapi-image-get-plane" title="gst_vaapi_image_get_plane ()"><code class="function">gst_vaapi_image_get_plane()</code></a> are then no longer valid.
479
<div class="variablelist"><table border="0" class="variablelist">
481
<col align="left" valign="top">
486
<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td>
487
<td>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a>
491
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
493
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success</td>
499
<div class="refsect2">
500
<a name="gst-vaapi-image-get-plane-count"></a><h3>gst_vaapi_image_get_plane_count ()</h3>
501
<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_image_get_plane_count (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);</pre>
503
Retrieves the number of planes available in the <em class="parameter"><code>image</code></em>. The <em class="parameter"><code>image</code></em>
504
must be mapped for this function to work properly.
506
<div class="variablelist"><table border="0" class="variablelist">
508
<col align="left" valign="top">
513
<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td>
514
<td>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a>
518
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
519
<td>the number of planes available in the <em class="parameter"><code>image</code></em>
526
<div class="refsect2">
527
<a name="gst-vaapi-image-get-plane"></a><h3>gst_vaapi_image_get_plane ()</h3>
528
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="returnvalue">guchar</span></a> * gst_vaapi_image_get_plane (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>,
529
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> plane</code></em>);</pre>
531
Retrieves the pixels data to the specified <em class="parameter"><code>plane</code></em>. The <em class="parameter"><code>image</code></em> must
532
be mapped for this function to work properly.
534
<div class="variablelist"><table border="0" class="variablelist">
536
<col align="left" valign="top">
541
<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td>
542
<td>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a>
546
<td><p><span class="term"><em class="parameter"><code>plane</code></em> :</span></p></td>
547
<td>the requested plane number</td>
550
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
551
<td>the pixels data of the specified <em class="parameter"><code>plane</code></em>
558
<div class="refsect2">
559
<a name="gst-vaapi-image-get-pitch"></a><h3>gst_vaapi_image_get_pitch ()</h3>
560
<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_image_get_pitch (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>,
561
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> plane</code></em>);</pre>
563
Retrieves the line size (stride) of the specified <em class="parameter"><code>plane</code></em>. The
564
<em class="parameter"><code>image</code></em> must be mapped for this function to work properly.
566
<div class="variablelist"><table border="0" class="variablelist">
568
<col align="left" valign="top">
573
<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td>
574
<td>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a>
578
<td><p><span class="term"><em class="parameter"><code>plane</code></em> :</span></p></td>
579
<td>the requested plane number</td>
582
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
583
<td>the line size (stride) of the specified plane</td>
589
<div class="refsect2">
590
<a name="gst-vaapi-image-get-data-size"></a><h3>gst_vaapi_image_get_data_size ()</h3>
591
<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_image_get_data_size (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>);</pre>
593
Retrieves the underlying image data size. This function could be
594
used to determine whether the image has a compatible layout with
595
another image structure.
597
<div class="variablelist"><table border="0" class="variablelist">
599
<col align="left" valign="top">
604
<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td>
605
<td>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a>
609
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
610
<td>the whole image data size of the <em class="parameter"><code>image</code></em>
617
<div class="refsect2">
618
<a name="gst-vaapi-image-get-buffer"></a><h3>gst_vaapi_image_get_buffer ()</h3>
619
<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_image_get_buffer (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>,
620
<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buffer</code></em>,
621
<em class="parameter"><code><a class="link" href="libs-Basic-data-structures.html#GstVaapiRectangle" title="struct GstVaapiRectangle"><span class="type">GstVaapiRectangle</span></a> *rect</code></em>);</pre>
623
Transfers pixels data contained in the <em class="parameter"><code>image</code></em> into the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a>.
624
Both image structures shall have the same format.
626
<div class="variablelist"><table border="0" class="variablelist">
628
<col align="left" valign="top">
633
<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td>
634
<td>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a>
638
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
639
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a>
643
<td><p><span class="term"><em class="parameter"><code>rect</code></em> :</span></p></td>
644
<td>a <a class="link" href="libs-Basic-data-structures.html#GstVaapiRectangle" title="struct GstVaapiRectangle"><span class="type">GstVaapiRectangle</span></a> expressing a region, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for the
648
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
650
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success</td>
656
<div class="refsect2">
657
<a name="gst-vaapi-image-update-from-buffer"></a><h3>gst_vaapi_image_update_from_buffer ()</h3>
658
<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_image_update_from_buffer (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *image</code></em>,
659
<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buffer</code></em>,
660
<em class="parameter"><code><a class="link" href="libs-Basic-data-structures.html#GstVaapiRectangle" title="struct GstVaapiRectangle"><span class="type">GstVaapiRectangle</span></a> *rect</code></em>);</pre>
662
Transfers pixels data contained in the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> into the
663
<em class="parameter"><code>image</code></em>. Both image structures shall have the same format.
665
<div class="variablelist"><table border="0" class="variablelist">
667
<col align="left" valign="top">
672
<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td>
673
<td>a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a>
677
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
678
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a>
682
<td><p><span class="term"><em class="parameter"><code>rect</code></em> :</span></p></td>
683
<td>a <a class="link" href="libs-Basic-data-structures.html#GstVaapiRectangle" title="struct GstVaapiRectangle"><span class="type">GstVaapiRectangle</span></a> expressing a region, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for the
687
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
689
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success</td>
695
<div class="refsect2">
696
<a name="gst-vaapi-image-copy"></a><h3>gst_vaapi_image_copy ()</h3>
697
<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_image_copy (<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *dst_image</code></em>,
698
<em class="parameter"><code><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a> *src_image</code></em>);</pre>
700
Copies pixels data from <em class="parameter"><code>src_image</code></em> to <em class="parameter"><code>dst_image</code></em>. Both images shall
701
have the same format and size.
703
<div class="variablelist"><table border="0" class="variablelist">
705
<col align="left" valign="top">
710
<td><p><span class="term"><em class="parameter"><code>dst_image</code></em> :</span></p></td>
711
<td>the target <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a>
715
<td><p><span class="term"><em class="parameter"><code>src_image</code></em> :</span></p></td>
716
<td>the source <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a>
720
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
722
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success</td>
962
<p>A VA image wrapper</p>
729
966
<div class="footer">
731
Generated by GTK-Doc V1.19</div>
968
Generated by GTK-Doc V1.20</div>
b'\\ No newline at end of file'