Permalink
Browse files

Document Image#liquid_rescale

  • Loading branch information...
1 parent a348148 commit 44bc52c52b2a6f3c9106ebe5be77385fd385703a rmagick committed Jan 31, 2008
Showing with 68 additions and 1 deletion.
  1. +53 −0 doc/image2.html
  2. +10 −1 doc/optequiv.html
  3. +5 −0 doc/usage.html
View
53 doc/image2.html
@@ -153,6 +153,8 @@ <h6 id="header">RMagick 0.0.0 User's Guide and Reference</h6>
<li><a href="#linear_stretch">linear_stretch</a></li>
+ <li><a href="#liquid_rescale">liquid_rescale</a></li>
+
<li><a href="#magnify">magnify</a></li>
<li><a href="#magnify_bang">magnify!</a></li>
@@ -2388,6 +2390,57 @@ <h3 id="linear_stretch">linear_stretch</h3>
</div>
<div class="sig">
+ <h3 id="liquid_rescale">liquid_rescale</h3>
+
+ <p><span class="arg">img</span>.liquid_rescale(<span class=
+ "arg">new_width</span>, <span class="arg">new_height</span>,
+ <span class="arg">delta_x</span>=0.0, <span class=
+ "arg">rigidity</span>=0.0) -&gt; <em>image</em></p>
+ </div>
+
+ <div class="desc">
+ <h4>Description</h4>
+
+ <p><span class="imquote">Rescale image with seam
+ carving.</span> To use this method, you must have installed and
+ configured ImageMagick to use the <a href=
+ "http://liblqr.wikidot.com/">Liquid Rescale Library</a>.</p>
+
+ <h4>Arguments</h4>
+
+ <dl>
+ <dt>new_width, new_height</dt>
+
+ <dd>
+ <p>The desired width and height. Should not exceed 200% of
+ the original dimension.</p>
+ </dd>
+
+ <dt>delta_x</dt>
+
+ <dd>
+ <p class="imquote">Maximum seam transversal step (0 means
+ straight seams).</p>
+ </dd>
+
+ <dt>rigidity</dt>
+
+ <dd>
+ <p class="imquote">Introduce a bias for non-straight seams
+ (typically 0).</p>
+ </dd>
+ </dl>
+
+ <h4>Returns</h4>
+
+ <p>A new image</p>
+
+ <h4>Magick API</h4>
+
+ <p>LiquidRescaleImage</p>
+ </div>
+
+ <div class="sig">
<h3 id="magnify">magnify</h3>
<p><span class="arg">img</span>.magnify -&gt;
View
11 doc/optequiv.html
@@ -108,7 +108,7 @@ <h2 class="methods" id="convert">convert, mogrify</h2>
the tables on this page to determine which RMagick methods
correspond to the options used by these tools.</p>
- <p>The options listed below are for ImageMagick 6.3.7. Earlier
+ <p>The options listed below are for ImageMagick 6.3.8. Earlier
releases of ImageMagick may not support all these options.
Later releases of ImageMagick may have options that are not
listed.</p>
@@ -1025,6 +1025,15 @@ <h2 class="methods" id="convert">convert, mogrify</h2>
</tr>
<tr>
+ <td>-liquid-rescale <em>geometry</em></td>
+
+ <td>Image#<a href=
+ "image2.html#liquid_rescale">liquid_rescale</a>(<em>new_width</em>,
+ <em>new_height</em>, <em>delta_x</em>,
+ <em>rigidity</em>)</td>
+ </tr>
+
+ <tr>
<td>-list <em>color</em><br />
-list <em>format</em><br />
-list <em>type</em></td>
View
5 doc/usage.html
@@ -658,6 +658,11 @@ <h2 id="modifying">Examining and modifying images</h2>
<dd>Compute a new constrained size for the image</dd>
+ <dt><a href=
+ "image2.html#liquid_rescale">liquid_rescale</a></dt>
+
+ <dd>Rescale image with seam-carving</dd>
+
<dt><a href="image2.html#magnify">magnify</a></dt>
<dd>Double the size of the image</dd>

0 comments on commit 44bc52c

Please sign in to comment.