Open In App

PHP | Imagick setImageIndex() Function

Improve
Improve
Like Article
Like
Save
Share
Report

The Imagick::setImageIndex() function is an inbuilt function in PHP which is used to set the iterator position.

Syntax:

bool Imagick::setImageIndex( int $index )

Parameters: This function accepts a single parameter $index which holds the index.

Return Value: This function returns TRUE on success.

Exceptions: This function throws ImagickException on error.

Below given programs illustrate the Imagick::setImageIndex() function in PHP:

Program 1:




<?php 
  
// Create a new imagick object 
$imagick = new Imagick( 
    
// Add two more images in the same imagick object 
$imagick->addImage( new Imagick( 
    
$imagick->addImage( new Imagick( 
  
// Currently Cursor is at 2
// Set the Index to 0
$imagick->setImageIndex(0);
  
// Get the Index 
$index = $imagick->getImageIndex(); 
echo $index
?> 


Output:

0

Program 2:




<?php 
  
// Create a new imagick object 
$imagick = new Imagick( 
    
// Add two more images in the same imagick object 
$imagick->addImage( new Imagick(
  
// Currently Cursor is at 1
// Set the Index to 0
$imagick->setImageIndex(0);
  
// getImageBlob() should show last added image but
// cursor is set to 0 thus it shows first image
header("Content-Type: image/png");
echo $imagick->getImageBlob();
?>


Output:
spread-after

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



Last Updated : 28 Nov, 2019
Like Article
Save Article
Previous
Next
Share your thoughts in the comments
Similar Reads