ImagickPixelIterator

• Full name: \ImagickPixelIterator
• This class implements: \Iterator

See Also:

• https://php.net/manual/en/class.imagickpixeliterator.php -

Methods

__construct

(PECL imagick 2.0.0)
The ImagickPixelIterator constructor

public __construct(\Imagick $wand): mixed

Parameters:

Parameter	Type	Description
$wand	\Imagick

See Also:

• https://php.net/manual/en/imagickpixeliterator.construct.php -

---

newPixelIterator

(PECL imagick 2.0.0)
Returns a new pixel iterator

public newPixelIterator(\Imagick $wand): bool

Parameters:

Parameter	Type	Description
$wand	\Imagick

Return Value:

TRUE on success. Throwing ImagickPixelIteratorException.

Throws:

• ImagickPixelIteratorException

See Also:

• https://php.net/manual/en/imagickpixeliterator.newpixeliterator.php -

---

newPixelRegionIterator

(PECL imagick 2.0.0)
Returns a new pixel iterator

public newPixelRegionIterator(\Imagick $wand, int $x, int $y, int $columns, int $rows): bool

Parameters:

Parameter	Type	Description
$wand	\Imagick
$x	int
$y	int
$columns	int
$rows	int

Return Value:

a new ImagickPixelIterator on success; on failure, throws ImagickPixelIteratorException

Throws:

• ImagickPixelIteratorException

See Also:

• https://php.net/manual/en/imagickpixeliterator.newpixelregioniterator.php -

---

getIteratorRow

(PECL imagick 2.0.0)
Returns the current pixel iterator row

public getIteratorRow(): int

Return Value:

the integer offset of the row, throwing ImagickPixelIteratorException on error.

Throws:

on error

• ImagickPixelIteratorException

See Also:

• https://php.net/manual/en/imagickpixeliterator.getiteratorrow.php -

---

setIteratorRow

(PECL imagick 2.0.0)
Set the pixel iterator row

public setIteratorRow(int $row): bool

Parameters:

Parameter	Type	Description
$row	int

Return Value:

TRUE on success.

See Also:

• https://php.net/manual/en/imagickpixeliterator.setiteratorrow.php -

---

setIteratorFirstRow

(PECL imagick 2.0.0)
Sets the pixel iterator to the first pixel row

public setIteratorFirstRow(): bool

Return Value:

TRUE on success.

See Also:

• https://php.net/manual/en/imagickpixeliterator.setiteratorfirstrow.php -

---

setIteratorLastRow

(PECL imagick 2.0.0)
Sets the pixel iterator to the last pixel row

public setIteratorLastRow(): bool

Return Value:

TRUE on success.

See Also:

• https://php.net/manual/en/imagickpixeliterator.setiteratorlastrow.php -

---

getPreviousIteratorRow

(PECL imagick 2.0.0)
Returns the previous row

public getPreviousIteratorRow(): array

Return Value:

the previous row as an array of ImagickPixelWand objects from the ImagickPixelIterator, throwing ImagickPixelIteratorException on error.

Throws:

on error

• ImagickPixelIteratorException

See Also:

• https://php.net/manual/en/imagickpixeliterator.getpreviousiteratorrow.php -

---

getCurrentIteratorRow

(PECL imagick 2.0.0)
Returns the current row of ImagickPixel objects

public getCurrentIteratorRow(): array

Return Value:

a row as an array of ImagickPixel objects that can themselves be iterated.

See Also:

• https://php.net/manual/en/imagickpixeliterator.getcurrentiteratorrow.php -

---

getNextIteratorRow

(PECL imagick 2.0.0)
Returns the next row of the pixel iterator

public getNextIteratorRow(): array

Return Value:

the next row as an array of ImagickPixel objects, throwing ImagickPixelIteratorException on error.

Throws:

on error

• ImagickPixelIteratorException

See Also:

• https://php.net/manual/en/imagickpixeliterator.getnextiteratorrow.php -

---

resetIterator

(PECL imagick 2.0.0)
Resets the pixel iterator

public resetIterator(): bool

Return Value:

TRUE on success.

See Also:

• https://php.net/manual/en/imagickpixeliterator.resetiterator.php -

---

syncIterator

(PECL imagick 2.0.0)
Syncs the pixel iterator

public syncIterator(): bool

Return Value:

TRUE on success.

See Also:

• https://php.net/manual/en/imagickpixeliterator.synciterator.php -

---

destroy

(PECL imagick 2.0.0)
Deallocates resources associated with a PixelIterator

public destroy(): bool

Return Value:

TRUE on success.

See Also:

• https://php.net/manual/en/imagickpixeliterator.destroy.php -

---

clear

(PECL imagick 2.0.0)
Clear resources associated with a PixelIterator

public clear(): bool

Return Value:

TRUE on success.

See Also:

• https://php.net/manual/en/imagickpixeliterator.clear.php -

---

getpixeliterator

public static getpixeliterator(\Imagick $Imagick): mixed

• This method is static.

Parameters:

Parameter	Type	Description
$Imagick	\Imagick

---

getpixelregioniterator

public static getpixelregioniterator(\Imagick $Imagick, mixed $x, mixed $y, mixed $columns, mixed $rows): mixed

• This method is static.

Parameters:

Parameter	Type	Description
$Imagick	\Imagick
$x	mixed
$y	mixed
$columns	mixed
$rows	mixed

---

key

public key(): mixed

---

next

public next(): mixed

---

rewind

public rewind(): mixed

---

current

public current(): mixed

---

valid

public valid(): mixed

---

---

Automatically generated on 2025-03-18