/usr/share/gtk-doc/html/libdazzle/libdazzle-dzl-ring.html is in libdazzle-doc 3.28.1-1.
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 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>dzl-ring: Dazzle Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Dazzle Reference Manual">
<link rel="up" href="dazzle-data-structures.html" title="Part XV. Data Structures">
<link rel="prev" href="libdazzle-dzl-heap.html" title="dzl-heap">
<link rel="next" href="dazzle-actions.html" title="Part XVI. Action Integration">
<meta name="generator" content="GTK-Doc V1.27 (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="#libdazzle-dzl-ring.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="dazzle-data-structures.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libdazzle-dzl-heap.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="dazzle-actions.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libdazzle-dzl-ring"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libdazzle-dzl-ring.top_of_page"></a>dzl-ring</span></h2>
<p>dzl-ring</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libdazzle-dzl-ring.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" 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="libdazzle-dzl-ring.html#dzl-ring-append-val" title="dzl_ring_append_val()">dzl_ring_append_val</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="libdazzle-dzl-ring.html#dzl-ring-get-index" title="dzl_ring_get_index()">dzl_ring_get_index</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">DzlRing</span> *
</td>
<td class="function_name">
<a class="link" href="libdazzle-dzl-ring.html#dzl-ring-sized-new" title="dzl_ring_sized_new ()">dzl_ring_sized_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="libdazzle-dzl-ring.html#dzl-ring-append-vals" title="dzl_ring_append_vals ()">dzl_ring_append_vals</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libdazzle-dzl-ring.html#dzl-ring-foreach" title="dzl_ring_foreach ()">dzl_ring_foreach</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">DzlRing</span> *
</td>
<td class="function_name">
<a class="link" href="libdazzle-dzl-ring.html#dzl-ring-ref" title="dzl_ring_ref ()">dzl_ring_ref</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libdazzle-dzl-ring.html#dzl-ring-unref" title="dzl_ring_unref ()">dzl_ring_unref</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libdazzle-dzl-ring.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libdazzle-dzl-ring.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="dzl-ring-append-val"></a><h3>dzl_ring_append_val()</h3>
<pre class="programlisting">#define dzl_ring_append_val(ring, val) dzl_ring_append_vals(ring, &(val), 1)
</pre>
<p>Appends a value to the ring buffer. <em class="parameter"><code>val</code></em>
must be a variable as it is
referenced to.</p>
<div class="refsect3">
<a name="dzl-ring-append-val.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>ring</p></td>
<td class="parameter_description"><p>A <span class="type">DzlRing</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>val</p></td>
<td class="parameter_description"><p>A value to append to the <span class="type">DzlRing</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="dzl-ring-append-val.returns"></a><h4>Returns</h4>
<p> None.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dzl-ring-get-index"></a><h3>dzl_ring_get_index()</h3>
<pre class="programlisting">#define dzl_ring_get_index(ring, type, i)</pre>
<p>Retrieves the value at the given index from the <span class="type">DzlRing</span>. The value
is cast to <em class="parameter"><code>type</code></em>
. You may retrieve a pointer to the value within the
array by using &.</p>
<p>[[
gdouble *v = &dzl_ring_get_index(ring, gdouble, 0);
gdouble v = dzl_ring_get_index(ring, gdouble, 0);
]]</p>
<div class="refsect3">
<a name="dzl-ring-get-index.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>ring</p></td>
<td class="parameter_description"><p>A <span class="type">DzlRing</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type</p></td>
<td class="parameter_description"><p>The type to extract.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>i</p></td>
<td class="parameter_description"><p>The index within the <span class="type">DzlRing</span> relative to the current position.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="dzl-ring-get-index.returns"></a><h4>Returns</h4>
<p> The value at the given index.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dzl-ring-sized-new"></a><h3>dzl_ring_sized_new ()</h3>
<pre class="programlisting"><span class="returnvalue">DzlRing</span> *
dzl_ring_sized_new (<em class="parameter"><code><span class="type">guint</span> element_size</code></em>,
<em class="parameter"><code><span class="type">guint</span> reserved_size</code></em>,
<em class="parameter"><code><span class="type">GDestroyNotify</span> element_destroy</code></em>);</pre>
<p>Creates a new instance of <span class="type">DzlRing</span> with the given number of elements.</p>
<div class="refsect3">
<a name="dzl-ring-sized-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>element_size</p></td>
<td class="parameter_description"><p>The size per element. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>reserved_size</p></td>
<td class="parameter_description"><p>The number of elements to allocate. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>element_destroy</p></td>
<td class="parameter_description"><p>Notification called when removing an element. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="dzl-ring-sized-new.returns"></a><h4>Returns</h4>
<p> A new <span class="type">DzlRing</span>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dzl-ring-append-vals"></a><h3>dzl_ring_append_vals ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
dzl_ring_append_vals (<em class="parameter"><code><span class="type">DzlRing</span> *ring</code></em>,
<em class="parameter"><code><span class="type">gconstpointer</span> data</code></em>,
<em class="parameter"><code><span class="type">guint</span> len</code></em>);</pre>
<p>Appends <em class="parameter"><code>len</code></em>
values located at <em class="parameter"><code>data</code></em>
.</p>
<div class="refsect3">
<a name="dzl-ring-append-vals.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>ring</p></td>
<td class="parameter_description"><p>A <span class="type">DzlRing</span>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>A pointer to the array of values. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>len</p></td>
<td class="parameter_description"><p>The number of values. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="dzl-ring-append-vals.returns"></a><h4>Returns</h4>
<p> the index of the first item.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dzl-ring-foreach"></a><h3>dzl_ring_foreach ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
dzl_ring_foreach (<em class="parameter"><code><span class="type">DzlRing</span> *ring</code></em>,
<em class="parameter"><code><span class="type">GFunc</span> func</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>Calls <em class="parameter"><code>func</code></em>
for every item in the <span class="type">DzlRing</span> starting from the most recently
inserted element to the least recently inserted.</p>
<div class="refsect3">
<a name="dzl-ring-foreach.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>ring</p></td>
<td class="parameter_description"><p>A <span class="type">DzlRing</span>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>func</p></td>
<td class="parameter_description"><p>A <span class="type">GFunc</span> to call for each element. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>][<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data for <em class="parameter"><code>func</code></em>
. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dzl-ring-ref"></a><h3>dzl_ring_ref ()</h3>
<pre class="programlisting"><span class="returnvalue">DzlRing</span> *
dzl_ring_ref (<em class="parameter"><code><span class="type">DzlRing</span> *ring</code></em>);</pre>
<p>Atomically increments the reference count of <em class="parameter"><code>ring</code></em>
by one.</p>
<div class="refsect3">
<a name="dzl-ring-ref.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>ring</p></td>
<td class="parameter_description"><p>A <span class="type">DzlRing</span>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="dzl-ring-ref.returns"></a><h4>Returns</h4>
<p> The <em class="parameter"><code>ring</code></em>
pointer.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dzl-ring-unref"></a><h3>dzl_ring_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
dzl_ring_unref (<em class="parameter"><code><span class="type">DzlRing</span> *ring</code></em>);</pre>
<p>Atomically decrements the reference count of <em class="parameter"><code>ring</code></em>
by one. When the
reference count reaches zero, the structure is freed.</p>
<div class="refsect3">
<a name="dzl-ring-unref.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>ring</p></td>
<td class="parameter_description"><p>A <span class="type">DzlRing</span>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="libdazzle-dzl-ring.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|