Added documentation for imagick::orderedPosterizeImage

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

reference/imagick/imagick/orderedposterizeimage.xml

@@ -0,0 +1,86 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.imagick-orderedposterizeimage">
+ <refnamediv>
+  <refname>Imagick::orderedPosterizeImage</refname>
+  <refpurpose>Performs an ordered dither</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>bool</type><methodname>Imagick::orderedPosterizeImage</methodname>
+   <methodparam><type>string</type><parameter>threshold_map</parameter></methodparam>
+   <methodparam choice="opt"><type>int</type><parameter>channel</parameter></methodparam>
+  </methodsynopsis>
+  &warn.undocumented.func;
+  <para>
+    Performs an ordered dither based on a number of pre-defined dithering threshold maps, 
+    but over multiple intensity levels, which can be different for different channels, 
+    according to the input arguments.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>threshold_map</parameter></term>
+     <listitem>
+      <para>
+       A string containing the name of the threshold dither map to use
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>channel</parameter></term>
+     <listitem>
+      <para>
+       Provide any channel constant that is valid for your channel mode. To
+       apply to more than one channel, combine channeltype constants using
+       bitwise operators. Defaults to Imagick::CHANNEL_ALL. Refer to this
+       list of <link linkend="imagick.constants.channel">channel constants</link>.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &imagick.return.success;
+  </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   &imagick.imagick.throws;
+  </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
+-->