PHP Conference Nagoya 2025

    Imagick::getPixelRegionIterator

    (PECL imagick 2, PECL imagick 3)

    Imagick::getPixelRegionIterator — Get 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(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");
    ?>

    Found A Problem?

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes

    There are no user contributed notes for this page.
    To Top