← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/reference/libs/html/libs-Basic-data-structures.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
http://bugs.debian.org/757283
* 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:
docs/reference/libs/html/libs-Basic-data-structures.html
2
2
<html>
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>Basic data structures</title>
 
5
<title>GStreamer VA-API Plugins 1.2 Library Reference Manual: Basic data structures</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-GstVideoFormat.html" title="GstVideoFormat">
10
10
<link rel="next" href="libs-GstVaapiDisplay.html" title="GstVaapiDisplay">
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-GstVideoFormat.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-GstVaapiDisplay.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-Basic-data-structures.synopsis" class="shortcut">Top</a>
25
 
                   | 
26
 
                  <a href="#libs-Basic-data-structures.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-Basic-data-structures.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
 
19
                  <a href="#libs-Basic-data-structures.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-GstVideoFormat.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
 
24
<td><a accesskey="n" href="libs-GstVaapiDisplay.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-Basic-data-structures"></a><div class="titlepage"></div>
31
28
<div class="refnamediv"><table width="100%"><tr>
33
30
<h2><span class="refentrytitle"><a name="libs-Basic-data-structures.top_of_page"></a>Basic data structures</span></h2>
34
31
<p>Basic data structures</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-Basic-data-structures.synopsis"></a><h2>Synopsis</h2>
40
 
<pre class="synopsis">typedef             <a class="link" href="libs-Basic-data-structures.html#GstVaapiID" title="GstVaapiID">GstVaapiID</a>;
41
 
#define             <a class="link" href="libs-Basic-data-structures.html#GST-VAAPI-ID-FORMAT:CAPS" title="GST_VAAPI_ID_FORMAT">GST_VAAPI_ID_FORMAT</a>
42
 
#define             <a class="link" href="libs-Basic-data-structures.html#GST-VAAPI-ID-ARGS:CAPS" title="GST_VAAPI_ID_ARGS()">GST_VAAPI_ID_ARGS</a>                   (id)
43
 
struct              <a class="link" href="libs-Basic-data-structures.html#GstVaapiPoint" title="struct GstVaapiPoint">GstVaapiPoint</a>;
44
 
struct              <a class="link" href="libs-Basic-data-structures.html#GstVaapiRectangle" title="struct GstVaapiRectangle">GstVaapiRectangle</a>;
 
35
<div class="refsect1">
 
36
<a name="libs-Basic-data-structures.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><tr>
 
43
<td class="define_keyword">#define</td>
 
44
<td class="function_name">
 
45
<a class="link" href="libs-Basic-data-structures.html#GST-VAAPI-ID-ARGS:CAPS" title="GST_VAAPI_ID_ARGS()">GST_VAAPI_ID_ARGS</a><span class="c_punctuation">()</span>
 
46
</td>
 
47
</tr></tbody>
 
48
</table></div>
 
49
</div>
 
50
<div class="refsect1">
 
51
<a name="libs-Basic-data-structures.other"></a><h2>Types and Values</h2>
 
52
<div class="informaltable"><table width="100%" border="0">
 
53
<colgroup>
 
54
<col width="150px" class="name">
 
55
<col class="description">
 
56
</colgroup>
 
57
<tbody>
 
58
<tr>
 
59
<td class="typedef_keyword">typedef</td>
 
60
<td class="function_name"><a class="link" href="libs-Basic-data-structures.html#GstVaapiID" title="GstVaapiID">GstVaapiID</a></td>
 
61
</tr>
 
62
<tr>
 
63
<td class="define_keyword">#define</td>
 
64
<td class="function_name"><a class="link" href="libs-Basic-data-structures.html#GST-VAAPI-ID-FORMAT:CAPS" title="GST_VAAPI_ID_FORMAT">GST_VAAPI_ID_FORMAT</a></td>
 
65
</tr>
 
66
<tr>
 
67
<td class="datatype_keyword">struct</td>
 
68
<td class="function_name"><a class="link" href="libs-Basic-data-structures.html#GstVaapiPoint" title="struct GstVaapiPoint">GstVaapiPoint</a></td>
 
69
</tr>
 
70
<tr>
 
71
<td class="datatype_keyword">struct</td>
 
72
<td class="function_name"><a class="link" href="libs-Basic-data-structures.html#GstVaapiRectangle" title="struct GstVaapiRectangle">GstVaapiRectangle</a></td>
 
73
</tr>
 
74
</tbody>
 
75
</table></div>
 
76
</div>
 
77
<div class="refsect1">
 
78
<a name="libs-Basic-data-structures.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
79
<pre class="screen">
45
80
</pre>
46
81
</div>
47
82
<div class="refsect1">
50
85
</p>
51
86
</div>
52
87
<div class="refsect1">
53
 
<a name="libs-Basic-data-structures.details"></a><h2>Details</h2>
 
88
<a name="libs-Basic-data-structures.functions_details"></a><h2>Functions</h2>
 
89
<div class="refsect2">
 
90
<a name="GST-VAAPI-ID-ARGS:CAPS"></a><h3>GST_VAAPI_ID_ARGS()</h3>
 
