PHP | ImagickPixelIterator setIteratorLastRow() Function

The ImagickPixelIterator::setIteratorLastRow() function is an inbuilt function in PHP which is used to set the pixel iterator to the last pixel row.

Syntax:

bool ImagickPixelIterator::setIteratorLastRow( void )

Parameters: This function doesn’t accepts any parameters.

Return Value: This function returns TRUE on success.

Below programs illustrate the ImagickPixelIterator::setIteratorLastRow() function in PHP:

Program 1:

<?php

// Create a new imagick object
$imagick = new Imagick(
'https://media.geeksforgeeks.org/wp-content/uploads/geeksforgeeks-13.png');

// Get the pixel iterator
$pixelIterator = $imagick->getPixelIterator();

// Get the current iterator row
echo "Current row is " . $pixelIterator->getIteratorRow();

// Set the iterator to last row
$pixelIterator->setIteratorLastRow();

// Get the current iterator row
echo "<br>Current row is " . $pixelIterator->getIteratorRow();
?>

Output:

Current row is 0
Current row is 183

Program 2:

<?php

// Create a new imagick object
$imagick = new Imagick();

// Create a image on imagick object
$imagick->newImage(800, 250, 'black');

// Get the pixel iterator
$pixelIterator = $imagick->getPixelIterator();

// Set the iterator to last row
$pixelIterator->setIteratorLastRow();

$row = $pixelIterator->getIteratorRow() + 1;
echo "<br>Total number of rows in image is " . $row;
?>

Output:

Total number of rows in image is 250

Reference: https://www.php.net/manual/en/imagickpixeliterator.setiteratorlastrow.php