# ImageMagick: MagickWand, C API for ImageMagick: Pixel Iterator Methods
ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves. ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the [cut: 1167 characters, first 599 kept]
Author: ImageMagick Studio LLC
Keywords: magickwc, api, for, imagemagick:, pixel, iterator, methods, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand

## ClearPixelIterator

ClearPixelIterator() clear resources associated with a PixelIterator.

The format of the ClearPixelIterator method is:

      PixelIterator *ClearPixelIterator(PixelIterator *iterator)

A description of each parameter follows:

##### iterator

The pixel iterator.

## DestroyPixelIterator

DestroyPixelIterator() deallocates resources associated with a PixelIterator.

The format of the DestroyPixelIterator method is:

      PixelIterator *DestroyPixelIterator(PixelIterator *iterator)

A description of each parameter follows:

##### iterator

The pixel iterator.

## IsPixelIterator

IsPixelIterator() returns MagickTrue if the iterator is verified as a pixel iterator.

The format of the IsPixelIterator method is:

      MagickBooleanType IsPixelIterator(const PixelIterator *iterator)

A description of each parameter follows:

##### iterator

The magick iterator.

## NewPixelIterator

NewPixelIterator() returns a new pixel iterator.

The format of the NewPixelIterator method is:

      PixelIterator NewPixelIterator(MagickWand *wand)

A description of each parameter follows:

##### wand

The magick wand.

## PixelClearIteratorException

PixelClearIteratorException() clear any exceptions associated with the iterator.

The format of the PixelClearIteratorException method is:

      MagickBooleanType PixelClearIteratorException(PixelIterator *wand)

A description of each parameter follows:

##### wand

The pixel wand.

## NewPixelRegionIterator

NewPixelRegionIterator() returns a new pixel iterator.

The format of the NewPixelRegionIterator method is:

      PixelIterator NewPixelRegionIterator(MagickWand *wand,const long x,
        const long y,const unsigned long columns,const unsigned long rows,
        const MagickBooleanType modify)

A description of each parameter follows:

##### wand

The magick wand.

##### x,y,columns,rows

These values define the perimeter of a region of pixels.

## PixelGetCurrentIteratorRow

PixelGetCurrentIteratorRow() returns the current row as an array of pixel wands from the pixel iterator.

The format of the PixelGetCurrentIteratorRow method is:

      PixelWand **PixelGetCurrentIteratorRow(PixelIterator *iterator,
        unsigned long *number_wands)

A description of each parameter follows:

##### iterator

The pixel iterator.

##### number_wands

The number of pixel wands.

## PixelGetIteratorException

PixelGetIteratorException() returns the severity, reason, and description of any error that occurs when using other methods in this API.

The format of the PixelGetIteratorException method is:

      char *PixelGetIteratorException(const Pixeliterator *iterator,
        ExceptionType *severity)

A description of each parameter follows:

##### iterator

The pixel iterator.

##### severity

The severity of the error is returned here.

## PixelGetIteratorRow

PixelGetIteratorRow() returns the crurent pixel iterator row.

The format of the PixelGetIteratorRow method is:

      MagickBooleanType PixelGetIteratorRow(PixelIterator *iterator)

A description of each parameter follows:

##### iterator

The pixel iterator.

## PixelGetNextIteratorRow

PixelGetNextIteratorRow() returns the next row as an array of pixel wands from the pixel iterator.

The format of the PixelGetNextIteratorRow method is:

      PixelWand **PixelGetNextIteratorRow(PixelIterator *iterator,
        unsigned long *number_wands)

A description of each parameter follows:

##### iterator

The pixel iterator.

##### number_wands

The number of pixel wands.

## PixelGetPreviousIteratorRow

PixelGetPreviousIteratorRow() returns the previous row as an array of pixel wands from the pixel iterator.

The format of the PixelGetPreviousIteratorRow method is:

      PixelWand **PixelGetPreviousIteratorRow(PixelIterator *iterator,
        unsigned long *number_wands)

A description of each parameter follows:

##### iterator

The pixel iterator.

##### number_wands

The number of pixel wands.

## PixelResetIterator

PixelResetIterator() resets the pixel iterator. Use it in conjunction with PixelGetNextIteratorRow() to iterate over all the pixels in a pixel container.

The format of the PixelResetIterator method is:

      void PixelResetIterator(PixelIterator *iterator)

A description of each parameter follows:

##### iterator

The pixel iterator.

## PixelSetFirstIteratorRow

PixelSetFirstIteratorRow() sets the pixel iterator to the first pixel row.

The format of the PixelSetFirstIteratorRow method is:

      void PixelSetFirstIteratorRow(PixelIterator *iterator)

A description of each parameter follows:

##### iterator

The magick iterator.

## PixelSetIteratorRow

PixelSetIteratorRow() set the pixel iterator row.

The format of the PixelSetIteratorRow method is:

      MagickBooleanType PixelSetIteratorRow(PixelIterator *iterator,
        const long row)

A description of each parameter follows:

##### iterator

The pixel iterator.

## PixelSetLastIteratorRow

PixelSetLastIteratorRow() sets the pixel iterator to the last pixel row.

The format of the PixelSetLastIteratorRow method is:

      void PixelSetLastIteratorRow(PixelIterator *iterator)

A description of each parameter follows:

##### iterator

The magick iterator.

## PixelSyncIterator

PixelSyncIterator() syncs the pixel iterator.

The format of the PixelSyncIterator method is:

      MagickBooleanType PixelSyncIterator(PixelIterator *iterator)

A description of each parameter follows:

##### iterator

The pixel iterator.

Discourse Server • Mailing Lists • ImageMagick Studio