91
<pre class="programlisting">#define GST_VAAPI_ID_ARGS(id) GSIZE_TO_POINTER(id)
 
92
</pre>
 
93
<p>Can be used together with <a class="link" href="libs-Basic-data-structures.html#GST-VAAPI-ID-FORMAT:CAPS" title="GST_VAAPI_ID_FORMAT"><span class="type">GST_VAAPI_ID_FORMAT</span></a> to properly output
 
94
an integer value in a <code class="function">printf()</code>-style text message.</p>
 
95
<div class="refsect3">
 
96
<a name="id-1.2.3.7.2.5"></a><h4>Parameters</h4>
 
97
<div class="informaltable"><table width="100%" border="0">
 
98
<colgroup>
 
99
<col width="150px" class="parameters_name">
 
100
<col class="parameters_description">
 
101
<col width="200px" class="parameters_annotations">
 
102
</colgroup>
 
103
<tbody><tr>
 
104
<td class="parameter_name"><p>id</p></td>
 
105
<td class="parameter_description"><p>a <a class="link" href="libs-Basic-data-structures.html#GstVaapiID" title="GstVaapiID"><span class="type">GstVaapiID</span></a></p></td>
 
106
<td class="parameter_annotations"> </td>
 
107
</tr></tbody>
 
108
</table></div>
 
109
</div>
 
110
</div>
 
111
</div>
 
112
<div class="refsect1">
 
113
<a name="libs-Basic-data-structures.other_details"></a><h2>Types and Values</h2>
54
114
<div class="refsect2">
55
115
<a name="GstVaapiID"></a><h3>GstVaapiID</h3>
56
116
<pre class="programlisting">typedef gsize GstVaapiID;
57
117
</pre>
58
 
<p>
59
 
An integer large enough to hold a generic VA id or a pointer
60
 
wherever necessary.
61
 
</p>
 
118
<p>An integer large enough to hold a generic VA id or a pointer
 
119
wherever necessary.</p>
62
120
</div>
63
121
<hr>
64
122
<div class="refsect2">
65
123
<a name="GST-VAAPI-ID-FORMAT:CAPS"></a><h3>GST_VAAPI_ID_FORMAT</h3>
66
124
<pre class="programlisting">#define GST_VAAPI_ID_FORMAT "p"
67
125
</pre>
68
 
<p>
69
 
Can be used together with <a class="link" href="libs-Basic-data-structures.html#GST-VAAPI-ID-ARGS:CAPS" title="GST_VAAPI_ID_ARGS()"><span class="type">GST_VAAPI_ID_ARGS</span></a> to properly output an
70
 
integer value in a <code class="function">printf()</code>-style text message.
71
 
</p>
 
126
<p>Can be used together with <a class="link" href="libs-Basic-data-structures.html#GST-VAAPI-ID-ARGS:CAPS" title="GST_VAAPI_ID_ARGS()"><span class="type">GST_VAAPI_ID_ARGS</span></a> to properly output an
 
127
integer value in a <code class="function">printf()</code>-style text message.</p>
72
128
<div class="informalexample"><pre class="programlisting">
73
129
printf("id: %" GST_VAAPI_ID_FORMAT "\n", GST_VAAPI_ID_ARGS(id));
74
130
</pre></div>
75
 
<p>
76
 
</p>
77
 
</div>
78
 
<hr>
79
 
<div class="refsect2">
80
 
<a name="GST-VAAPI-ID-ARGS:CAPS"></a><h3>GST_VAAPI_ID_ARGS()</h3>
81
 
<pre class="programlisting">#define GST_VAAPI_ID_ARGS(id) GSIZE_TO_POINTER(id)
82
 
</pre>
83
 
<p>
84
 
Can be used together with <a class="link" href="libs-Basic-data-structures.html#GST-VAAPI-ID-FORMAT:CAPS" title="GST_VAAPI_ID_FORMAT"><span class="type">GST_VAAPI_ID_FORMAT</span></a> to properly output
85
 
an integer value in a <code class="function">printf()</code>-style text message.
86
 
</p>
87
 
<div class="variablelist"><table border="0" class="variablelist">
88
 
<colgroup>
89
 
<col align="left" valign="top">
90
 
<col>
91
 
</colgroup>
92
 
<tbody><tr>
93
 
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
94
 
<td>a <a class="link" href="libs-Basic-data-structures.html#GstVaapiID" title="GstVaapiID"><span class="type">GstVaapiID</span></a>
95
 
</td>
96
 
</tr></tbody>
97
 
</table></div>
98
131
</div>
99
132
<hr>
100
133
<div class="refsect2">
104
137
    guint32 y;
105
138
};
106
139
</pre>
107
 
<p>
108
 
A location within a surface.
109
 
</p>
110
 
<div class="variablelist"><table border="0" class="variablelist">
 
140
<p>A location within a surface.</p>
 
141
<div class="refsect3">
 
142
<a name="id-1.2.3.8.4.5"></a><h4>Members</h4>
 
143
<div class="informaltable"><table width="100%" border="0">
111
144
<colgroup>
112
 
<col align="left" valign="top">
113
 
<col>
 
