This file is indexed.

/usr/share/doc/gstreamer1.0-vaapi/libs/libs-Basic-data-structures.html is in gstreamer1.0-vaapi-doc 0.5.9-2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GStreamer VA-API Plugins 1.4 Library Reference Manual: Basic data structures</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GStreamer VA-API Plugins 1.4 Library Reference Manual">
<link rel="up" href="ch01.html" title="gst-plugins-vaapi Library">
<link rel="prev" href="libs-GstVideoFormat.html" title="GstVideoFormat">
<link rel="next" href="libs-GstVaapiDisplay.html" title="GstVaapiDisplay">
<meta name="generator" content="GTK-Doc V1.21 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#libs-Basic-data-structures.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libs-GstVideoFormat.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libs-GstVaapiDisplay.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libs-Basic-data-structures"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libs-Basic-data-structures.top_of_page"></a>Basic data structures</span></h2>
<p>Basic data structures</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libs-Basic-data-structures.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody><tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<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>
</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libs-Basic-data-structures.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="typedef_keyword">typedef</td>
<td class="function_name"><a class="link" href="libs-Basic-data-structures.html#GstVaapiID" title="GstVaapiID">GstVaapiID</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<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>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="libs-Basic-data-structures.html#GstVaapiPoint" title="struct GstVaapiPoint">GstVaapiPoint</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="libs-Basic-data-structures.html#GstVaapiRectangle" title="struct GstVaapiRectangle">GstVaapiRectangle</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libs-Basic-data-structures.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libs-Basic-data-structures.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="GST-VAAPI-ID-ARGS:CAPS"></a><h3>GST_VAAPI_ID_ARGS()</h3>
<pre class="programlisting">#define GST_VAAPI_ID_ARGS(id) GSIZE_TO_POINTER(id)
</pre>
<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
an integer value in a <code class="function">printf()</code>-style text message.</p>
<div class="refsect3">
<a name="id-1.2.3.6.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>id</p></td>
<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>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="libs-Basic-data-structures.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GstVaapiID"></a><h3>GstVaapiID</h3>
<pre class="programlisting">typedef gsize GstVaapiID;
</pre>
<p>An integer large enough to hold a generic VA id or a pointer
wherever necessary.</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-VAAPI-ID-FORMAT:CAPS"></a><h3>GST_VAAPI_ID_FORMAT</h3>
<pre class="programlisting">#define GST_VAAPI_ID_FORMAT "p"
</pre>
<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
integer value in a <code class="function">printf()</code>-style text message.</p>
<div class="informalexample">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1</pre></td>
        <td class="listing_code"><pre class="programlisting"><span class="function">printf</span><span class="gtkdoc opt">(</span><span class="string">&quot;id: %&quot;</span> GST_VAAPI_ID_FORMAT <span class="string">&quot;</span><span class="gtkdoc esc">\n</span><span class="string">&quot;</span><span class="gtkdoc opt">,</span> <span class="function"><a href="libs-Basic-data-structures.html#GST-VAAPI-ID-ARGS:CAPS">GST_VAAPI_ID_ARGS</a></span><span class="gtkdoc opt">(</span>id<span class="gtkdoc opt">));</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

</div>
<hr>
<div class="refsect2">
<a name="GstVaapiPoint"></a><h3>struct GstVaapiPoint</h3>
<pre class="programlisting">struct GstVaapiPoint {
    guint32 x;
    guint32 y;
};
</pre>
<p>A location within a surface.</p>
<div class="refsect3">
<a name="id-1.2.3.7.4.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><span class="type">guint32</span> <em class="structfield"><code><a name="GstVaapiPoint.x"></a>x</code></em>;</p></td>
<td class="struct_member_description"><p>X coordinate</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<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>
<td class="struct_member_description"><p>Y coordinate</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="GstVaapiRectangle"></a><h3>struct GstVaapiRectangle</h3>
<pre class="programlisting">struct GstVaapiRectangle {
    guint32 x;
    guint32 y;
    guint32 width;
    guint32 height;
};
</pre>
<p>A rectangle region within a surface.</p>
<div class="refsect3">
<a name="id-1.2.3.7.5.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><span class="type">guint32</span> <em class="structfield"><code><a name="GstVaapiRectangle.x"></a>x</code></em>;</p></td>
<td class="struct_member_description"><p>X coordinate</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<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>
<td class="struct_member_description"><p>Y coordinate</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<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>
<td class="struct_member_description"><p>region width</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<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>
<td class="struct_member_description"><p>region height</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.21</div>
</body>
</html>