MagickAverageImages
@@ -173,6 +191,270 @@ _8c.html" target="source" name="MagickAverageImages">MagickAverageImagesClonePixelView
+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.
MagickClipPathImage
MagickBooleanType MagickColorFloodfillImage(MagickWand *wand,
const PixelWand *fill,const double fuzz,const PixelWand *bordercolor,
- const long x,const long y)
+ const ssize_t x,const ssize_t y)
A description of each parameter follows:
@@ -426,7 +708,7 @@ _8c.html" target="source" name="MagickGetImageMatte">MagickGetImageMatteThe format of the MagickGetImageMatte method is:- unsigned long MagickGetImageMatte(MagickWand *wand) + size_t MagickGetImageMatte(MagickWand *wand)
A description of each parameter follows:
@@ -439,7 +721,7 @@ _8c.html" target="source" name="MagickGetImageMatte">MagickGetImageMatteMagickGetImagePixelsMagickGetImagePixels() extracts pixel data from an image and returns it to you. The method returns MagickTrue on success otherwise MagickFalse if an error is encountered. The data is returned as char, short int, int, long, float, or double in the order specified by map.
+MagickGetImagePixels() extracts pixel data from an image and returns it to you. The method returns MagickTrue on success otherwise MagickFalse if an error is encountered. The data is returned as char, short int, int, ssize_t, float, or double in the order specified by map.
Suppose you want to extract the first scanline of a 640x480 image as character data in red-green-blue order:
@@ -451,8 +733,8 @@ _8c.html" target="source" name="MagickGetImagePixels">MagickGetImagePixels MagickBooleanType MagickGetImagePixels(MagickWand *wand, - const long x,const long y,const unsigned long columns, - const unsigned long rows,const char *map,const StorageType storage, + const ssize_t x,const ssize_t y,const size_t columns, + const size_t rows,const char *map,const StorageType storage, void *pixels) @@ -532,7 +814,7 @@ _8c.html" target="source" name="MagickMatteFloodfillImage">MagickMatteFloodfillI
MagickBooleanType MagickMatteFloodfillImage(MagickWand *wand,
const double alpha,const double fuzz,const PixelWand *bordercolor,
- const long x,const long y)
+ const ssize_t x,const ssize_t y)
A description of each parameter follows:
@@ -649,7 +931,7 @@ _8c.html" target="source" name="MagickPaintFloodfillImage">MagickPaintFloodfillI
MagickBooleanType MagickPaintFloodfillImage(MagickWand *wand,
const ChannelType channel,const PixelWand *fill,const double fuzz,
- const PixelWand *bordercolor,const long x,const long y)
+ const PixelWand *bordercolor,const ssize_t x,const ssize_t y)
A description of each parameter follows:
@@ -745,7 +1027,7 @@ _8c.html" target="source" name="MagickRecolorImage">MagickRecolorImageMagickBooleanType MagickRecolorImage(MagickWand *wand, - const unsigned long order,const double *color_matrix) + const size_t order,const double *color_matrix)
A description of each parameter follows:
@@ -794,7 +1076,7 @@ _8c.html" target="source" name="MagickSetImageIndex">MagickSetImageIndexThe format of the MagickSetImageIndex method is:- MagickBooleanType MagickSetImageIndex(MagickWand *wand,const long index) + MagickBooleanType MagickSetImageIndex(MagickWand *wand,const ssize_t index)
A description of each parameter follows:
@@ -844,8 +1126,8 @@ _8c.html" target="source" name="MagickRegionOfInterestImage">MagickRegionOfInterMagickWand *MagickRegionOfInterestImage(MagickWand *wand, - const unsigned long width,const unsigned long height,const long x, - const long y) + const size_t width,const size_t height,const ssize_t x, + const ssize_t y)
A description of each parameter follows:
@@ -870,7 +1152,7 @@ _8c.html" target="source" name="MagickRegionOfInterestImage">MagickRegionOfInter _8c.html" target="source" name="MagickSetImagePixels">MagickSetImagePixelsMagickSetImagePixels() accepts pixel datand stores it in the image at the location you specify. The method returns MagickFalse on success otherwise MagickTrue if an error is encountered. The pixel data can be either char, short int, int, long, float, or double in the order specified by map.
+MagickSetImagePixels() accepts pixel datand stores it in the image at the location you specify. The method returns MagickFalse on success otherwise MagickTrue if an error is encountered. The pixel data can be either char, short int, int, ssize_t, float, or double in the order specified by map.
Suppose your want to upload the first scanline of a 640x480 image from character data in red-green-blue order:
@@ -882,8 +1164,8 @@ _8c.html" target="source" name="MagickSetImagePixels">MagickSetImagePixels MagickBooleanType MagickSetImagePixels(MagickWand *wand, - const long x,const long y,const unsigned long columns, - const unsigned long rows,const char *map,const StorageType storage, + const ssize_t x,const ssize_t y,const size_t columns, + const size_t rows,const char *map,const StorageType storage, const void *pixels) @@ -929,6 +1211,46 @@ _8c.html" target="source" name="MagickWriteImageBlob">MagickWriteImageBlobNewPixelView
+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.
PixelGetNextRow
PixelWand **PixelGetNextRow(PixelIterator *iterator, - unsigned long *number_wands) + size_t *number_wands)
A description of each parameter follows:
@@ -972,14 +1294,116 @@ _8c.html" target="source" name="PixelIteratorGetException">PixelIteratorGetExcepthe severity of the error is returned here.
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.