<!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>Returns the maximum bounding region between images</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagick.compareimagechannels.html">Imagick::compareImageChannels</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.compareimages.html">Imagick::compareImages</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.compareimagelayers" class="refentry">
<div class="refnamediv">
<h1 class="refname">Imagick::compareImageLayers</h1>
<p class="verinfo">(PECL imagick 2.0.0)</p><p class="refpurpose"><span class="refname">Imagick::compareImageLayers</span> — <span class="dc-title">Returns the maximum bounding region between images</span></p>
</div>
<div class="refsect1 description" id="refsect1-imagick.compareimagelayers-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><a href="class.imagick.html" class="type Imagick">Imagick</a></span> <span class="methodname"><strong>Imagick::compareImageLayers</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$method</code></span>
)</div>
<p class="para rdfs-comment">
Compares each image with the next in a sequence and returns the
maximum bounding region of any pixel differences it discovers.
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.compareimagelayers-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">method</code></em></span>
<dd>
<p class="para">
One of the <a href="imagick.constants.html#imagick.constants.layermethod" class="link">layer method constants</a>.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-imagick.compareimagelayers-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.compareimagelayers-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws ImagickException on error.
</p>
</div>
<div class="refsect1 examples" id="refsect1-imagick.compareimagelayers-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3316">
<p><strong>Example #1 Using <span class="function"><strong>Imagick::compareImageLayers()</strong></span></strong></p>
<div class="example-contents"><p>
Comparing image layers
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">/* create new imagick object */<br /></span><span style="color: #0000BB">$im </span><span style="color: #007700">= new </span><span style="color: #0000BB">Imagick</span><span style="color: #007700">(</span><span style="color: #DD0000">"test.gif"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* optimize the image layers */<br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">$im</span><span style="color: #007700">-></span><span style="color: #0000BB">compareImageLayers</span><span style="color: #007700">(</span><span style="color: #0000BB">imagick</span><span style="color: #007700">::</span><span style="color: #0000BB">LAYERMETHOD_COALESCE</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* work on the $result */<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-imagick.compareimagelayers-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="imagick.optimizeimagelayers.html" class="function" rel="rdfs-seeAlso">Imagick::optimizeImageLayers()</a> - Removes repeated portions of images to optimize</span></li>
<li class="member"> <span class="function"><a href="imagick.writeimages.html" class="function" rel="rdfs-seeAlso">Imagick::writeImages()</a> - Writes an image or image sequence</span></li>
<li class="member"> <span class="function"><a href="imagick.writeimage.html" class="function" rel="rdfs-seeAlso">Imagick::writeImage()</a> - Writes an image to the specified filename</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagick.compareimagechannels.html">Imagick::compareImageChannels</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.compareimages.html">Imagick::compareImages</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>
