php8.5
Home/ Manual/ imagick / imagick/ Imagick::getPixelRegionIterator

Imagick::getPixelRegionIterator

PHP function Edit on GitHub ✎

(PECL imagick 2, PECL imagick 3)

Get an ImagickPixelIterator for an image section

Description

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

Examples

Imagick::getPixelRegionIterator example

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

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

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");
?>

Source: reference/imagick/imagick/getpixelregioniterator.xml · from the official PHP manual (php/doc-en)