<!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>Paints pixels transparent</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagick.transformimagecolorspace.html">Imagick::transformImageColorspace</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.transposeimage.html">Imagick::transposeImage</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.transparentpaintimage" class="refentry">
<div class="refnamediv">
<h1 class="refname">Imagick::transparentPaintImage</h1>
<p class="verinfo">(No version information available, might only be in Git)</p><p class="refpurpose"><span class="refname">Imagick::transparentPaintImage</span> — <span class="dc-title">Paints pixels transparent</span></p>
</div>
<div class="refsect1 description" id="refsect1-imagick.transparentpaintimage-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>Imagick::transparentPaintImage</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">$target</code></span>
, <span class="methodparam"><span class="type">float</span> <code class="parameter">$alpha</code></span>
, <span class="methodparam"><span class="type">float</span> <code class="parameter">$fuzz</code></span>
, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$invert</code></span>
)</div>
<p class="para rdfs-comment">
Paints pixels matching the target color transparent.
This method is available if Imagick has been compiled against ImageMagick version 6.3.8 or newer.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-imagick.transparentpaintimage-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">target</code></dt>
<dd>
<p class="para">
The target color to paint
</p>
</dd>
<dt>
<code class="parameter">alpha</code></dt>
<dd>
<p class="para">
The level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.
</p>
</dd>
<dt>
<code class="parameter">fuzz</code></dt>
<dd>
<p class="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.
</p>
</dd>
<dt>
<code class="parameter">invert</code></dt>
<dd>
<p class="para">
If <strong><code>TRUE</code></strong> paints any pixel that does not match the target color.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-imagick.transparentpaintimage-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success.
</p>
</div>
<div class="refsect1 examples" id="refsect1-imagick.transparentpaintimage-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4051">
<p><strong>Example #1 <span class="function"><strong>Imagick::transparentPaintImage()</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">transparentPaintImage</span><span style="color: #007700">(</span><span style="color: #0000BB">$color</span><span style="color: #007700">, </span><span style="color: #0000BB">$alpha</span><span style="color: #007700">, </span><span style="color: #0000BB">$fuzz</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: #DD0000">"images/BlueScreen.jpg"</span><span style="color: #007700">));<br /><br /> </span><span style="color: #FF8000">//Need to be in a format that supports transparency<br /> </span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-></span><span style="color: #0000BB">setimageformat</span><span style="color: #007700">(</span><span style="color: #DD0000">'png'</span><span style="color: #007700">);<br /><br /> </span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-></span><span style="color: #0000BB">transparentPaintImage</span><span style="color: #007700">(<br /> </span><span style="color: #0000BB">$color</span><span style="color: #007700">, </span><span style="color: #0000BB">$alpha</span><span style="color: #007700">, </span><span style="color: #0000BB">$fuzz </span><span style="color: #007700">* \</span><span style="color: #0000BB">Imagick</span><span style="color: #007700">::</span><span style="color: #0000BB">getQuantum</span><span style="color: #007700">(), </span><span style="color: #0000BB">false<br /> </span><span style="color: #007700">);<br /><br /> </span><span style="color: #FF8000">//Not required, but helps tidy up left over pixels<br /> </span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-></span><span style="color: #0000BB">despeckleimage</span><span style="color: #007700">();<br /><br /> </span><span style="color: #0000BB">header</span><span style="color: #007700">(</span><span style="color: #DD0000">"Content-Type: image/png"</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.transformimagecolorspace.html">Imagick::transformImageColorspace</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.transposeimage.html">Imagick::transposeImage</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>
