~ubuntu-branches/ubuntu/vivid/gstreamer-vaapi/vivid

« back to all changes in this revision

Viewing changes to docs/reference/libs/html/libs-gstvaapiimage.html

  • Committer: Package Import Robot
  • Author(s): Vincent Cheng
  • Date: 2014-08-06 23:56:00 UTC
  • mfrom: (0.1.4 sid) (1.1.3)
  • Revision ID: package-import@ubuntu.com-20140806235600-fg1kcmiu67k315q5
Tags: 0.5.9-2
* Remove spurious build-deps: libva-drm1, libavcodec-dev. (Closes: #757283)
* Drop Build-Depends-Indep and build docs unconditionally on all archs.

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
<html>
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>GstVaapiImage</title>
 
5
<title>GStreamer VA-API Plugins 1.2 Library Reference Manual: GstVaapiImage</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="GStreamer VA-API Plugins 1.2 Library Reference Manual">
8
8
<link rel="up" href="ch01.html" title="gst-plugins-vaapi Library">
9
9
<link rel="prev" href="libs-gstvaapisurface.html" title="GstVaapiSurface">
10
10
<link rel="next" href="libs-GstVaapiSubpicture.html" title="GstVaapiSubpicture">
11
 
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
 
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16
 
<tr valign="middle">
17
 
<td><a accesskey="p" href="libs-gstvaapisurface.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
 
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
 
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
 
<th width="100%" align="center">GStreamer VA-API Plugins 1.2 Library Reference Manual</th>
21
 
<td><a accesskey="n" href="libs-GstVaapiSubpicture.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22
 
</tr>
23
 
<tr><td colspan="5" class="shortcuts">
24
 
<a href="#libs-gstvaapiimage.synopsis" class="shortcut">Top</a>
25
 
                   | 
26
 
                  <a href="#libs-gstvaapiimage.description" class="shortcut">Description</a>
27
 
</td></tr>
28
 
</table>
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
 
16
<td width="100%" align="left" class="shortcuts">
 
17
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 
 
18
                  <a href="#libs-gstvaapiimage.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
 
19
                  <a href="#libs-gstvaapiimage.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
 
20
</td>
 
21
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
 
22
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
 
23
<td><a accesskey="p" href="libs-gstvaapisurface.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
 
24
<td><a accesskey="n" href="libs-GstVaapiSubpicture.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
 
25
</tr></table>
29
26
<div class="refentry">
30
27
<a name="libs-gstvaapiimage"></a><div class="titlepage"></div>
31
28
<div class="refnamediv"><table width="100%"><tr>
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>
35
32
</td>
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">
 
38
<colgroup>
 
39
<col width="150px" class="functions_return">
 
40
<col class="functions_name">
 
41
</colgroup>
 
42
<tbody>
 
43
<tr>
 
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>
 
47
</td>
 
48
</tr>
 
49
<tr>
 
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>
 
53
</td>
 
54
</tr>
 
55
<tr>
 
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>
 
59
</td>
 
60
</tr>
 
61
<tr>
 
62
<td class="function_type">
 
63
<a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="returnvalue">GstVaapiImage</span></a> *
 
64
</td>
 
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>
 
67
</td>
 
68
</tr>
 
69
<tr>
 
70
<td class="function_type">
 
71
<a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="returnvalue">GstVaapiImage</span></a> *
 
72
</td>
 
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>
 
75
</td>
 
76
</tr>
 
77
<tr>
 
78
<td class="function_type">
 
79
<a class="link" href="libs-Basic-data-structures.html#GstVaapiID" title="GstVaapiID"><span class="returnvalue">GstVaapiID</span></a>
 
80
</td>
 
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>
 
83
</td>
 
84
</tr>
 
85
<tr>
 
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>
 
88
</td>
 
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>
 
91
</td>
 
92
</tr>
 
93
<tr>
 
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>
 
96
</td>
 
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>
 
99
</td>
 
100
</tr>
 
101
<tr>
 
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>
 
104
</td>
 
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>
 
107
</td>
 
108
</tr>
 
109
<tr>
 
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>
 
112
</td>
 
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>
 
115
</td>
 
116
</tr>
 
117
<tr>
 
118
<td class="function_type">
 
119
<span class="returnvalue">void</span>
 
120
</td>
 
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>
 
123
</td>
 
124
</tr>
 
125
<tr>
 
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>
 
128
</td>
 
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>
 
131
</td>
 
132
</tr>
 
133
<tr>
 
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>
 
136
</td>
 
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>
 
139
</td>
 
140
</tr>
 
141
<tr>
 
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>
 
144
</td>
 
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>
 
147
</td>
 
148
</tr>
 
149
<tr>
 
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>
 
152
</td>
 
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>
 
155
</td>
 
156
</tr>
 
157
<tr>
 
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>
 
160
</td>
 
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>
 
163
</td>
 
164
</tr>
 
165
<tr>
 
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> *
 
168
</td>
 
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>
 
171
</td>
 
172
</tr>
 
173
<tr>
 
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>
 
176
</td>
 
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>
 
179
</td>
 
180
</tr>
 
181
<tr>
 
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>
 
184
</td>
 
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>
 
187
</td>
 
188
</tr>
 
189
<tr>
 
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>
 
192
</td>
 
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>
 
195
</td>
 
196
</tr>
 
197
<tr>
 
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>
 
200
</td>
 
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>
 
203
</td>
 
204
</tr>
 
205
<tr>
 
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>
 
208
</td>
 
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>
 
211
</td>
 
212
</tr>
 
213
</tbody>
 
214
</table></div>
 
215
</div>
 
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">
 
219
<colgroup>
 
220
<col width="150px" class="name">
 
221
<col class="description">
 
222
</colgroup>
 
223
<tbody><tr>
 
224
<td class="datatype_keyword"> </td>
 
225
<td class="function_name"><a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage">GstVaapiImage</a></td>
 
226
</tr></tbody>
 
227
</table></div>
 
228
</div>
 
229
<div class="refsect1">
 
230
<a name="libs-gstvaapiimage.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
231
<pre class="screen">
77
232
</pre>
78
233
</div>
79
234
<div class="refsect1">
80
235
<a name="libs-gstvaapiimage.description"></a><h2>Description</h2>
81
236
</div>
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>
87
 
<p>
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>.
89
 
</p>
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>
 
243
.</p>
 
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">
91
247
<colgroup>
92
 
<col align="left" valign="top">
93
 
<col>
 
248
<col width="150px" class="parameters_name">
 
249
<col class="parameters_description">
 
250
<col width="200px" class="parameters_annotations">
94
251
</colgroup>
95
252
<tbody><tr>
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>
98
 
</td>
 
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>
99
256
</tr></tbody>
100
257
</table></div>
101
258
</div>
 
259
</div>
102
260
<hr>
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>
106
 
<p>
107
 
Macro that evaluates to the width of <em class="parameter"><code>image</code></em>.
108
 
</p>
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>
 
265
.</p>
 
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">
110
269
<colgroup>
111
 
<col align="left" valign="top">
112
 
<col>
 
270
<col width="150px" class="parameters_name">
 
271
<col class="parameters_description">
 
272
<col width="200px" class="parameters_annotations">
113
273
</colgroup>
114
274
<tbody><tr>
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>
117
 
</td>
 
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>
118
278
</tr></tbody>
119
279
</table></div>
120
280
</div>
 
281
</div>
121
282
<hr>
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>
125
 
<p>
126
 
Macro that evaluates to the height of <em class="parameter"><code>image</code></em>.
127
 
</p>
128
 
<div class="variablelist"><table border="0" class="variablelist">
129
 
<colgroup>
130
 
<col align="left" valign="top">
131
 
<col>
132
 
</colgroup>
133
 
<tbody><tr>
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>
136
 
</td>
137
 
</tr></tbody>
138
 
</table></div>
139
 
</div>
140
 
<hr>
 
286
<p>Macro that evaluates to the height of <em class="parameter"><code>image</code></em>
 
287
.</p>
 
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">
 
291
<colgroup>
 
292
<col width="150px" class="parameters_name">
 
293
<col class="parameters_description">
 
294
<col width="200px" class="parameters_annotations">
 
295
</colgroup>
 
296
<tbody><tr>
 
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>
 
300
</tr></tbody>
 
301
</table></div>
 
302
</div>
 
303
</div>
 
304
<hr>
 
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
 
313
dimensions.</p>
 
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">
 
317
<colgroup>
 
318
<col width="150px" class="parameters_name">
 
319
<col class="parameters_description">
 
320
<col width="200px" class="parameters_annotations">
 
321
</colgroup>
 
322
<tbody>
 
323
<tr>
 
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>
 
327
</tr>
 
328
<tr>
 
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>
 
332
</tr>
 
333
<tr>
 
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>
 
337
</tr>
 
338
<tr>
 
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>
 
342
</tr>
 
343
</tbody>
 
344
</table></div>
 
345
</div>
 
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>
 
349
<p></p>
 
350
</div>
 
351
</div>
 
352
<hr>
 
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>
 
360
. This
 
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">
 
366
<colgroup>
 
367
<col width="150px" class="parameters_name">
 
368
<col class="parameters_description">
 
369
<col width="200px" class="parameters_annotations">
 
370
</colgroup>
 
371
<tbody>
 
372
<tr>
 
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>
 
376
</tr>
 
377
<tr>
 
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>
 
381
</tr>
 
382
</tbody>
 
383
</table></div>
 
384
</div>
 
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>
 
388
<p></p>
 
389
</div>
 
390
</div>
 
391
<hr>
 
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>
 
397
.</p>
 
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">
 
401
<colgroup>
 
402
<col width="150px" class="parameters_name">
 
403
<col class="parameters_description">
 
404
<col width="200px" class="parameters_annotations">
 
405
</colgroup>
 
406
<tbody><tr>
 
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>
 
410
</tr></tbody>
 
411
</table></div>
 
412
</div>
 
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>
 
416
<p></p>
 
417
</div>
 
418
</div>
 
419
<hr>
 
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">
 
430
<colgroup>
 
431
<col width="150px" class="parameters_name">
 
432
<col class="parameters_description">
 
433
<col width="200px" class="parameters_annotations">
 
434
</colgroup>
 
435
<tbody>
 
436
<tr>
 
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>
 
440
</tr>
 
441
<tr>
 
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>
 
445
</tr>
 
446
</tbody>
 
447
</table></div>
 
448
</div>
 
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>
 
452
<p></p>
 
453
</div>
 
454
</div>
 
455
<hr>
 
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">
 
465
<colgroup>
 
466
<col width="150px" class="parameters_name">
 
467
<col class="parameters_description">
 
468
<col width="200px" class="parameters_annotations">
 
469
</colgroup>
 
470
<tbody><tr>
 
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>
 
474
</tr></tbody>
 
475
</table></div>
 
476
</div>
 
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>
 
480
<p></p>
 
481
</div>
 
482
</div>
 
483
<hr>
 
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>
 
489
 width.</p>
 
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">
 
493
<colgroup>
 
494
<col width="150px" class="parameters_name">
 
495
<col class="parameters_description">
 
496
<col width="200px" class="parameters_annotations">
 
497
</colgroup>
 
498
<tbody><tr>
 
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>
 
502
</tr></tbody>
 
503
</table></div>
 
504
</div>
 
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>
 
508
<p></p>
 
509
</div>
 
510
</div>
 
511
<hr>
 
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>
 
517
 height.</p>
 
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">
 
521
<colgroup>
 
522
<col width="150px" class="parameters_name">
 
523
<col class="parameters_description">
 
524
<col width="200px" class="parameters_annotations">
 
525
</colgroup>
 
526
<tbody><tr>
 
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>
 
530
</tr></tbody>
 
531
</table></div>
 
532
</div>
 
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>
 
536
<p></p>
 
537
</div>
 
538
</div>
 
539
<hr>
 
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">
 
550
<colgroup>
 
551
<col width="150px" class="parameters_name">
 
552
<col class="parameters_description">
 
553
<col width="200px" class="parameters_annotations">
 
554
</colgroup>
 
555
<tbody>
 
556
<tr>
 
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>
 
560
</tr>
 
561
<tr>
 
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>
 
565
</tr>
 
566
<tr>
 
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>
 
570
</tr>
 
571
</tbody>
 
572
</table></div>
 
573
</div>
 
574
</div>
 
575
<hr>
 
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">
 
587
<colgroup>
 
588
<col width="150px" class="parameters_name">
 
589
<col class="parameters_description">
 
590
<col width="200px" class="parameters_annotations">
 
591
</colgroup>
 
592
<tbody><tr>
 
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>
 
596
</tr></tbody>
 
597
</table></div>
 
598
</div>
 
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>
 
602
<p></p>
 
603
</div>
 
604
</div>
 
605
<hr>
 
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">
 
615
<colgroup>
 
616
<col width="150px" class="parameters_name">
 
617
<col class="parameters_description">
 
618
<col width="200px" class="parameters_annotations">
 
619
</colgroup>
 
620
<tbody><tr>
 
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>
 
624
</tr></tbody>
 
625
</table></div>
 
626
</div>
 
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>
 
630
is mapped</p>
 
631
<p></p>
 
632
</div>
 
633
</div>
 
634
<hr>
 
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">
 
644
<colgroup>
 
645
<col width="150px" class="parameters_name">
 
646
<col class="parameters_description">
 
647
<col width="200px" class="parameters_annotations">
 
648
</colgroup>
 
649
<tbody><tr>
 
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>
 
653
</tr></tbody>
 
654
</table></div>
 
655
</div>
 
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>
 
659
<p></p>
 
660
</div>
 
661
</div>
 
662
<hr>
 
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">
 
672
<colgroup>
 
673
<col width="150px" class="parameters_name">
 
674
<col class="parameters_description">
 
675
<col width="200px" class="parameters_annotations">
 
676
</colgroup>
 
677
<tbody><tr>
 
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>
 
681
</tr></tbody>
 
682
</table></div>
 
683
</div>
 
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>
 
687
<p></p>
 
688
</div>
 
689
</div>
 
690
<hr>
 
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>
 
697
 
 
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">
 
702
<colgroup>
 
703
<col width="150px" class="parameters_name">
 
704
<col class="parameters_description">
 
705
<col width="200px" class="parameters_annotations">
 
706
</colgroup>
 
707
<tbody><tr>
 
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>
 
711
</tr></tbody>
 
712
</table></div>
 
713
</div>
 
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>
 
717
</p>
 
718
<p></p>
 
719
</div>
 
720
</div>
 
721
<hr>
 
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>
 
729
 must
 
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">
 
734
<colgroup>
 
735
<col width="150px" class="parameters_name">
 
736
<col class="parameters_description">
 
737
<col width="200px" class="parameters_annotations">
 
738
</colgroup>
 
739
<tbody>
 
740
<tr>
 
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>
 
744
</tr>
 
745
<tr>
 
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>
 
749
</tr>
 
750
</tbody>
 
751
</table></div>
 
752
</div>
 
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>
 
756
</p>
 
757
<p></p>
 
758
</div>
 
759
</div>
 
760
<hr>
 
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>
 
767
. The
 
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">
 
773
<colgroup>
 
774
<col width="150px" class="parameters_name">
 
775
<col class="parameters_description">
 
776
<col width="200px" class="parameters_annotations">
 
777
</colgroup>
 
778
<tbody>
 
779
<tr>
 
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>
 
783
</tr>
 
784
<tr>
 
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>
 
788
</tr>
 
789
</tbody>
 
790
</table></div>
 
791
</div>
 
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>
 
795
<p></p>
 
796
</div>
 
797
</div>
 
798
<hr>
 
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">
 
809
<colgroup>
 
810
<col width="150px" class="parameters_name">
 
811
<col class="parameters_description">
 
812
<col width="200px" class="parameters_annotations">
 
813
</colgroup>
 
814
<tbody><tr>
 
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>
 
818
</tr></tbody>
 
819
</table></div>
 
820
</div>
 
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>
 
824
</p>
 
825
<p></p>
 
826
</div>
 
827
</div>
 
828
<hr>
 
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">
 
841
<colgroup>
 
842
<col width="150px" class="parameters_name">
 
843
<col class="parameters_description">
 
844
<col width="200px" class="parameters_annotations">
 
845
</colgroup>
 
846
<tbody>
 
847
<tr>
 
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>
 
851
</tr>
 
852
<tr>
 
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>
 
856
</tr>
 
857
<tr>
 
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
 
860
whole image</p></td>
 
861
<td class="parameter_annotations"> </td>
 
862
</tr>
 
863
</tbody>
 
864
</table></div>
 
865
</div>
 
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>
 
869
<p></p>
 
870
</div>
 
871
</div>
 
872
<hr>
 
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">
 
885
<colgroup>
 
886
<col width="150px" class="parameters_name">
 
887
<col class="parameters_description">
 
888
<col width="200px" class="parameters_annotations">
 
889
</colgroup>
 
890
<tbody>
 
891
<tr>
 
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>
 
895
</tr>
 
896
<tr>
 
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>
 
900
</tr>
 
901
<tr>
 
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
 
904
whole image</p></td>
 
905
<td class="parameter_annotations"> </td>
 
906
</tr>
 
907
</tbody>
 
908
</table></div>
 
909
</div>
 
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>
 
913
<p></p>
 
914
</div>
 
915
</div>
 
916
<hr>
 
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>
 
924
. Both images shall
 
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">
 
929
<colgroup>
 
930
<col width="150px" class="parameters_name">
 
931
<col class="parameters_description">
 
932
<col width="200px" class="parameters_annotations">
 
933
</colgroup>
 
934
<tbody>
 
935
<tr>
 
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>
 
939
</tr>
 
940
<tr>
 
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>
 
944
</tr>
 
945
</tbody>
 
946
</table></div>
 
947
</div>
 
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>
 
951
<p></p>
 
952
</div>
 
953
</div>
 
954
</div>
 
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 {
144
960
} GstVaapiImage;
145
961
</pre>
146
 
<p>
147
 
A VA image wrapper
148
 
</p>
149
 
</div>
150
 
<hr>
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>
157
 
<p>
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
159
 
dimensions.
160
 
</p>
161
 
<div class="variablelist"><table border="0" class="variablelist">
162
 
<colgroup>
163
 
<col align="left" valign="top">
164
 
<col>
165
 
</colgroup>
166
 
<tbody>
167
 
<tr>
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>
170
 
</td>
171
 
</tr>
172
 
<tr>
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>
175
 
</td>
176
 
</tr>
177
 
<tr>
178
 
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
179
 
<td>the requested image width</td>
180
 
</tr>
181
 
<tr>
182
 
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
183
 
<td>the requested image height</td>
184
 
</tr>
185
 
<tr>
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>
188
 
</tr>
189
 
</tbody>
190
 
</table></div>
191
 
</div>
192
 
<hr>
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>
197
 
<p>
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.
202
 
</p>
203
 
<div class="variablelist"><table border="0" class="variablelist">
204
 
<colgroup>
205
 
<col align="left" valign="top">
206
 
<col>
207
 
</colgroup>
208
 
<tbody>
209
 
<tr>
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>
212
 
</td>
213
 
</tr>
214
 
<tr>
215
 
<td><p><span class="term"><em class="parameter"><code>va_image</code></em> :</span></p></td>
216
 
<td>a VA image</td>
217
 
</tr>
218
 
<tr>
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>
221
 
</tr>
222
 
</tbody>
223
 
</table></div>
224
 
</div>
225
 
<hr>
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>
229
 
<p>
230
 
Returns the underlying VAImageID of the <em class="parameter"><code>image</code></em>.
231
 
</p>
232
 
<div class="variablelist"><table border="0" class="variablelist">
233
 
<colgroup>
234
 
<col align="left" valign="top">
235
 
<col>
236
 
</colgroup>
237
 
<tbody>
238
 
<tr>
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>
241
 
</td>
242
 
</tr>
243
 
<tr>
244
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
245
 
<td>the underlying VA image id</td>
246
 
</tr>
247
 
</tbody>
248
 
</table></div>
249
 
</div>
250
 
<hr>
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>
255
 
<p>
256
 
Fills <em class="parameter"><code>va_image</code></em> with the VA image used internally.
257
 
</p>
258
 
<div class="variablelist"><table border="0" class="variablelist">
259
 
<colgroup>
260
 
<col align="left" valign="top">
261
 
<col>
262
 
</colgroup>
263
 
<tbody>
264
 
<tr>
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>
267
 
</td>
268
 
</tr>
269
 
<tr>
270
 
<td><p><span class="term"><em class="parameter"><code>va_image</code></em> :</span></p></td>
271
 
<td>a VA image</td>
272
 
</tr>
273
 
<tr>
274
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
275
 
<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>
277
 
</tr>
278
 
</tbody>
279
 
</table></div>
280
 
</div>
281
 
<hr>
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>
285
 
<p>
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.
287
 
</p>
288
 
<div class="variablelist"><table border="0" class="variablelist">
289
 
<colgroup>
290
 
<col align="left" valign="top">
291
 
<col>
292
 
</colgroup>
293
 
<tbody>
294
 
<tr>
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>
297
 
</td>
298
 
</tr>
299
 
<tr>
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>
302
 
</td>
303
 
</tr>
304
 
</tbody>
305
 
</table></div>
306
 
</div>
307
 
<hr>
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>
311
 
<p>
312
 
Returns the <em class="parameter"><code>image</code></em> width.
313
 
</p>
314
 
<div class="variablelist"><table border="0" class="variablelist">
315
 
<colgroup>
316
 
<col align="left" valign="top">
317
 
<col>
318
 
</colgroup>
319
 
<tbody>
320
 
<tr>
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>
323
 
</td>
324
 
</tr>
325
 
<tr>
326
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
327
 
<td>the image width, in pixels</td>
328
 
</tr>
329
 
</tbody>
330
 
</table></div>
331
 
</div>
332
 
<hr>
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>
336
 
<p>
337
 
Returns the <em class="parameter"><code>image</code></em> height.
338
 
</p>
339
 
<div class="variablelist"><table border="0" class="variablelist">
340
 
<colgroup>
341
 
<col align="left" valign="top">
342
 
<col>
343
 
</colgroup>
344
 
<tbody>
345
 
<tr>
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>
348
 
</td>
349
 
</tr>
350
 
<tr>
351
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
352
 
<td>the image height, in pixels.</td>
353
 
</tr>
354
 
</tbody>
355
 
</table></div>
356
 
</div>
357
 
<hr>
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>
363
 
<p>
364
 
Retrieves the dimensions of a <a class="link" href="libs-gstvaapiimage.html#GstVaapiImage" title="GstVaapiImage"><span class="type">GstVaapiImage</span></a>.
365
 
</p>
366
 
<div class="variablelist"><table border="0" class="variablelist">
367
 
<colgroup>
368
 
<col align="left" valign="top">
369
 
<col>
370
 
</colgroup>
371
 
<tbody>
372
 
<tr>
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>
375
 
</td>
376
 
</tr>
377
 
<tr>
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>
380
 
</td>
381
 
</tr>
382
 
<tr>
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>
385
 
</td>
386
 
</tr>
387
 
</tbody>
388
 
</table></div>
389
 
</div>
390
 
<hr>
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>
394
 
<p>
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.
398
 
</p>
399
 
<div class="variablelist"><table border="0" class="variablelist">
400
 
<colgroup>
401
 
<col align="left" valign="top">
402
 
<col>
403
 
</colgroup>
404
 
<tbody>
405
 
<tr>
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>
408
 
</td>
409
 
</tr>
410
 
<tr>
411
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
412
 
<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>
414
 
</tr>
415
 
</tbody>
416
 
</table></div>
417
 
</div>
418
 
<hr>
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>
422
 
<p>
423
 
Checks whether the <em class="parameter"><code>image</code></em> is currently mapped or not.
424
 
</p>
425
 
<div class="variablelist"><table border="0" class="variablelist">
426
 
<colgroup>
427
 
<col align="left" valign="top">
428
 
<col>
429
 
</colgroup>
430
 
<tbody>
431
 
<tr>
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>
434
 
</td>
435
 
</tr>
436
 
<tr>
437
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
438
 
<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>
440
 
</tr>
441
 
</tbody>
442
 
</table></div>
443
 
</div>
444
 
<hr>
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>
448
 
<p>
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.
451
 
</p>
452
 
<div class="variablelist"><table border="0" class="variablelist">
453
 
<colgroup>
454
 
<col align="left" valign="top">
455
 
<col>
456
 
</colgroup>
457
 
<tbody>
458
 
<tr>
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>
461
 
</td>
462
 
</tr>
463
 
<tr>
464
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
465
 
<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>
467
 
</tr>
468
 
</tbody>
469
 
</table></div>
470
 
</div>
471
 
<hr>
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>
475
 
<p>
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.
478
 
</p>
479
 
<div class="variablelist"><table border="0" class="variablelist">
480
 
<colgroup>
481
 
<col align="left" valign="top">
482
 
<col>
483
 
</colgroup>
484
 
<tbody>
485
 
<tr>
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>
488
 
</td>
489
 
</tr>
490
 
<tr>
491
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
492
 
<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>
494
 
</tr>
495
 
</tbody>
496
 
</table></div>
497
 
</div>
498
 
<hr>
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>
502
 
<p>
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.
505
 
</p>
506
 
<div class="variablelist"><table border="0" class="variablelist">
507
 
<colgroup>
508
 
<col align="left" valign="top">
509
 
<col>
510
 
</colgroup>
511
 
<tbody>
512
 
<tr>
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>
515
 
</td>
516
 
</tr>
517
 
<tr>
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>
520
 
</td>
521
 
</tr>
522
 
</tbody>
523
 
</table></div>
524
 
</div>
525
 
<hr>
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>
530
 
<p>
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.
533
 
</p>
534
 
<div class="variablelist"><table border="0" class="variablelist">
535
 
<colgroup>
536
 
<col align="left" valign="top">
537
 
<col>
538
 
</colgroup>
539
 
<tbody>
540
 
<tr>
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>
543
 
</td>
544
 
</tr>
545
 
<tr>
546
 
<td><p><span class="term"><em class="parameter"><code>plane</code></em> :</span></p></td>
547
 
<td>the requested plane number</td>
548
 
</tr>
549
 
<tr>
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>
552
 
</td>
553
 
</tr>
554
 
</tbody>
555
 
</table></div>
556
 
</div>
557
 
<hr>
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>
562
 
<p>
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.
565
 
</p>
566
 
<div class="variablelist"><table border="0" class="variablelist">
567
 
<colgroup>
568
 
<col align="left" valign="top">
569
 
<col>
570
 
</colgroup>
571
 
<tbody>
572
 
<tr>
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>
575
 
</td>
576
 
</tr>
577
 
<tr>
578
 
<td><p><span class="term"><em class="parameter"><code>plane</code></em> :</span></p></td>
579
 
<td>the requested plane number</td>
580
 
</tr>
581
 
<tr>
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>
584
 
</tr>
585
 
</tbody>
586
 
</table></div>
587
 
</div>
588
 
<hr>
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>
592
 
<p>
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.
596
 
</p>
597
 
<div class="variablelist"><table border="0" class="variablelist">
598
 
<colgroup>
599
 
<col align="left" valign="top">
600
 
<col>
601
 
</colgroup>
602
 
<tbody>
603
 
<tr>
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>
606
 
</td>
607
 
</tr>
608
 
<tr>
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>
611
 
</td>
612
 
</tr>
613
 
</tbody>
614
 
</table></div>
615
 
</div>
616
 
<hr>
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>
622
 
<p>
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.
625
 
</p>
626
 
<div class="variablelist"><table border="0" class="variablelist">
627
 
<colgroup>
628
 
<col align="left" valign="top">
629
 
<col>
630
 
</colgroup>
631
 
<tbody>
632
 
<tr>
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>
635
 
</td>
636
 
</tr>
637
 
<tr>
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>
640
 
</td>
641
 
</tr>
642
 
<tr>
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
645
 
whole image</td>
646
 
</tr>
647
 
<tr>
648
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
649
 
<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>
651
 
</tr>
652
 
</tbody>
653
 
</table></div>
654
 
</div>
655
 
<hr>
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>
661
 
<p>
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.
664
 
</p>
665
 
<div class="variablelist"><table border="0" class="variablelist">
666
 
<colgroup>
667
 
<col align="left" valign="top">
668
 
<col>
669
 
</colgroup>
670
 
<tbody>
671
 
<tr>
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>
674
 
</td>
675
 
</tr>
676
 
<tr>
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>
679
 
</td>
680
 
</tr>
681
 
<tr>
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
684
 
whole image</td>
685
 
</tr>
686
 
<tr>
687
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
688
 
<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>
690
 
</tr>
691
 
</tbody>
692
 
</table></div>
693
 
</div>
694
 
<hr>
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>
699
 
<p>
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.
702
 
</p>
703
 
<div class="variablelist"><table border="0" class="variablelist">
704
 
<colgroup>
705
 
<col align="left" valign="top">
706
 
<col>
707
 
</colgroup>
708
 
<tbody>
709
 
<tr>
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>
712
 
</td>
713
 
</tr>
714
 
<tr>
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>
717
 
</td>
718
 
</tr>
719
 
<tr>
720
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
721
 
<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>
723
 
</tr>
724
 
</tbody>
725
 
</table></div>
 
962
<p>A VA image wrapper</p>
726
963
</div>
727
964
</div>
728
965
</div>
729
966
<div class="footer">
730
967
<hr>
731
 
          Generated by GTK-Doc V1.19</div>
 
968
          Generated by GTK-Doc V1.20</div>
732
969
</body>
733
970
</html>
 
 
b'\\ No newline at end of file'