/usr/share/doc/liblqr-1-0-dev/html/ref-lqr-carver-attach.html is in liblqr-1-0-dev 0.4.1-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 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>lqr_carver_attach</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><link rel="home" href="index.html" title="The Liquid Rescale library Manual"><link rel="up" href="ref-carve.html" title="Carver objects"><link rel="prev" href="ref-lqr-carver-set-use-cache.html" title="lqr_carver_set_use_cache"><link rel="next" href="ref-lqr-carver-list-start.html" title="lqr_carver_list_start"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center"><code class="function">lqr_carver_attach</code></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ref-lqr-carver-set-use-cache.html">Prev</a> </td><th width="60%" align="center">Carver objects</th><td width="20%" align="right"> <a accesskey="n" href="ref-lqr-carver-list-start.html">Next</a></td></tr></table><hr></div><div class="refentry" title="lqr_carver_attach"><a name="ref-lqr-carver-attach"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>lqr_carver_attach — attach an <code class="classname">LqrCarver</code> to another <code class="classname">LqrCarver</code></p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="funcsynopsis"><pre class="funcsynopsisinfo">#include <lqr.h></pre><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">LqrRetVal <b class="fsfunc">lqr_carver_attach</b>(</code></td><td>LqrCarver* <var class="pdparam">carver</var>, </td></tr><tr><td> </td><td>LqrCarver* <var class="pdparam">aux</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1" title="Description"><a name="idp33262720"></a><h2>Description</h2><p>
The function <code class="function">lqr_carver_attach</code> is used to attach an <code class="classname">LqrCarver</code> object
(pointed to by <em class="parameter"><code>aux</code></em>) to another one (pointed to by
<em class="parameter"><code>carver</code></em>). This will have the effect that each operation performed over
the <em class="parameter"><code>carver</code></em> object will be reflected on <em class="parameter"><code>aux</code></em> (they
will share the same visibility map).
</p><p>
This function must not be used after a visibility map was loaded into the base object (the one
pointed to by <em class="parameter"><code>carver</code></em>).
</p><p>
The object pointed to by <em class="parameter"><code>aux</code></em> must have the same original size as the base
object. Note that the original size information is reset whenever a flattening operation
occurs, or the rescaling direction changes, so that this function should be called befor
rescaling occurs.
</p><p>
There is no limitation on the number of <code class="classname">LqrCarver</code> objects which is possible to attach. Nesting
is also possible. It is irrelevant if the <em class="parameter"><code>aux</code></em> carver is initialised or
not; from the moment of attachment, it will passively undergo all transformations performed over
<em class="parameter"><code>carver</code></em>.
</p></div><div class="refsect1" title="Return value"><a name="idp33272640"></a><h2>Return value</h2><p>
The return value follows the Liquid Rescale library signalling system. <code class="literal"><span class="errorcode">LQR_ERROR</span></code> is returned if the sizes of
<em class="parameter"><code>carver</code></em> and <em class="parameter"><code>aux</code></em> don't match.
</p></div><div class="refsect1" title="See also"><a name="idp33276144"></a><h2>See also</h2><p>
<span class="simplelist"><a class="xref" href="ref-lqr-ret-val.html" title="LqrRetVal"><span class="refentrytitle"><span class="type">LqrRetVal</span></span>(3)</a>, <a class="xref" href="ref-lqr-carver-list-start.html" title="lqr_carver_list_start"><span class="refentrytitle"><code class="function">lqr_carver_list_start</code></span>(3)</a>, <a class="xref" href="ref-lqr-carver-list-current.html" title="lqr_carver_list_current"><span class="refentrytitle"><code class="function">lqr_carver_list_current</code></span>(3)</a>, <a class="xref" href="ref-lqr-carver-list-next.html" title="lqr_carver_list_next"><span class="refentrytitle"><code class="function">lqr_carver_list_next</code></span>(3)</a>, <a class="xref" href="ref-lqr-carver-list-foreach.html" title="lqr_carver_list_foreach"><span class="refentrytitle"><code class="function">lqr_carver_list_foreach</code></span>(3)</a></span>
</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ref-lqr-carver-set-use-cache.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ref-carve.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ref-lqr-carver-list-start.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><code class="function">lqr_carver_set_use_cache</code> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> <code class="function">lqr_carver_list_start</code></td></tr></table></div></body></html>
|