<!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>Adds vignette filter to the image</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="imagick.valid.html">Imagick::valid</a></div> <div class="next" style="text-align: right; float: right;"><a href="imagick.waveimage.html">Imagick::waveImage</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.vignetteimage" class="refentry"> <div class="refnamediv"> <h1 class="refname">Imagick::vignetteImage</h1> <p class="verinfo">(PECL imagick 2.0.0)</p><p class="refpurpose"><span class="refname">Imagick::vignetteImage</span> — <span class="dc-title">Adds vignette filter to the image</span></p> </div> <div class="refsect1 description" id="refsect1-imagick.vignetteimage-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><strong>Imagick::vignetteImage</strong></span> ( <span class="methodparam"><span class="type">float</span> <code class="parameter">$blackPoint</code></span> , <span class="methodparam"><span class="type">float</span> <code class="parameter">$whitePoint</code></span> , <span class="methodparam"><span class="type">int</span> <code class="parameter">$x</code></span> , <span class="methodparam"><span class="type">int</span> <code class="parameter">$y</code></span> )</div> <p class="para rdfs-comment"> Softens the edges of the image in vignette style. This method is available if Imagick has been compiled against ImageMagick version 6.2.9 or newer. </p> </div> <div class="refsect1 parameters" id="refsect1-imagick.vignetteimage-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <code class="parameter">blackPoint</code></dt> <dd> <p class="para"> The black point. </p> </dd> <dt> <code class="parameter">whitePoint</code></dt> <dd> <p class="para"> The white point </p> </dd> <dt> <code class="parameter">x</code></dt> <dd> <p class="para"> X offset of the ellipse </p> </dd> <dt> <code class="parameter">y</code></dt> <dd> <p class="para"> Y offset of the ellipse </p> </dd> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-imagick.vignetteimage-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns <strong><code>TRUE</code></strong> on success. </p> </div> <div class="refsect1 seealso" id="refsect1-imagick.vignetteimage-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"><span class="function"><a href="imagick.waveimage.html" class="function" rel="rdfs-seeAlso">Imagick::waveImage()</a> - Applies wave filter to the image</span></li> <li class="member"><span class="function"><a href="imagick.swirlimage.html" class="function" rel="rdfs-seeAlso">Imagick::swirlImage()</a> - Swirls the pixels about the center of the image</span></li> </ul> </p> </div> <div class="refsect1 examples" id="refsect1-imagick.vignetteimage-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-4057"> <p><strong>Example #1 <span class="function"><strong>Imagick::vignetteImage()</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">vignetteImage</span><span style="color: #007700">(</span><span style="color: #0000BB">$imagePath</span><span style="color: #007700">, </span><span style="color: #0000BB">$blackPoint</span><span style="color: #007700">, </span><span style="color: #0000BB">$whitePoint</span><span style="color: #007700">, </span><span style="color: #0000BB">$x</span><span style="color: #007700">, </span><span style="color: #0000BB">$y</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">$imagick</span><span style="color: #007700">-></span><span style="color: #0000BB">vignetteImage</span><span style="color: #007700">(</span><span style="color: #0000BB">$blackPoint</span><span style="color: #007700">, </span><span style="color: #0000BB">$whitePoint</span><span style="color: #007700">, </span><span style="color: #0000BB">$x</span><span style="color: #007700">, </span><span style="color: #0000BB">$y</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.valid.html">Imagick::valid</a></div> <div class="next" style="text-align: right; float: right;"><a href="imagick.waveimage.html">Imagick::waveImage</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>