documentation for liquidrescaleimage

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@286972 c90b9560-bf6c-de11-be94-00142212c4b1

reference/imagick/imagick/liquidrescaleimage.xml

@@ -0,0 +1,106 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 286761 $ -->
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.imagick-liquidrescaleimage">
+ <refnamediv>
+  <refname>Imagick::liquidRescaleImage</refname>
+  <refpurpose>Animates an image or images</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>bool</type><methodname>Imagick::liquidRescaleImage</methodname>
+   <methodparam><type>int</type><parameter>width</parameter></methodparam>
+   <methodparam><type>int</type><parameter>height</parameter></methodparam>
+   <methodparam><type>float</type><parameter>delta_x</parameter></methodparam>
+   <methodparam><type>float</type><parameter>rigidity</parameter></methodparam>
+  </methodsynopsis>
+
+  <para>
+   This method scales the images using liquid rescaling method. This method
+   is an implementation of a technique called seam carving. In order for this
+   method to work as expected ImageMagick must be compiled with liblqr support.
+   &imagick.method.available.0x639;
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>width</parameter></term>
+     <listitem>
+      <para>
+       The width of the target size
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>height</parameter></term>
+     <listitem>
+      <para>
+       The height of the target size
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>delta_x</parameter></term>
+     <listitem>
+      <para>
+       How much the seam can traverse on x-axis. 
+       Passing 0 causes the seams to be straight.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>rigidity</parameter></term>
+     <listitem>
+      <para>
+       Introduces a bias for non-straight seams. This parameter is 
+       typically 0.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+
+ </refsect1>
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &imagick.return.success;
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>Imagick::resizeImage</function></member>
+   </simplelist>
+  </para>
+ </refsect1>
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->