145
<col width="300px" class="struct_members_name">
 
146
<col class="struct_members_description">
 
147
<col width="200px" class="struct_members_annotations">
114
148
</colgroup>
115
149
<tbody>
116
150
<tr>
117
 
<td><p><span class="term"><span class="type">guint32</span> <em class="structfield"><code><a name="GstVaapiPoint.x"></a>x</code></em>;</span></p></td>
118
 
<td>X coordinate</td>
 
151
<td class="struct_member_name"><p><span class="type">guint32</span> <em class="structfield"><code><a name="GstVaapiPoint.x"></a>x</code></em>;</p></td>
 
152
<td class="struct_member_description"><p>X coordinate</p></td>
 
153
<td class="struct_member_annotations"> </td>
119
154
</tr>
120
155
<tr>
121
 
<td><p><span class="term"><span class="type">guint32</span> <em class="structfield"><code><a name="GstVaapiPoint.y"></a>y</code></em>;</span></p></td>
122
 
<td>Y coordinate</td>
 
156
<td class="struct_member_name"><p><span class="type">guint32</span> <em class="structfield"><code><a name="GstVaapiPoint.y"></a>y</code></em>;</p></td>
 
157
<td class="struct_member_description"><p>Y coordinate</p></td>
 
158
<td class="struct_member_annotations"> </td>
123
159
</tr>
124
160
</tbody>
125
161
</table></div>
126
162
</div>
 
163
</div>
127
164
<hr>
128
165
<div class="refsect2">
129
166
<a name="GstVaapiRectangle"></a><h3>struct GstVaapiRectangle</h3>
134
171
    guint32 height;
135
172
};
136
173
</pre>
137
 
<p>
138
 
A rectangle region within a surface.
139
 
</p>
140
 
<div class="variablelist"><table border="0" class="variablelist">
 
174
<p>A rectangle region within a surface.</p>
 
175
<div class="refsect3">
 
176
<a name="id-1.2.3.8.5.5"></a><h4>Members</h4>
 
177
<div class="informaltable"><table width="100%" border="0">
141
178
<colgroup>
142
 
<col align="left" valign="top">
143
 
<col>
 
179
<col width="300px" class="struct_members_name">
 
180
<col class="struct_members_description">
 
181
<col width="200px" class="struct_members_annotations">
144
182
</colgroup>
145
183
<tbody>
146
184
<tr>
147
 
<td><p><span class="term"><span class="type">guint32</span> <em class="structfield"><code><a name="GstVaapiRectangle.x"></a>x</code></em>;</span></p></td>
148
 
<td>X coordinate</td>
149
 
</tr>
150
 
<tr>
151
 
<td><p><span class="term"><span class="type">guint32</span> <em class="structfield"><code><a name="GstVaapiRectangle.y"></a>y</code></em>;</span></p></td>
152
 
<td>Y coordinate</td>
153
 
</tr>
154
 
<tr>
155
 
<td><p><span class="term"><span class="type">guint32</span> <em class="structfield"><code><a name="GstVaapiRectangle.width"></a>width</code></em>;</span></p></td>
156
 
<td>region width</td>
157
 
</tr>
158
 
<tr>
159
 
<td><p><span class="term"><span class="type">guint32</span> <em class="structfield"><code><a name="GstVaapiRectangle.height"></a>height</code></em>;</span></p></td>
160
 
<td>region height</td>
 
185
<td class="struct_member_name"><p><span class="type">guint32</span> <em class="structfield"><code><a name="GstVaapiRectangle.x"></a>x</code></em>;</p></td>
 
186
<td class="struct_member_description"><p>X coordinate</p></td>
 
187
<td class="struct_member_annotations"> </td>
 
188
</tr>
 
189
<tr>
 
190
<td class="struct_member_name"><p><span class="type">guint32</span> <em class="structfield"><code><a name="GstVaapiRectangle.y"></a>y</code></em>;</p></td>
 
191
<td class="struct_member_description"><p>Y coordinate</p></td>
 
192
<td class="struct_member_annotations"> </td>
 
193
</tr>
 
194
<tr>
 
195
<td class="struct_member_name"><p><span class="type">guint32</span> <em class="structfield"><code><a name="GstVaapiRectangle.width"></a>width</code></em>;</p></td>
 
196
<td class="struct_member_description"><p>region width</p></td>
 
197
<td class="struct_member_annotations"> </td>
 
198
</tr>
 
199
<tr>
 
200
<td class="struct_member_name"><p><span class="type">guint32</span> <em class="structfield"><code><a name="GstVaapiRectangle.height"></a>height</code></em>;</p></td>
 
201
<td class="struct_member_description"><p>region height</p></td>
 
202
<td class="struct_member_annotations"> </td>
161
203
</tr>
162
204
</tbody>
163
205
</table></div>
164
206
</div>
165
207
</div>
166
208
</div>
 
209
</div>
167
210
<div class="footer">
168
211
<hr>
169
 
          Generated by GTK-Doc V1.19</div>
 
212
          Generated by GTK-Doc V1.20</div>
170
213
</body>
171
214
</html>
 
 
b'\\ No newline at end of file'