Imagick::getPixelRegionIterator

(PECL imagick 2, PECL imagick 3)

Imagick::getPixelRegionIteratorGet an ImagickPixelIterator for an image section

Description

public Imagick::getPixelRegionIterator(
    int $x,
    int $y,
    int $columns,
    int $rows
): ImagickPixelIterator

Get an ImagickPixelIterator for an image section.

Parameters

x

The x-coordinate of the region.

y

The y-coordinate of the region.

columns

The width of the region.

rows

The height of the region.

Return Values

Returns an ImagickPixelIterator for an image section.

Errors/Exceptions

Throws ImagickException on error.

Examples

Example #1 Imagick::getPixelRegionIterator() example

Iterate over the pixels in the top left of the image, changing them to be black.

<?php
$im 
= new Imagick(realpath("./testImage.png"));
$areaIterator $im->getPixelRegionIterator(001010);

foreach (
$areaIterator as $rowIterator) {
    foreach (
$rowIterator as $pixel) {
        
// Paint every pixel black
        
$pixel->setColor("rgba(0, 0, 0, 0)");
    }
    
$areaIterator->syncIterator();
}
$im->writeImage("./output.png");
?>