<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.imagick.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'imagick.transparentpaintimage.php',
    1 => 'Imagick::transparentPaintImage',
    2 => 'Paints pixels transparent',
  ),
  'up' => 
  array (
    0 => 'class.imagick.php',
    1 => 'Imagick',
  ),
  'prev' => 
  array (
    0 => 'imagick.transformimagecolorspace.php',
    1 => 'Imagick::transformImageColorspace',
  ),
  'next' => 
  array (
    0 => 'imagick.transposeimage.php',
    1 => 'Imagick::transposeImage',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/imagick/imagick/transparentpaintimage.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="imagick.transparentpaintimage" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Imagick::transparentPaintImage</h1>
  <p class="verinfo">(PECL imagick 2 &gt;= 2.3.0, PECL imagick 3)</p><p class="refpurpose"><span class="refname">Imagick::transparentPaintImage</span> &mdash; <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="modifier">public</span> <span class="methodname"><strong>Imagick::transparentPaintImage</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$target</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.float.php" class="type float">float</a></span> <code class="parameter">$alpha</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.float.php" class="type float">float</a></span> <code class="parameter">$fuzz</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$invert</code></span><br>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></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><a href="reserved.constants.php#constant.true">true</a></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><a href="reserved.constants.php#constant.true">true</a></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-1">
      <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">&lt;?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">-&gt;</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">-&gt;</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">-&gt;</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">-&gt;</span><span style="color: #0000BB">getImageBlob</span><span style="color: #007700">();<br />}<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
      </div>

    </div>
  </p>
 </div>


</div><?php manual_footer($setup); ?>