svn: /phpdoc/en/trunk/ language-snippets.ent reference/imagick/imagick/floodfillpaintimage.xml reference/imagick/imagick/paintfloodfillimage.xml
| From: | Mikko Koppanen | Date: | Sun, 09 Aug 2009 18:50:25 +0000 |
| Subject: | svn: /phpdoc/en/trunk/ language-snippets.ent reference/imagick/imagick/floodfillpaintimage.xml reference/imagick/imagick/paintfloodfillimage.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-4628@lists.php.net to get a copy of this message | ||
mkoppanen Sun, 09 Aug 2009 18:50:25 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=286959
Log:
Added more docs.
Changed paths:
U phpdoc/en/trunk/language-snippets.ent
A phpdoc/en/trunk/reference/imagick/imagick/floodfillpaintimage.xml
U phpdoc/en/trunk/reference/imagick/imagick/paintfloodfillimage.xml
Modified: phpdoc/en/trunk/language-snippets.ent
===================================================================
--- phpdoc/en/trunk/language-snippets.ent 2009-08-09 18:41:09 UTC (rev 286958)
+++ phpdoc/en/trunk/language-snippets.ent 2009-08-09 18:50:25 UTC (rev 286959)
@@ -1009,7 +1009,11 @@
<!ENTITY imagick.method.available.0x632 'This method is available if Imagick has been
compiled against ImageMagick version 6.3.2 or newer.'>
<!ENTITY imagick.method.available.0x636 'This method is available if Imagick has been
compiled against ImageMagick version 6.3.6 or newer.'>
<!ENTITY imagick.method.available.0x637 'This method is available if Imagick has been
compiled against ImageMagick version 6.3.7 or newer.'>
+<!ENTITY imagick.method.available.0x638 'This method is available if Imagick has been
compiled against ImageMagick version 6.3.8 or newer.'>
+<!-- Imagick default channel information -->
+<!ENTITY imagick.default.channel.info 'Defaults to
<constant>Imagick::CHANNEL_DEFAULT</constant>. Refer to this list of <link
linkend="imagick.constants.channel">channel constants</link>'>
+
<!ENTITY imagick.imagickexception.throw 'Throw an
<classname>ImagickException</classname> on error.'>
Added: phpdoc/en/trunk/reference/imagick/imagick/floodfillpaintimage.xml
===================================================================
--- phpdoc/en/trunk/reference/imagick/imagick/floodfillpaintimage.xml (rev
0)
+++ phpdoc/en/trunk/reference/imagick/imagick/floodfillpaintimage.xml 2009-08-09 18:50:25 UTC (rev
286959)
@@ -0,0 +1,126 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 286757 $ -->
+<refentry xmlns="http://docbook.org/ns/docbook"
xml:id="function.imagick-floodfillpaintimage">
+ <refnamediv>
+ <refname>Imagick::floodFillPaintImage</refname>
+ <refpurpose>Changes the color value of any pixel that matches target</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>bool</type><methodname>Imagick::floodFillPaintImage</methodname>
+
<methodparam><type>mixed</type><parameter>fill</parameter></methodparam>
+
<methodparam><type>float</type><parameter>fuzz</parameter></methodparam>
+
<methodparam><type>mixed</type><parameter>bordercolor</parameter></methodparam>
+
<methodparam><type>int</type><parameter>x</parameter></methodparam>
+
<methodparam><type>int</type><parameter>y</parameter></methodparam>
+
<methodparam><type>bool</type><parameter>invert</parameter></methodparam>
+ <methodparam
choice="opt"><type>int</type><parameter>channel</parameter><initializer>Imagick::CHANNEL_DEFAULT</initializer></methodparam>
+ </methodsynopsis>
+
+ <para>
+ Changes the color value of any pixel that matches target and is an
+ immediate neighbor. This method is a replacement for deprecated
+ <function>Imagick::paintFloodFillImage</function>.
+ &imagick.method.available.0x638;
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>fill</parameter></term>
+ <listitem>
+ <para>
+ ImagickPixel object or a string containing the fill color
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>fuzz</parameter></term>
+ <listitem>
+ <para>
+ The amount of fuzz. For example, set fuzz to 10 and the color red at
+ intensities of 100 and 102 respectively are now interpreted as the
+ same color for the purposes of the floodfill.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>bordercolor</parameter></term>
+ <listitem>
+ <para>
+ ImagickPixel object or a string containing the border color
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>x</parameter></term>
+ <listitem>
+ <para>
+ X start position of the floodfill
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>y</parameter></term>
+ <listitem>
+ <para>
+ Y start position of the floodfill
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>invert</parameter></term>
+ <listitem>
+ <para>
+ If true paints any pixel that does not match the target color.
+ </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. &imagick.default.channel.info;
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &imagick.return.success;
+ </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
+-->
Modified: phpdoc/en/trunk/reference/imagick/imagick/paintfloodfillimage.xml
===================================================================
--- phpdoc/en/trunk/reference/imagick/imagick/paintfloodfillimage.xml 2009-08-09 18:41:09 UTC (rev
286958)
+++ phpdoc/en/trunk/reference/imagick/imagick/paintfloodfillimage.xml 2009-08-09 18:50:25 UTC (rev
286959)
@@ -20,7 +20,8 @@
<para>
Changes the color value of any pixel that matches target and is an
- immediate neighbor.
+ immediate neighbor. As of ImageMagick 6.3.8 this method has been deprecated
+ and <function>Imagick::floodfillPaintImage should be used instead.
</para>
</refsect1>
@@ -76,8 +77,7 @@
<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 <constant>Imagick::CHANNEL_ALL</constant>. Refer
to this
- list of <link linkend="imagick.constants.channel">channel
constants</link>.
+ bitwise operators. &imagick.default.channel.info;
</para>
</listitem>
</varlistentry>