/usr/share/doc/liblqr-1-0-dev/html/ref-lqr-carver-set-enl-step.html is in liblqr-1-0-dev 0.4.2-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 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>lqr_carver_set_enl_step</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><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-get-depth.html" title="lqr_carver_get_depth"><link rel="next" href="ref-lqr-carver-set-resize-order.html" title="lqr_carver_set_resize_order"></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_set_enl_step</code></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ref-lqr-carver-get-depth.html">Prev</a> </td><th width="60%" align="center">Carver objects</th><td width="20%" align="right"> <a accesskey="n" href="ref-lqr-carver-set-resize-order.html">Next</a></td></tr></table><hr></div><div class="refentry"><a name="ref-lqr-carver-set-enl-step"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>lqr_carver_set_enl_step — set the enlargement step of a <code class="classname">LqrCarver</code> object</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="funcsynopsis"><pre class="funcsynopsisinfo">#include <lqr.h></pre><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">LqrRetVal <b class="fsfunc">lqr_carver_set_enl_step</b>(</code></td><td>LqrCarver* <var class="pdparam">carver</var>, </td></tr><tr><td> </td><td>gfloat <var class="pdparam">enl_step</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a name="idp58888800"></a><h2>Description</h2><p>
The function <code class="function">lqr_carver_set_enl_step</code> sets the enlargement step of the
<code class="classname">LqrCarver</code> object pointed to by <em class="parameter"><code>carver</code></em> to the value specified in
<em class="parameter"><code>enl_step</code></em>, which must be strictly greater than 1 and less than 2.
</p><p>
The enlargement step is the maximum enlargement ratio (with respect to either the original width
or original height of <em class="parameter"><code>carver</code></em>) which the function
<code class="function">lqr_carver_resize</code> applies in a single step; if that function is asked a
greater enlargement, it divides the process in multiple steps (and updates the original sizes
accordingly at each new step - these can be readout at any time with
<a class="xref" href="ref-lqr-carver-get-ref-width.html" title="lqr_carver_get_ref_width"><span class="refentrytitle"><code class="function">lqr_carver_get_ref_width</code></span>(3)</a> and
<a class="xref" href="ref-lqr-carver-get-ref-height.html" title="lqr_carver_get_ref_height"><span class="refentrytitle"><code class="function">lqr_carver_get_ref_height</code></span>(3)</a>).
</p><p>
The default value for new <code class="classname">LqrCarver</code> objects is 2.0.
</p></div><div class="refsect1"><a name="idp58896272"></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
<em class="parameter"><code>enl_step</code></em> parameter is out of bounds.
</p></div><div class="refsect1"><a name="idp58899152"></a><h2>See also</h2><p>
<span class="simplelist"><a class="xref" href="ref-lqr-carver-resize.html" title="lqr_carver_resize"><span class="refentrytitle"><code class="function">lqr_carver_resize</code></span>(3)</a>, <a class="xref" href="ref-lqr-carver-get-enl-step.html" title="lqr_carver_get_enl_step"><span class="refentrytitle"><code class="function">lqr_carver_get_enl_step</code></span>(3)</a>, <a class="xref" href="ref-lqr-carver-get-ref-width.html" title="lqr_carver_get_ref_width"><span class="refentrytitle"><code class="function">lqr_carver_get_ref_width</code></span>(3)</a>, <a class="xref" href="ref-lqr-carver-get-ref-height.html" title="lqr_carver_get_ref_height"><span class="refentrytitle"><code class="function">lqr_carver_get_ref_height</code></span>(3)</a>, <a class="xref" href="ref-lqr-carver-set-dump-vmaps.html" title="lqr_carver_set_dump_vmaps"><span class="refentrytitle"><code class="function">lqr_carver_set_dump_vmaps</code></span>(3)</a>, <a class="xref" href="ref-lqr-carver-set-side-switch-frequency.html" title="lqr_carver_set_side_switch_frequency"><span class="refentrytitle"><code class="function">lqr_carver_set_side_switch_frequency</code></span>(3)</a>, <a class="xref" href="ref-lqr-carver-set-progress.html" title="lqr_carver_set_progress"><span class="refentrytitle"><code class="function">lqr_carver_set_progress</code></span>(3)</a>, <a class="xref" href="ref-lqr-carver-set-preserve-input-image.html" title="lqr_carver_set_preserve_input_image"><span class="refentrytitle"><code class="function">lqr_carver_set_preserve_input_image</code></span>(3)</a>, <a class="xref" href="ref-lqr-carver-set-use-cache.html" title="lqr_carver_set_use_cache"><span class="refentrytitle"><code class="function">lqr_carver_set_use_cache</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-get-depth.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-set-resize-order.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><code class="function">lqr_carver_get_depth</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_set_resize_order</code></td></tr></table></div></body></html>
|