Imagick::getIteratorIndex

現在アクティブな画像のインデックスを取得する

説明

public int Imagick::getIteratorIndex()

Imagick オブジェクト内で現在アクティブな画像のインデックスを取得します。 このメソッドは、ImageMagick バージョン 6.2.9 以降で Imagick をコンパイルした場合に使用可能です。

パラメータ

この関数にはパラメータはありません。

戻り値

スタック内の画像のインデックスを含む整数値を返します。

エラー / 例外

エラー時に ImagickException をスローします。

例1 Imagick::getIteratorIndex の使用法

画像を作成し、インデックスの設定と取得を行います。

<?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();
?>

参考

  • Imagick::setIteratorIndex
  • Imagick::getImageIndex
  • Imagick::setImageIndex