ImagickPixelIterator

class ImagickPixelIterator implements Iterator (View source)

Methods

__construct(Imagick $wand)

(PECL imagick 2.0.0)
The ImagickPixelIterator constructor

bool
newPixelIterator(Imagick $wand)

(PECL imagick 2.0.0)
Returns a new pixel iterator

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

(PECL imagick 2.0.0)
Returns a new pixel iterator

int
getIteratorRow()

(PECL imagick 2.0.0)
Returns the current pixel iterator row

bool
setIteratorRow(int $row)

(PECL imagick 2.0.0)
Set the pixel iterator row

bool
setIteratorFirstRow()

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

bool
setIteratorLastRow()

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

array
getPreviousIteratorRow()

(PECL imagick 2.0.0)
Returns the previous row

array
getCurrentIteratorRow()

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

array
getNextIteratorRow()

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

bool
resetIterator()

(PECL imagick 2.0.0)
Resets the pixel iterator

bool
syncIterator()

(PECL imagick 2.0.0)
Syncs the pixel iterator

bool
destroy()

(PECL imagick 2.0.0)
Deallocates resources associated with a PixelIterator

bool
clear()

(PECL imagick 2.0.0)
Clear resources associated with a PixelIterator

static 
getpixeliterator(Imagick $Imagick)

No description

static 
getpixelregioniterator(Imagick $Imagick, $x, $y, $columns, $rows)

No description

mixed
key()

No description

void
next()

No description

void
rewind()

No description

mixed
current()

No description

bool
valid()

No description

Details

at line 6831
__construct(Imagick $wand)

(PECL imagick 2.0.0)
The ImagickPixelIterator constructor

Parameters

Imagick $wand

Exceptions

ImagickPixelIteratorException
ImagickException

at line 6842
bool newPixelIterator(Imagick $wand)

(PECL imagick 2.0.0)
Returns a new pixel iterator

Parameters

Imagick $wand

Return Value

bool

TRUE on success. Throwing ImagickPixelIteratorException.

Exceptions

ImagickPixelIteratorException
ImagickException

at line 6858
bool newPixelRegionIterator(Imagick $wand, int $x, int $y, int $columns, int $rows)

(PECL imagick 2.0.0)
Returns a new pixel iterator

Parameters

Imagick $wand
int $x
int $y
int $columns
int $rows

Return Value

bool

a new ImagickPixelIterator on success; on failure, throws ImagickPixelIteratorException

Exceptions

ImagickPixelIteratorException
ImagickException

at line 6868
int getIteratorRow()

(PECL imagick 2.0.0)
Returns the current pixel iterator row

Return Value

int

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

Exceptions

ImagickPixelIteratorException

at line 6879
bool setIteratorRow(int $row)

(PECL imagick 2.0.0)
Set the pixel iterator row

Parameters

int $row

Return Value

bool

TRUE on success.

Exceptions

ImagickPixelIteratorException

at line 6888
bool setIteratorFirstRow()

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

Return Value

bool

TRUE on success.

Exceptions

ImagickPixelIteratorException

at line 6897
bool setIteratorLastRow()

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

Return Value

bool

TRUE on success.

Exceptions

ImagickPixelIteratorException

at line 6907
array getPreviousIteratorRow()

(PECL imagick 2.0.0)
Returns the previous row

Return Value

array

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

Exceptions

ImagickPixelIteratorException

at line 6917
array getCurrentIteratorRow()

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

Return Value

array

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

Exceptions

ImagickPixelIteratorException

at line 6928
array getNextIteratorRow()

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

Return Value

array

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

Exceptions

ImagickPixelIteratorException

at line 6938
bool resetIterator()

(PECL imagick 2.0.0)
Resets the pixel iterator

Return Value

bool

TRUE on success.

Exceptions

ImagickPixelIteratorException

at line 6947
bool syncIterator()

(PECL imagick 2.0.0)
Syncs the pixel iterator

Return Value

bool

TRUE on success.

Exceptions

ImagickPixelIteratorException

at line 6956
bool destroy()

(PECL imagick 2.0.0)
Deallocates resources associated with a PixelIterator

Return Value

bool

TRUE on success.

Exceptions

ImagickPixelIteratorException

at line 6965
bool clear()

(PECL imagick 2.0.0)
Clear resources associated with a PixelIterator

Return Value

bool

TRUE on success.

Exceptions

ImagickPixelIteratorException

at line 6972
static getpixeliterator(Imagick $Imagick)

No description

Parameters

Imagick $Imagick

Exceptions

ImagickPixelIteratorException
ImagickException

at line 6983
static getpixelregioniterator(Imagick $Imagick, $x, $y, $columns, $rows)

No description

Parameters

Imagick $Imagick
$x
$y
$columns
$rows

Exceptions

ImagickPixelIteratorException
ImagickException

at line 6988
mixed key()

No description

Return Value

mixed

TKey on success, or null on failure.

Exceptions

ImagickPixelIteratorException

at line 6993
void next()

No description

Return Value

void

Any returned value is ignored.

Exceptions

ImagickPixelIteratorException

at line 6998
void rewind()

No description

Return Value

void

Any returned value is ignored.

Exceptions

ImagickPixelIteratorException

at line 7003
mixed current()

No description

Return Value

mixed

Can return any type.

Exceptions

ImagickPixelIteratorException

at line 7008
bool valid()

No description

Return Value

bool

The return value will be casted to boolean and then evaluated. Returns true on success or false on failure.

Exceptions

ImagickPixelIteratorException