Imagick::getIteratorIndex

(PECL imagick 2.0.0)

Gets the index of the current active image

int Imagick::getIteratorIndex ( void )

Returns the index of the current active image within the Imagick object. This method is available if Imagick has been compiled against ImageMagick version 6.2.9 or newer.

Returns:

Returns an integer containing the index of the image in the stack.

Exception:

Throws ImagickException on error.

Examples:

Using Imagick::getIteratorIndex() :

Create images, set and get the iterator index

<?php
$im = new Imagick();
$im->newImage(100, 100, new ImagickPixel("red"));
$im->newImage(100, 100, new ImagickPixel("green"));
$im->newImage(100, 100, new ImagickPixel("blue"));
 
$im->setIteratorIndex(1);
echo $im->getIteratorIndex();
?>