PHP | Imagick getImageIndex() Function

The Imagick::getImageIndex() function is an inbuilt function in PHP which is used to get the index of the current image.

Syntax:

int Imagick::getImageIndex( void )

Parameters: This function does not accept any parameter.

Return Value: This function returns an integer value containing the index of the image in the stack.

Exceptions: This function throws ImagickException on error.

Below program illustrates the Imagick::getImageIndex() 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 Index
$index = $imagick->getImageIndex();
echo $index;
?>

Output:

0 which means the first image.

Program 2:

<?php

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

// Add two more images in the same imagick object
$imagick->addImage( new Imagick(
'https://media.geeksforgeeks.org/wp-content/uploads/geeksforgeeks-13.png'));

$imagick->addImage( new Imagick(
'https://media.geeksforgeeks.org/wp-content/uploads/geeksforgeeks-13.png'));

// Get the Index
$index = $imagick->getImageIndex();
echo $index;
?>

Output:

2

Reference: https://www.php.net/manual/en/imagick.getimageindex.php