<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Blends the fill color with the image</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="imagick.colorfloodfillimage.html">Imagick::colorFloodfillImage</a></div> <div class="next" style="text-align: right; float: right;"><a href="imagick.colormatriximage.html">Imagick::colorMatrixImage</a></div> <div class="up"><a href="class.imagick.html">Imagick</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="imagick.colorizeimage" class="refentry"> <div class="refnamediv"> <h1 class="refname">Imagick::colorizeImage</h1> <p class="verinfo">(PECL imagick 2.0.0)</p><p class="refpurpose"><span class="refname">Imagick::colorizeImage</span> — <span class="dc-title">Blends the fill color with the image</span></p> </div> <div class="refsect1 description" id="refsect1-imagick.colorizeimage-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><strong>Imagick::colorizeImage</strong></span> ( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$colorize</code></span> , <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$opacity</code></span> [, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$legacy</code><span class="initializer"> = <strong><code>FALSE</code></strong></span></span> ] )</div> <p class="para rdfs-comment"> Blends the fill color with each pixel in the image. </p> </div> <div class="refsect1 parameters" id="refsect1-imagick.colorizeimage-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <code class="parameter">colorize</code></dt> <dd> <p class="para"> ImagickPixel object or a string containing the colorize color </p> </dd> <dt> <code class="parameter">opacity</code></dt> <dd> <p class="para"> ImagickPixel object or an float containing the opacity value. 1.0 is fully opaque and 0.0 is fully transparent. </p> </dd> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-imagick.colorizeimage-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns <strong><code>TRUE</code></strong> on success. </p> </div> <div class="refsect1 errors" id="refsect1-imagick.colorizeimage-errors"> <h3 class="title">Errors/Exceptions</h3> <p class="para"> Throws ImagickException on error. </p> </div> <div class="refsect1 changelog" id="refsect1-imagick.colorizeimage-changelog"> <h3 class="title">Changelog</h3> <p class="para"> <table class="doctable informaltable"> <thead> <tr> <th>Version</th> <th>Description</th> </tr> </thead> <tbody class="tbody"> <tr> <td>2.1.0</td> <td> Now allows a string representing the color as the first parameter and a float representing the opacity value as the second parameter. Previous versions allow only an ImagickPixel objects. </td> </tr> </tbody> </table> </p> </div> <div class="refsect1 examples" id="refsect1-imagick.colorizeimage-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-3894"> <p><strong>Example #1 <span class="function"><strong>Imagick::colorizeImage()</strong></span></strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /></span><span style="color: #007700">function </span><span style="color: #0000BB">colorizeImage</span><span style="color: #007700">(</span><span style="color: #0000BB">$imagePath</span><span style="color: #007700">, </span><span style="color: #0000BB">$color</span><span style="color: #007700">, </span><span style="color: #0000BB">$opacity</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$imagick </span><span style="color: #007700">= new \</span><span style="color: #0000BB">Imagick</span><span style="color: #007700">(</span><span style="color: #0000BB">realpath</span><span style="color: #007700">(</span><span style="color: #0000BB">$imagePath</span><span style="color: #007700">));<br /> </span><span style="color: #0000BB">$opacity </span><span style="color: #007700">= </span><span style="color: #0000BB">$opacity </span><span style="color: #007700">/ </span><span style="color: #0000BB">255.0</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$opacityColor </span><span style="color: #007700">= new \</span><span style="color: #0000BB">ImagickPixel</span><span style="color: #007700">(</span><span style="color: #DD0000">"rgba(0, 0, 0, </span><span style="color: #0000BB">$opacity</span><span style="color: #DD0000">)"</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-></span><span style="color: #0000BB">colorizeImage</span><span style="color: #007700">(</span><span style="color: #0000BB">$color</span><span style="color: #007700">, </span><span style="color: #0000BB">$opacityColor</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">header</span><span style="color: #007700">(</span><span style="color: #DD0000">"Content-Type: image/jpg"</span><span style="color: #007700">);<br /> echo </span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-></span><span style="color: #0000BB">getImageBlob</span><span style="color: #007700">();<br />}<br /><br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="imagick.colorfloodfillimage.html">Imagick::colorFloodfillImage</a></div> <div class="next" style="text-align: right; float: right;"><a href="imagick.colormatriximage.html">Imagick::colorMatrixImage</a></div> <div class="up"><a href="class.imagick.html">Imagick</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>