svn: /phpdoc/en/trunk/reference/imagick/imagick/ evaluateimage.xml

mkoppanen Sun, 05 Jun 2011 00:32:27 +0000 Revision: http://svn.php.net/viewvc?view=revision&revision=311814 Log: Add documentation for evaluateImage Changed paths: U phpdoc/en/trunk/reference/imagick/imagick/evaluateimage.xml Modified: phpdoc/en/trunk/reference/imagick/imagick/evaluateimage.xml =================================================================== --- phpdoc/en/trunk/reference/imagick/imagick/evaluateimage.xml 2011-06-05 00:20:50 UTC (rev 311813) +++ phpdoc/en/trunk/reference/imagick/imagick/evaluateimage.xml 2011-06-05 00:32:27 UTC (rev 311814) @@ -14,7 +14,6 @@ <methodparam><type>float</type><parameter>constant</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>channel</parameter><initializer>Imagick::CHANNEL_ALL</initializer></methodparam> </methodsynopsis> - &warn.undocumented.func; <para> Applys an arithmetic, relational, or logical expression to an image. Use these operators to lighten or darken an image, to increase or decrease @@ -30,7 +29,7 @@ <term><parameter>op</parameter></term> <listitem> <para> - The operator + The evaluation operator </para> </listitem> </varlistentry> @@ -56,7 +55,34 @@ </variablelist> </para> </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>Using <function>Imagick::evaluateImage</function></title> + <para> + Using evaluateImage to reduce opacity in an image. + </para> + <programlisting role="php"> +<![CDATA[ +<?php +// Create new object with the image +$im = new Imagick('example-alpha.png'); +// Reduce the alpha by 50% +$im->evaluateImage(Imagick::EVALUATE_DIVIDE, 2, Imagick::CHANNEL_ALPHA); + +// Output the image +header("Content-Type: image/png"); +echo $im; +?> +]]> + </programlisting> + </example> + </para> +</refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para>