<!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>Sets image clip mask</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="imagick.setimagechanneldepth.html">Imagick::setImageChannelDepth</a></div> <div class="next" style="text-align: right; float: right;"><a href="imagick.setimagecolormapcolor.html">Imagick::setImageColormapColor</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.setimageclipmask" class="refentry"> <div class="refnamediv"> <h1 class="refname">Imagick::setImageClipMask</h1> <p class="verinfo">(No version information available, might only be in Git)</p><p class="refpurpose"><span class="refname">Imagick::setImageClipMask</span> — <span class="dc-title">Sets image clip mask</span></p> </div> <div class="refsect1 description" id="refsect1-imagick.setimageclipmask-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><strong>Imagick::setImageClipMask</strong></span> ( <span class="methodparam"><span class="type"><a href="class.imagick.html" class="type Imagick">Imagick</a></span> <code class="parameter">$clip_mask</code></span> )</div> <p class="para rdfs-comment"> Sets image clip mask from another Imagick object. This method is available if Imagick has been compiled against ImageMagick version 6.3.6 or newer. </p> </div> <div class="refsect1 parameters" id="refsect1-imagick.setimageclipmask-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <code class="parameter">clip_mask</code></dt> <dd> <p class="para"> The Imagick object containing the clip mask </p> </dd> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-imagick.setimageclipmask-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.setimageclipmask-errors"> <h3 class="title">Errors/Exceptions</h3> <p class="para"> Throws ImagickException on error. </p> </div> <div class="refsect1 examples" id="refsect1-imagick.setimageclipmask-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-4008"> <p><strong>Example #1 <span class="function"><strong>Imagick::setImageClipMask()</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">setImageClipMask</span><span style="color: #007700">(</span><span style="color: #0000BB">$imagePath</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">();<br /> </span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-></span><span style="color: #0000BB">readImage</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 /><br /> </span><span style="color: #0000BB">$width </span><span style="color: #007700">= </span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-></span><span style="color: #0000BB">getImageWidth</span><span style="color: #007700">();<br /> </span><span style="color: #0000BB">$height </span><span style="color: #007700">= </span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-></span><span style="color: #0000BB">getImageHeight</span><span style="color: #007700">();<br /><br /> </span><span style="color: #0000BB">$clipMask </span><span style="color: #007700">= new \</span><span style="color: #0000BB">Imagick</span><span style="color: #007700">();<br /> </span><span style="color: #0000BB">$clipMask</span><span style="color: #007700">-></span><span style="color: #0000BB">newPseudoImage</span><span style="color: #007700">(<br /> </span><span style="color: #0000BB">$width</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">$height</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">"canvas:transparent"<br /> </span><span style="color: #007700">);<br /><br /> </span><span style="color: #0000BB">$draw </span><span style="color: #007700">= new \</span><span style="color: #0000BB">ImagickDraw</span><span style="color: #007700">();<br /> </span><span style="color: #0000BB">$draw</span><span style="color: #007700">-></span><span style="color: #0000BB">setFillColor</span><span style="color: #007700">(</span><span style="color: #DD0000">'white'</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$draw</span><span style="color: #007700">-></span><span style="color: #0000BB">circle</span><span style="color: #007700">(<br /> </span><span style="color: #0000BB">$width </span><span style="color: #007700">/ </span><span style="color: #0000BB">2</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">$height </span><span style="color: #007700">/ </span><span style="color: #0000BB">2</span><span style="color: #007700">,<br /> (</span><span style="color: #0000BB">$width </span><span style="color: #007700">/ </span><span style="color: #0000BB">2</span><span style="color: #007700">) + (</span><span style="color: #0000BB">$width </span><span style="color: #007700">/ </span><span style="color: #0000BB">4</span><span style="color: #007700">),<br /> </span><span style="color: #0000BB">$height </span><span style="color: #007700">/ </span><span style="color: #0000BB">2<br /> </span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$clipMask</span><span style="color: #007700">-></span><span style="color: #0000BB">drawImage</span><span style="color: #007700">(</span><span style="color: #0000BB">$draw</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-></span><span style="color: #0000BB">setImageClipMask</span><span style="color: #007700">(</span><span style="color: #0000BB">$clipMask</span><span style="color: #007700">);<br /><br /> </span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-></span><span style="color: #0000BB">negateImage</span><span style="color: #007700">(</span><span style="color: #0000BB">false</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-></span><span style="color: #0000BB">setFormat</span><span style="color: #007700">(</span><span style="color: #DD0000">"png"</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">getImagesBlob</span><span style="color: #007700">();<br /> <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.setimagechanneldepth.html">Imagick::setImageChannelDepth</a></div> <div class="next" style="text-align: right; float: right;"><a href="imagick.setimagecolormapcolor.html">Imagick::setImageColormapColor</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>