ImageMagick: MagickWand, C API for ImageMagick: Pixel View Methods
Author: ImageMagick Studio LLC
Description: 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 GPL. It runs on all major operating systems. The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (P [cell cut: 1167 characters, first 1000 kept]
Keywords: magickwc, api, for, imagemagick:, pixel, view, methods, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing

Unix
Mac OS X
Windows
Processing
Options
Usage
MagickWand
MagickCore
PerlMagick
Magick++
Unix
Windows
Links

## ClonePixelView

ClonePixelView() makes a copy of the specified pixel view.

The format of the ClonePixelView method is:

      PixelView *ClonePixelView(const PixelView *pixel_view)

A description of each parameter follows:

##### pixel_view

the pixel view.

## DestroyPixelView

DestroyPixelView() deallocates memory associated with a pixel view.

The format of the DestroyPixelView method is:

      PixelView *DestroyPixelView(PixelView *pixel_view,
        const size_t number_wands,const size_t number_threads)

A description of each parameter follows:

##### pixel_view

the pixel view.

##### number_wand

the number of pixel wands.

##### number_threads

number of threads.

## DuplexTransferPixelViewIterator

DuplexTransferPixelViewIterator() iterates over three pixel views in parallel and calls your transfer method for each scanline of the view. The source and duplex pixel region is not confined to the image canvas-- that is you can include negative offsets or widths or heights that exceed the image dimension. However, the destination pixel view is confined to the image canvas-- that is no negative offsets or widths or heights that exceed the image dimension are permitted.

Use this pragma:

          #pragma omp critical

to define a section of code in your callback transfer method that must be executed by a single thread at a time.

The format of the DuplexTransferPixelViewIterator method is:

      MagickBooleanType DuplexTransferPixelViewIterator(PixelView *source,
        PixelView *duplex,PixelView *destination,
        DuplexTransferPixelViewMethod transfer,void *context)

A description of each parameter follows:

##### source

the source pixel view.

##### duplex

the duplex pixel view.

##### destination

the destination pixel view.

##### transfer

the transfer callback method.

##### context

the user defined context.

## GetPixelViewException

GetPixelViewException() returns the severity, reason, and description of any error that occurs when utilizing a pixel view.

The format of the GetPixelViewException method is:

      char *GetPixelViewException(const PixelWand *pixel_view,
        ExceptionType *severity)

A description of each parameter follows:

##### pixel_view

the pixel pixel_view.

##### severity

the severity of the error is returned here.

## GetPixelViewHeight

GetPixelViewHeight() returns the pixel view height.

The format of the GetPixelViewHeight method is:

      size_t GetPixelViewHeight(const PixelView *pixel_view)

A description of each parameter follows:

##### pixel_view

the pixel view.

## GetPixelViewIterator

GetPixelViewIterator() iterates over the pixel view in parallel and calls your get method for each scanline of the view. The pixel region is not confined to the image canvas-- that is you can include negative offsets or widths or heights that exceed the image dimension. Any updates to the pixels in your callback are ignored.

Use this pragma:

          #pragma omp critical

to define a section of code in your callback get method that must be executed by a single thread at a time.

The format of the GetPixelViewIterator method is:

      MagickBooleanType GetPixelViewIterator(PixelView *source,
        GetPixelViewMethod get,void *context)

A description of each parameter follows:

##### source

the source pixel view.

##### get

the get callback method.

##### context

the user defined context.

## GetPixelViewPixels

GetPixelViewPixels() returns the pixel view pixel_wands.

The format of the GetPixelViewPixels method is:

      PixelWand *GetPixelViewPixels(const PixelView *pixel_view)

A description of each parameter follows:

##### pixel_view

the pixel view.

## GetPixelViewWand

GetPixelViewWand() returns the magick wand associated with the pixel view.

The format of the GetPixelViewWand method is:

      MagickWand *GetPixelViewWand(const PixelView *pixel_view)

A description of each parameter follows:

##### pixel_view

the pixel view.

## GetPixelViewWidth

GetPixelViewWidth() returns the pixel view width.

The format of the GetPixelViewWidth method is:

      size_t GetPixelViewWidth(const PixelView *pixel_view)

A description of each parameter follows:

##### pixel_view

the pixel view.

## GetPixelViewX

GetPixelViewX() returns the pixel view x offset.

The format of the GetPixelViewX method is:

      ssize_t GetPixelViewX(const PixelView *pixel_view)

A description of each parameter follows:

##### pixel_view

the pixel view.

## GetPixelViewY

GetPixelViewY() returns the pixel view y offset.

The format of the GetPixelViewY method is:

      ssize_t GetPixelViewY(const PixelView *pixel_view)

A description of each parameter follows:

##### pixel_view

the pixel view.

## IsPixelView

IsPixelView() returns MagickTrue if the the parameter is verified as a pixel view container.

The format of the IsPixelView method is:

      MagickBooleanType IsPixelView(const PixelView *pixel_view)

A description of each parameter follows:

##### pixel_view

the pixel view.

## NewPixelView

NewPixelView() returns a pixel view required for all other methods in the Pixel View API.

The format of the NewPixelView method is:

      PixelView *NewPixelView(MagickWand *wand)

A description of each parameter follows:

##### wand

the wand.

## NewPixelViewRegion

NewPixelViewRegion() returns a pixel view required for all other methods in the Pixel View API.

The format of the NewPixelViewRegion method is:

      PixelView *NewPixelViewRegion(MagickWand *wand,const ssize_t x,
        const ssize_t y,const size_t width,const size_t height)

A description of each parameter follows:

##### wand

the magick wand.

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

These values define the perimeter of a region of pixel_wands view.

## SetPixelViewIterator

SetPixelViewIterator() iterates over the pixel view in parallel and calls your set method for each scanline of the view. The pixel region is confined to the image canvas-- that is no negative offsets or widths or heights that exceed the image dimension. The pixels are initiallly undefined and any settings you make in the callback method are automagically synced back to your image.

Use this pragma:

          #pragma omp critical

to define a section of code in your callback set method that must be executed by a single thread at a time.

The format of the SetPixelViewIterator method is:

      MagickBooleanType SetPixelViewIterator(PixelView *destination,
        SetPixelViewMethod set,void *context)

A description of each parameter follows:

##### destination

the pixel view.

##### set

the set callback method.

##### context

the user defined context.

## TransferPixelViewIterator

TransferPixelViewIterator() iterates over two pixel views in parallel and calls your transfer method for each scanline of the view. The source pixel region is not confined to the image canvas-- that is you can include negative offsets or widths or heights that exceed the image dimension. However, the destination pixel view is confined to the image canvas-- that is no negative offsets or widths or heights that exceed the image dimension are permitted.

Use this pragma:

          #pragma omp critical

to define a section of code in your callback transfer method that must be executed by a single thread at a time.

The format of the TransferPixelViewIterator method is:

      MagickBooleanType TransferPixelViewIterator(PixelView *source,
        PixelView *destination,TransferPixelViewMethod transfer,void *context)

A description of each parameter follows:

##### source

the source pixel view.

##### destination

the destination pixel view.

##### transfer

the transfer callback method.

##### context

the user defined context.

## UpdatePixelViewIterator

UpdatePixelViewIterator() iterates over the pixel view in parallel and calls your update method for each scanline of the view. The pixel region is confined to the image canvas-- that is no negative offsets or widths or heights that exceed the image dimension are permitted. Updates to pixels in your callback are automagically synced back to the image.

Use this pragma:

          #pragma omp critical

to define a section of code in your callback update method that must be executed by a single thread at a time.

The format of the UpdatePixelViewIterator method is:

      MagickBooleanType UpdatePixelViewIterator(PixelView *source,
        UpdatePixelViewMethod update,void *context)

A description of each parameter follows:

##### source

the source pixel view.

##### update

the update callback method.

##### context

the user defined context.

Discourse Server • Studio