<!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>Get an ImagickPixelIterator for an image section</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagick.getpixeliterator.html">Imagick::getPixelIterator</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.getpointsize.html">Imagick::getPointSize</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.getpixelregioniterator" class="refentry">
<div class="refnamediv">
<h1 class="refname">Imagick::getPixelRegionIterator</h1>
<p class="verinfo">(PECL imagick 2.0.0)</p><p class="refpurpose"><span class="refname">Imagick::getPixelRegionIterator</span> — <span class="dc-title">Get an ImagickPixelIterator for an image section</span></p>
</div>
<div class="refsect1 description" id="refsect1-imagick.getpixelregioniterator-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><a href="class.imagickpixeliterator.html" class="type ImagickPixelIterator">ImagickPixelIterator</a></span> <span class="methodname"><strong>Imagick::getPixelRegionIterator</strong></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>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$columns</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$rows</code></span>
)</div>
<p class="para rdfs-comment">
Get an ImagickPixelIterator for an image section.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-imagick.getpixelregioniterator-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">x</code></dt>
<dd>
<p class="para">
The x-coordinate of the region.
</p>
</dd>
<dt>
<code class="parameter">y</code></dt>
<dd>
<p class="para">
The y-coordinate of the region.
</p>
</dd>
<dt>
<code class="parameter">columns</code></dt>
<dd>
<p class="para">
The width of the region.
</p>
</dd>
<dt>
<code class="parameter">rows</code></dt>
<dd>
<p class="para">
The height of the region.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-imagick.getpixelregioniterator-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an ImagickPixelIterator for an image section.
</p>
</div>
<div class="refsect1 errors" id="refsect1-imagick.getpixelregioniterator-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws ImagickException on error.
</p>
</div>
<div class="refsect1 examples" id="refsect1-imagick.getpixelregioniterator-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3931">
<p><strong>Example #1 <span class="methodname"><strong>Imagick::getPixelRegionIterator()</strong></span> example</strong></p>
<div class="example-contents"><p>
Iterate over the pixels in the top left of the image, changing them to be black.
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$im </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">"./testImage.png"</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$areaIterator </span><span style="color: #007700">= </span><span style="color: #0000BB">$im</span><span style="color: #007700">-></span><span style="color: #0000BB">getPixelRegionIterator</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">10</span><span style="color: #007700">, </span><span style="color: #0000BB">10</span><span style="color: #007700">);<br /><br />foreach (</span><span style="color: #0000BB">$areaIterator </span><span style="color: #007700">as </span><span style="color: #0000BB">$rowIterator</span><span style="color: #007700">) {<br /> foreach (</span><span style="color: #0000BB">$rowIterator </span><span style="color: #007700">as </span><span style="color: #0000BB">$pixel</span><span style="color: #007700">) {<br /> </span><span style="color: #FF8000">// Paint every pixel black<br /> </span><span style="color: #0000BB">$pixel</span><span style="color: #007700">-></span><span style="color: #0000BB">setColor</span><span style="color: #007700">(</span><span style="color: #DD0000">"rgba(0, 0, 0, 0)"</span><span style="color: #007700">);<br /> }<br /> </span><span style="color: #0000BB">$areaIterator</span><span style="color: #007700">-></span><span style="color: #0000BB">syncIterator</span><span style="color: #007700">();<br />}<br /></span><span style="color: #0000BB">$im</span><span style="color: #007700">-></span><span style="color: #0000BB">writeImage</span><span style="color: #007700">(</span><span style="color: #DD0000">"./output.png"</span><span style="color: #007700">);<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.getpixeliterator.html">Imagick::getPixelIterator</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.getpointsize.html">Imagick::getPointSize</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>
