X-Git-Url: https://granicus.if.org/sourcecode?a=blobdiff_plain;f=www%2Fapi%2Fdeprecate.html;h=9fd0869a646857dd13c57cbae36b0982e245a60a;hb=fe0019bdfa935975704d079243ec632d51bbf706;hp=a72a97da78a33d44a97470a714f82ac7fd280525;hpb=ec63c2db14d55f2b4967776bad2d0f53cba4a319;p=imagemagick diff --git a/www/api/deprecate.html b/www/api/deprecate.html index a72a97da7..9fd0869a6 100644 --- a/www/api/deprecate.html +++ b/www/api/deprecate.html @@ -48,6 +48,19 @@ About ImageMagick
+ +
+ Unix +
+
+ Mac OS X +
+
+ Windows +
+
@@ -75,9 +88,6 @@
Magick++
-
-
- Unix -
-
- Mac OS X -
-
- Windows + Resources
-
@@ -160,6 +160,12 @@ _8c.html" target="source" name="AcquireCacheViewIndexes">AcquireCacheViewIndexes

AcquireCacheViewIndexes() returns the indexes associated with the specified view.

+

Deprecated, replace with:

+ +
+      GetCacheViewVirtualIndexQueue(cache_view);
+
+

The format of the AcquireCacheViewIndexes method is:

@@ -178,12 +184,18 @@ _8c.html" target="source" name="AcquireCacheViewPixels">AcquireCacheViewPixelsAcquireCacheViewPixels() gets pixels from the in-memory or disk pixel cache as defined by the geometry parameters.   A pointer to the pixels is returned if the pixels are transferred, otherwise a NULL is returned.

+

Deprecated, replace with:

+ +
+      GetCacheViewVirtualPixels(cache_view,x,y,columns,rows,exception);
+
+

The format of the AcquireCacheViewPixels method is:

   const PixelPacket *AcquireCacheViewPixels(const CacheView *cache_view,
-    const long x,const long y,const unsigned long columns,
-    const unsigned long rows,ExceptionInfo *exception)
+    const ssize_t x,const ssize_t y,const size_t columns,
+    const size_t rows,ExceptionInfo *exception)
 

A description of each parameter follows:

@@ -210,11 +222,17 @@ _8c.html" target="source" name="AcquireImagePixels">AcquireImagePixels

Note, the AcquireImagePixels() and GetAuthenticPixels() methods are not thread-safe. In a threaded environment, use GetCacheViewVirtualPixels() or GetCacheViewAuthenticPixels() instead.

+

Deprecated, replace with:

+ +
+      GetVirtualPixels(image,x,y,columns,rows,exception);
+
+

The format of the AcquireImagePixels() method is:

-  const PixelPacket *AcquireImagePixels(const Image *image,const long x,
-    const long y,const unsigned long columns,const unsigned long rows,
+  const PixelPacket *AcquireImagePixels(const Image *image,const ssize_t x,
+    const ssize_t y,const size_t columns,const size_t rows,
     ExceptionInfo *exception)
 
@@ -234,7 +252,13 @@ _8c.html" target="source" name="AcquireImagePixels">AcquireImagePixels _8c.html" target="source" name="AcquireIndexes">AcquireIndexes
-

AcquireIndexes() returns the black channel or the colormap indexes associated with the last call to QueueAuthenticPixels() or GetVirtualPixels(). NULL is returned if the black channel or colormap indexes are not available.

+

AcquireIndexes() returns the black channel or the colormap indexes associated with the last call to QueueAuthenticPixels() or GetVirtualPixels(). NULL is returned if the black channel or colormap indexes are not available.

+ +

Deprecated, replace with:

+ +
+      GetVirtualIndexQueue(image);
+

The format of the AcquireIndexes() method is:

@@ -275,11 +299,17 @@ _8c.html" target="source" name="AcquireOneCacheViewPixel">AcquireOneCacheViewPix

AcquireOneCacheViewPixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs. If you plan to modify the pixel, use GetOneCacheViewAuthenticPixel() instead.

+

Deprecated, replace with:

+ +
+      GetOneCacheViewVirtualPixel(cache_view,x,y,pixel,exception);
+
+

The format of the AcquireOneCacheViewPixel method is:

   MagickBooleanType AcquireOneCacheViewPixel(const CacheView *cache_view,
-    const long x,const long y,PixelPacket *pixel,ExceptionInfo *exception)
+    const ssize_t x,const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception)
 

A description of each parameter follows:

@@ -303,13 +333,20 @@ _8c.html" target="source" name="AcquireOneCacheViewVirtualPixel">AcquireOneCache

AcquireOneCacheViewVirtualPixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs. If you plan to modify the pixel, use GetOneCacheViewAuthenticPixel() instead.

+

Deprecated, replace with:

+ +
+      GetOneCacheViewVirtualMethodPixel(cache_view,virtual_pixel_method,
+  x,y,pixel,exception);
+
+

The format of the AcquireOneCacheViewPixel method is:

   MagickBooleanType AcquireOneCacheViewVirtualPixel(
     const CacheView *cache_view,
-    const VirtualPixelMethod virtual_pixel_method,const long x,
-    const long y,PixelPacket *pixel,ExceptionInfo *exception)
+    const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
+    const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception)
 

A description of each parameter follows:

@@ -336,11 +373,18 @@ _8c.html" target="source" name="AcquireOneMagickPixel">AcquireOneMagickPixel

AcquireOneMagickPixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs. If you plan to modify the pixel, use GetOnePixel() instead.

+

Deprecated, replace with:

+ +
+      MagickPixelPacket pixel;
+      GetOneVirtualMagickPixel(image,x,y,&pixel,exception);
+
+

The format of the AcquireOneMagickPixel() method is:

-  MagickPixelPacket AcquireOneMagickPixel(const Image image,const long x,
-    const long y,ExceptionInfo exception)
+  MagickPixelPacket AcquireOneMagickPixel(const Image image,const ssize_t x,
+    const ssize_t y,ExceptionInfo exception)
 

A description of each parameter follows:

@@ -361,11 +405,18 @@ _8c.html" target="source" name="AcquireOnePixel">AcquireOnePixel

AcquireOnePixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs. If you plan to modify the pixel, use GetOnePixel() instead.

+

Deprecated, replace with:

+ +
+      PixelPacket pixel;
+      GetOneVirtualPixel(image,x,y,&pixel,exception);
+
+

The format of the AcquireOnePixel() method is:

-  PixelPacket AcquireOnePixel(const Image image,const long x,
-    const long y,ExceptionInfo exception)
+  PixelPacket AcquireOnePixel(const Image image,const ssize_t x,
+    const ssize_t y,ExceptionInfo exception)
 

A description of each parameter follows:

@@ -386,12 +437,19 @@ _8c.html" target="source" name="AcquireOneVirtualPixel">AcquireOneVirtualPixelAcquireOneVirtualPixel() returns a single pixel at the specified (x,y) location as defined by specified pixel method. The image background color is returned if an error occurs. If you plan to modify the pixel, use GetOnePixel() instead.

+

Deprecated, replace with:

+ +
+      PixelPacket pixel;
+      GetOneVirtualMethodPixel(image,virtual_pixel_method,x,y,&pixel,exception);
+
+

The format of the AcquireOneVirtualPixel() method is:

   PixelPacket AcquireOneVirtualPixel(const Image image,
-    const VirtualPixelMethod virtual_pixel_method,const long x,
-    const long y,ExceptionInfo exception)
+    const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
+    const ssize_t y,ExceptionInfo exception)
 

A description of each parameter follows:

@@ -415,6 +473,12 @@ _8c.html" target="source" name="AcquirePixels">AcquirePixels

AcquirePixels() returns the pixels associated with the last call to QueueAuthenticPixels() or GetVirtualPixels().

+

Deprecated, replace with:

+ +
+      GetVirtualPixelQueue(image);
+
+

The format of the AcquirePixels() method is:

@@ -433,6 +497,12 @@ _8c.html" target="source" name="AffinityImage">AffinityImage
 
 

AffinityImage() replaces the colors of an image with the closest color from a reference image.

+

Deprecated, replace with:

+ +
+      RemapImage(quantize_info,image,affinity_image);
+
+

The format of the AffinityImage method is:

@@ -458,6 +528,12 @@ _8c.html" target="source" name="AffinityImages">AffinityImages
 
 

AffinityImages() replaces the colors of a sequence of images with the closest color from a reference image.

+

Deprecated, replace with:

+ +
+      RemapImages(quantize_info,images,affinity_image);
+
+

The format of the AffinityImage method is:

@@ -483,6 +559,12 @@ _8c.html" target="source" name="AllocateImage">AllocateImage
 
 

AllocateImage() returns a pointer to an image structure initialized to default values.

+

Deprecated, replace with:

+ +
+      AcquireImage(image_info);
+
+

The format of the AllocateImage method is:

@@ -501,11 +583,17 @@ _8c.html" target="source" name="AllocateImageColormap">AllocateImageColormap
 
 

AllocateImageColormap() allocates an image colormap and initializes it to a linear gray colorspace. If the image already has a colormap, it is replaced. AllocateImageColormap() returns MagickTrue if successful, otherwise MagickFalse if there is not enough memory.

+

Deprecated, replace with:

+ +
+      AcquireImageColormap(image,colors);
+
+

The format of the AllocateImageColormap method is:

   MagickBooleanType AllocateImageColormap(Image *image,
-    const unsigned long colors)
+    const size_t colors)
 

A description of each parameter follows:

@@ -523,6 +611,12 @@ _8c.html" target="source" name="AllocateNextImage">AllocateNextImage

AllocateNextImage() initializes the next image in a sequence to default values. The next member of image points to the newly allocated image. If there is a memory shortage, next is assigned NULL.

+

Deprecated, replace with:

+ +
+      AcquireNextImage(image_info,image);
+
+

The format of the AllocateNextImage method is:

@@ -562,6 +656,12 @@ _8c.html" target="source" name="AverageImages">AverageImages
 
 

AverageImages() takes a set of images and averages them together. Each image in the set must have the same width and height. AverageImages() returns a single image with each corresponding pixel component of each image averaged. On failure, a NULL image is returned and exception describes the reason for the failure.

+

Deprecated, replace with:

+ +
+      EvaluateImages(images,MeanEvaluateOperator,exception);
+
+

The format of the AverageImages method is:

@@ -604,6 +704,12 @@ _8c.html" target="source" name="ClipPathImage">ClipPathImage
 
 

ClipPathImage() sets the image clip mask based any clipping path information if it exists.

+

Deprecated, replace with:

+ +
+      ClipImagePath(image,pathname,inside);
+
+

The format of the ClipImage method is:

@@ -629,6 +735,12 @@ _8c.html" target="source" name="CloneImageAttributes">CloneImageAttributesCloneImageAttributes() clones one or more image attributes.

+

Deprecated, replace with:

+ +
+      CloneImageProperties(image,clone_image);
+
+

The format of the CloneImageAttributes method is:

@@ -676,6 +788,12 @@ _8c.html" target="source" name="CloseCacheView">CloseCacheView
 
 

CloseCacheView() closes the specified view returned by a previous call to OpenCacheView().

+

Deprecated, replace with:

+ +
+      DestroyCacheView(view_info);
+
+

The format of the CloseCacheView method is:

@@ -701,7 +819,7 @@ _8c.html" target="source" name="ColorFloodfill">ColorFloodfill
 
   MagickBooleanType ColorFloodfillImage(Image *image,
     const DrawInfo *draw_info,const PixelPacket target,
-    const long x_offset,const long y_offset,const PaintMethod method)
+    const ssize_t x_offset,const ssize_t y_offset,const PaintMethod method)
 

A description of each parameter follows:

@@ -728,6 +846,12 @@ _8c.html" target="source" name="DeleteImageAttribute">DeleteImageAttributeDeleteImageAttribute() deletes an attribute from the image.

+

Deprecated, replace with:

+ +
+      DeleteImageProperty(image,key);
+
+

The format of the DeleteImageAttribute method is:

@@ -752,7 +876,7 @@ _8c.html" target="source" name="DeleteImageList">DeleteImageList
 

The format of the DeleteImageList method is:

-  unsigned int DeleteImageList(Image *images,const long offset)
+  unsigned int DeleteImageList(Image *images,const ssize_t offset)
 

A description of each parameter follows:

@@ -770,10 +894,18 @@ _8c.html" target="source" name="DeleteMagickRegistry">DeleteMagickRegistryDeleteMagickRegistry() deletes an entry in the registry as defined by the id. It returns MagickTrue if the entry is deleted otherwise MagickFalse if no entry is found in the registry that matches the id.

+

Deprecated, replace with:

+ +
+      char key[MaxTextExtent];
+      FormatMagickString(key,MaxTextExtent,"ld\n",id);
+      DeleteImageRegistry(key);
+
+

The format of the DeleteMagickRegistry method is:

-  MagickBooleanType DeleteMagickRegistry(const long id)
+  MagickBooleanType DeleteMagickRegistry(const ssize_t id)
 

A description of each parameter follows:

@@ -788,6 +920,12 @@ _8c.html" target="source" name="DescribeImage">DescribeImage

DescribeImage() describes an image by printing its attributes to the file. Attributes include the image width, height, size, and others.

+

Deprecated, replace with:

+ +
+      IdentifyImage(image,file,verbose);
+
+

The format of the DescribeImage method is:

@@ -831,6 +969,12 @@ _8c.html" target="source" name="DestroyImages">DestroyImages
 
 

DestroyImages() destroys an image list.

+

Deprecated, replace with:

+ +
+      DestroyImageList(image);
+
+

The format of the DestroyImages method is:

@@ -849,6 +993,12 @@ _8c.html" target="source" name="DestroyMagick">DestroyMagick
 
 

DestroyMagick() destroys the ImageMagick environment.

+

Deprecated, replace with:

+ +
+      MagickCoreTerminus();
+
+

The format of the DestroyMagick function is:

@@ -860,7 +1010,7 @@ _8c.html" target="source" name="DestroyMagick">DestroyMagick
 _8c.html" target="source" name="DispatchImage">DispatchImage
 
-

DispatchImage() extracts pixel data from an image and returns it to you. The method returns MagickFalse on success otherwise MagickTrue if an error is encountered. The data is returned as char, short int, int, long, float, or double in the order specified by map.

+

DispatchImage() extracts pixel data from an image and returns it to you. The method returns MagickFalse on success otherwise MagickTrue 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:

@@ -868,12 +1018,19 @@ _8c.html" target="source" name="DispatchImage">DispatchImage DispatchImage(image,0,0,640,1,"RGB",CharPixel,pixels,exception);
+

Deprecated, replace with:

+ +
+      ExportImagePixels(image,x_offset,y_offset,columns,rows,map,type,pixels,
+  exception);
+
+

The format of the DispatchImage method is:

-  unsigned int DispatchImage(const Image *image,const long x_offset,
-    const long y_offset,const unsigned long columns,
-    const unsigned long rows,const char *map,const StorageType type,
+  unsigned int DispatchImage(const Image *image,const ssize_t x_offset,
+    const ssize_t y_offset,const size_t columns,
+    const size_t rows,const char *map,const StorageType type,
     void *pixels,ExceptionInfo *exception)
 
@@ -907,8 +1064,8 @@ _8c.html" target="source" name="ExtractSubimageFromImageImage">ExtractSubimageFr

The format of the ExtractSubimageFromImageImage method is:

-  Image *ExtractSubimageFromImage(const Image *image,const Image *reference,
-    ExceptionInfo *exception)
+  Image *ExtractSubimageFromImage(const Image *image,
+    const Image *reference,ExceptionInfo *exception)
 

A description of each parameter follows:

@@ -929,6 +1086,12 @@ _8c.html" target="source" name="FlattenImages">FlattenImages

FlattenImages() Obsolete Function: Use MergeImageLayers() instead.

+

Deprecated, replace with:

+ +
+      MergeImageLayers(image,FlattenLayer,exception);
+
+

The format of the FlattenImage method is:

@@ -1023,11 +1186,18 @@ _8c.html" target="source" name="GetCacheView">GetCacheView
 
 

GetCacheView() gets pixels from the in-memory or disk pixel cache as defined by the geometry parameters. A pointer to the pixels is returned if the pixels are transferred, otherwise a NULL is returned.

+

Deprecated, replace with:

+ +
+      GetCacheViewAuthenticPixels(cache_view,x,y,columns,rows,
+  GetCacheViewException(cache_view));
+
+

The format of the GetCacheView method is:

-  PixelPacket *GetCacheView(CacheView *cache_view,const long x,
-    const long y,const unsigned long columns,const unsigned long rows)
+  PixelPacket *GetCacheView(CacheView *cache_view,const ssize_t x,
+    const ssize_t y,const size_t columns,const size_t rows)
 

A description of each parameter follows:

@@ -1045,6 +1215,12 @@ _8c.html" target="source" name="GetCacheViewIndexes">GetCacheViewIndexesGetCacheViewIndexes() returns the indexes associated with the specified view.

+

Deprecated, replace with:

+ +
+      GetCacheViewAuthenticIndexQueue(cache_view);
+
+

The format of the GetCacheViewIndexes method is:

@@ -1063,11 +1239,18 @@ _8c.html" target="source" name="GetCacheViewPixels">GetCacheViewPixels
 
 

GetCacheViewPixels() gets pixels from the in-memory or disk pixel cache as defined by the geometry parameters. A pointer to the pixels is returned if the pixels are transferred, otherwise a NULL is returned.

+

Deprecated, replace with:

+ +
+      GetCacheViewAuthenticPixels(cache_view,x,y,columns,rows,
+  GetCacheViewException(cache_view));
+
+

The format of the GetCacheViewPixels method is:

-  PixelPacket *GetCacheViewPixels(CacheView *cache_view,const long x,
-    const long y,const unsigned long columns,const unsigned long rows)
+  PixelPacket *GetCacheViewPixels(CacheView *cache_view,const ssize_t x,
+    const ssize_t y,const size_t columns,const size_t rows)
 

A description of each parameter follows:

@@ -1107,6 +1290,12 @@ _8c.html" target="source" name="GetImageClippingPathAttribute">GetImageClippingP

GetImageClippingPathAttribute() searches the list of image attributes and returns a pointer to a clipping path if it exists otherwise NULL.

+

Deprecated, replace with:

+ +
+      GetImageAttribute(image,"8BIM:1999,2998");
+
+

The format of the GetImageClippingPathAttribute method is:

@@ -1128,10 +1317,16 @@ _8c.html" target="source" name="GetImageFromMagickRegistry">GetImageFromMagickRe
 
 

GetImageFromMagickRegistry() gets an image from the registry as defined by its name. If the image is not found, a NULL image is returned.

+

Deprecated, replace with:

+ +
+      GetImageRegistry(ImageRegistryType,name,exception);
+
+

The format of the GetImageFromMagickRegistry method is:

-  Image *GetImageFromMagickRegistry(const char *name,long *id,
+  Image *GetImageFromMagickRegistry(const char *name,ssize_t *id,
     ExceptionInfo *exception)
 
@@ -1156,7 +1351,7 @@ _8c.html" target="source" name="GetMagickRegistry">GetMagickRegistry

The format of the GetMagickRegistry method is:

-  const void *GetMagickRegistry(const long id,RegistryType *type,
+  const void *GetMagickRegistry(const ssize_t id,RegistryType *type,
     size_t *length,ExceptionInfo *exception)
 
@@ -1181,6 +1376,14 @@ _8c.html" target="source" name="GetImageGeometry">GetImageGeometry

GetImageGeometry() returns a region as defined by the geometry string with respect to the image and its gravity.

+

Deprecated, replace with:

+ +
+      if (size_to_fit != MagickFalse)
+  ParseRegionGeometry(image,geometry,region_info,&image->exception); else
+  ParsePageGeometry(image,geometry,region_info,&image->exception);
+
+

The format of the GetImageGeometry method is:

@@ -1209,10 +1412,17 @@ _8c.html" target="source" name="GetImageList">GetImageList
 
 

GetImageList() returns an image at the specified position in the list.

+

Deprecated, replace with:

+ +
+      CloneImage(GetImageFromList(images,(ssize_t) offset),0,0,MagickTrue,
+  exception);
+
+

The format of the GetImageList method is:

-  Image *GetImageList(const Image *images,const long offset,
+  Image *GetImageList(const Image *images,const ssize_t offset,
     ExceptionInfo *exception)
 
@@ -1234,10 +1444,16 @@ _8c.html" target="source" name="GetImageListIndex">GetImageListIndex

GetImageListIndex() returns the position in the list of the specified image.

+

Deprecated, replace with:

+ +
+      GetImageIndexInList(images);
+
+

The format of the GetImageListIndex method is:

-  long GetImageListIndex(const Image *images)
+  ssize_t GetImageListIndex(const Image *images)
 

A description of each parameter follows:

@@ -1252,10 +1468,16 @@ _8c.html" target="source" name="GetImageListSize">GetImageListSize

GetImageListSize() returns the number of images in the list.

+

Deprecated, replace with:

+ +
+      GetImageListLength(images);
+
+

The format of the GetImageListSize method is:

-  unsigned long GetImageListSize(const Image *images)
+  size_t GetImageListSize(const Image *images)
 

A description of each parameter follows:

@@ -1274,11 +1496,17 @@ _8c.html" target="source" name="GetImagePixels">GetImagePixels

Pixels accessed via the returned pointer represent a simple array of type PixelPacket. If the image type is CMYK or if the storage class is PseduoClass, call GetAuthenticIndexQueue() after invoking GetImagePixels() to obtain the black color component or colormap indexes (of type IndexPacket) corresponding to the region. Once the PixelPacket (and/or IndexPacket) array has been updated, the changes must be saved back to the underlying image using SyncAuthenticPixels() or they may be lost.

+

Deprecated, replace with:

+ +
+      GetAuthenticPixels(image,x,y,columns,rows,&image->exception);
+
+

The format of the GetImagePixels() method is:

-  PixelPacket *GetImagePixels(Image *image,const long x,const long y,
-    const unsigned long columns,const unsigned long rows)
+  PixelPacket *GetImagePixels(Image *image,const ssize_t x,const ssize_t y,
+    const size_t columns,const size_t rows)
 

A description of each parameter follows:

@@ -1296,6 +1524,12 @@ _8c.html" target="source" name="GetIndexes">GetIndexes

GetIndexes() returns the black channel or the colormap indexes associated with the last call to QueueAuthenticPixels() or GetVirtualPixels(). NULL is returned if the black channel or colormap indexes are not available.

+

Deprecated, replace with:

+ +
+      GetAuthenticIndexQueue(image);
+
+

The format of the GetIndexes() method is:

@@ -1317,6 +1551,12 @@ _8c.html" target="source" name="GetNextImage">GetNextImage
 
 

GetNextImage() returns the next image in a list.

+

Deprecated, replace with:

+ +
+      GetNextImageInList(images);
+
+

The format of the GetNextImage method is:

@@ -1335,6 +1575,15 @@ _8c.html" target="source" name="GetNextImageAttribute">GetNextImageAttribute
 
 

GetNextImageAttribute() gets the next image attribute.

+

Deprecated, replace with:

+ +
+      const char *property;
+      property=GetNextImageProperty(image);
+      if (property != (const char *) NULL) 
+  GetImageAttribute(image,property);
+
+

The format of the GetNextImageAttribute method is:

@@ -1353,6 +1602,12 @@ _8c.html" target="source" name="GetNumberScenes">GetNumberScenes
 
 

GetNumberScenes() returns the number of images in the list.

+

Deprecated, replace with:

+ +
+      GetImageListLength(image);
+
+

The format of the GetNumberScenes method is:

@@ -1371,10 +1626,16 @@ _8c.html" target="source" name="GetOnePixel">GetOnePixel
 
 

GetOnePixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs.

+

Deprecated, replace with:

+ +
+      GetOneAuthenticPixel(image,x,y,&pixel,&image->exception);
+
+

The format of the GetOnePixel() method is:

-  PixelPacket GetOnePixel(const Image image,const long x,const long y)
+  PixelPacket GetOnePixel(const Image image,const ssize_t x,const ssize_t y)
 

A description of each parameter follows:

@@ -1392,6 +1653,12 @@ _8c.html" target="source" name="GetPixels">GetPixels

GetPixels() returns the pixels associated with the last call to QueueAuthenticPixels() or GetAuthenticPixels().

+

Deprecated, replace with:

+ +
+      GetAuthenticPixelQueue(image);
+
+

The format of the GetPixels() method is:

@@ -1413,6 +1680,12 @@ _8c.html" target="source" name="GetPreviousImage">GetPreviousImage
 
 

GetPreviousImage() returns the previous image in a list.

+

Deprecated, replace with:

+ +
+      GetPreviousImageInList(images));
+
+

The format of the GetPreviousImage method is:

@@ -1471,6 +1744,12 @@ _8c.html" target="source" name="InitializeMagick">InitializeMagick
 
 

InitializeMagick() initializes the ImageMagick environment.

+

Deprecated, replace with:

+ +
+      MagickCoreGenesis(path,MagickFalse);
+
+

The format of the InitializeMagick function is:

@@ -1521,6 +1800,12 @@ _8c.html" target="source" name="InterpretImageAttributes">InterpretImageAttribut
 
 

InterpretImageAttributes() replaces any embedded formatting characters with the appropriate image attribute and returns the translated text.

+

Deprecated, replace with:

+ +
+      InterpretImageProperties(image_info,image,embed_text);
+
+

The format of the InterpretImageAttributes method is:

@@ -1548,6 +1833,12 @@ _8c.html" target="source" name="LevelImageColor">LevelImageColor
 
 

If the boolean 'invert' is set true the image values will modifyed in the reverse direction. That is any existing "black" and "white" colors in the image will become the color values given, with all other values compressed appropriatally. This effectivally maps a greyscale gradient into the given color gradient.

+

Deprecated, replace with:

+ +
+      LevelColorsImageChannel(image,channel,black_color,white_color,invert);
+
+

The format of the LevelImageColors method is:

@@ -1598,6 +1889,12 @@ _8c.html" target="source" name="LiberateSemaphoreInfo">LiberateSemaphoreInfo
 
 

LiberateSemaphoreInfo() relinquishes a semaphore.

+

Deprecated, replace with:

+ +
+      UnlockSemaphoreInfo(*semaphore_info);
+
+

The format of the LiberateSemaphoreInfo method is:

@@ -1616,6 +1913,12 @@ _8c.html" target="source" name="MagickIncarnate">MagickIncarnate
 
 

MagickIncarnate() initializes the ImageMagick environment.

+

Deprecated, replace with:

+ +
+      MagickCoreGenesis(path,MagickFalse);
+
+

The format of the MagickIncarnate function is:

@@ -1660,6 +1963,15 @@ _8c.html" target="source" name="MapImage">MapImage
 
 

MapImage() replaces the colors of an image with the closest color from a reference image.

+

Deprecated, replace with:

+ +
+       QuantizeInfo quantize_info;
+       GetQuantizeInfo(&quantize_info);
+       quantize_info.dither=dither;
+       RemapImage(&quantize_info,image,map_image);
+
+

The format of the MapImage method is:

@@ -1685,6 +1997,15 @@ _8c.html" target="source" name="MapImages">MapImages
 
 

MapImages() replaces the colors of a sequence of images with the closest color from a reference image.

+

Deprecated, replace with:

+ +
+       QuantizeInfo quantize_info;
+       GetQuantizeInfo(&quantize_info);
+       quantize_info.dither=dither;
+       RemapImages(&quantize_info,images,map_image);
+
+

The format of the MapImage method is:

@@ -1716,8 +2037,8 @@ _8c.html" target="source" name="MatteFloodfill">MatteFloodfill
 
 
   MagickBooleanType MatteFloodfillImage(Image *image,
-    const PixelPacket target,const Quantum opacity,const long x_offset,
-    const long y_offset,const PaintMethod method)
+    const PixelPacket target,const Quantum opacity,const ssize_t x_offset,
+    const ssize_t y_offset,const PaintMethod method)
 

A description of each parameter follows:

@@ -1744,6 +2065,12 @@ _8c.html" target="source" name="MaximumImages">MaximumImages

MaximumImages() returns the maximum intensity of an image sequence.

+

Deprecated, replace with:

+ +
+      EvaluateImages(images,MinEvaluateOperator,exception);
+
+

The format of the MaxImages method is:

@@ -1765,6 +2092,12 @@ _8c.html" target="source" name="MinimumImages">MinimumImages
 
 

MinimumImages() returns the minimum intensity of an image sequence.

+

Deprecated, replace with:

+ +
+      EvaluateImages(images,MinEvaluateOperator,exception);
+
+

The format of the MinimumImages method is:

@@ -1786,6 +2119,12 @@ _8c.html" target="source" name="MosaicImages">MosaicImages
 
 

MosaicImages() Obsolete Function: Use MergeImageLayers() instead.

+

Deprecated, replace with:

+ +
+      MergeImageLayers(image,MosaicLayer,exception);
+
+

The format of the MosaicImage method is:

@@ -1834,6 +2173,12 @@ _8c.html" target="source" name="OpenCacheView">OpenCacheView
 
 

OpenCacheView() opens a view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself.

+

Deprecated, replace with:

+ +
+      AcquireCacheView(image);
+
+

The format of the OpenCacheView method is:

@@ -1854,12 +2199,19 @@ _8c.html" target="source" name="PaintFloodfill">PaintFloodfill
 
 

By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill.

+

Deprecated, replace with:

+ +
+      FloodfillPaintImage(image,channel,draw_info,target,x,y,
+  method == FloodfillMethod ? MagickFalse : MagickTrue);
+
+

The format of the PaintFloodfillImage method is:

   MagickBooleanType PaintFloodfillImage(Image *image,
-    const ChannelType channel,const MagickPixelPacket target,const long x,
-    const long y,const DrawInfo *draw_info,const PaintMethod method)
+    const ChannelType channel,const MagickPixelPacket target,const ssize_t x,
+    const ssize_t y,const DrawInfo *draw_info,const PaintMethod method)
 

A description of each parameter follows:

@@ -1891,6 +2243,13 @@ _8c.html" target="source" name="PaintOpaqueImage">PaintOpaqueImage

By default color must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. Fuzz defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color.

+

Deprecated, replace with:

+ +
+      OpaquePaintImageChannel(image,DefaultChannels,target,fill,MagickFalse);
+      OpaquePaintImageChannel(image,channel,target,fill,MagickFalse);
+
+

The format of the PaintOpaqueImage method is:

@@ -1924,6 +2283,12 @@ _8c.html" target="source" name="PaintTransparentImage">PaintTransparentImage
 
 

By default color must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. Fuzz defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color.

+

Deprecated, replace with:

+ +
+      TransparentPaintImage(image,target,opacity,MagickFalse);
+
+

The format of the PaintTransparentImage method is:

@@ -1949,6 +2314,13 @@ _8c.html" target="source" name="ParseSizeGeometry">ParseSizeGeometry
 
 

ParseSizeGeometry() returns a region as defined by the geometry string with respect to the image dimensions and aspect ratio.

+

Deprecated, replace with:

+ +
+      ParseMetaGeometry(geometry,®ion_info->x,®ion_info->y,
+  ®ion_info->width,®ion_info->height);
+
+

The format of the ParseSizeGeometry method is:

@@ -1971,6 +2343,12 @@ _8c.html" target="source" name="PopImageList">PopImageList
 
 

PopImageList() removes the last image in the list.

+

Deprecated, replace with:

+ +
+      RemoveLastImageFromList(images);
+
+

The format of the PopImageList method is:

@@ -2014,6 +2392,12 @@ _8c.html" target="source" name="PostscriptGeometry">PostscriptGeometry
 
 

PostscriptGeometry() replaces any page mneumonic with the equivalent size in picas.

+

Deprecated, replace with:

+ +
+      GetPageGeometry(page);
+
+

The format of the PostscriptGeometry method is:

@@ -2032,6 +2416,12 @@ _8c.html" target="source" name="PushImageList">PushImageList
 
 

PushImageList() adds an image to the end of the list.

+

Deprecated, replace with:

+ +
+      AppendImageToList(images,CloneImageList(image,exception));
+
+

The format of the PushImageList method is:

@@ -2093,6 +2483,11 @@ _8c.html" target="source" name="QuantizationError">QuantizationError
 
normalized_maximum_square_error

    Thsi value is the normalized maximum quantization error for any single pixel in the image. This distance measure is normalized to a range between 0 and 1. It is independent of the range of red, green, and blue values in your image.

+

Deprecated, replace with:

+ +
+      GetImageQuantizeError(image);
+

The format of the QuantizationError method is:

@@ -2165,7 +2560,7 @@ _8c.html" target="source" name="RecolorImage">RecolorImage

The format of the RecolorImage method is:

-  Image *RecolorImage(const Image *image,const unsigned long order,
+  Image *RecolorImage(const Image *image,const size_t order,
     const double *color_matrix,ExceptionInfo *exception)
 
@@ -2190,6 +2585,12 @@ _8c.html" target="source" name="ResetImageAttributeIterator">ResetImageAttribute

ResetImageAttributeIterator() resets the image attributes iterator. Use it in conjunction with GetNextImageAttribute() to iterate over all the values associated with an image.

+

Deprecated, replace with:

+ +
+      ResetImagePropertyIterator(image);
+
+

The format of the ResetImageAttributeIterator method is:

@@ -2208,11 +2609,18 @@ _8c.html" target="source" name="SetCacheViewPixels">SetCacheViewPixels
 
 

SetCacheViewPixels() gets pixels from the in-memory or disk pixel cache as defined by the geometry parameters. A pointer to the pixels is returned if the pixels are transferred, otherwise a NULL is returned.

+

Deprecated, replace with:

+ +
+      QueueCacheViewAuthenticPixels(cache_view,x,y,columns,rows,
+  GetCacheViewException(cache_view));
+
+

The format of the SetCacheViewPixels method is:

-  PixelPacket *SetCacheViewPixels(CacheView *cache_view,const long x,
-    const long y,const unsigned long columns,const unsigned long rows)
+  PixelPacket *SetCacheViewPixels(CacheView *cache_view,const ssize_t x,
+    const ssize_t y,const size_t columns,const size_t rows)
 

A description of each parameter follows:

@@ -2273,6 +2681,12 @@ _8c.html" target="source" name="SetImageAttribute">SetImageAttribute

SetImageAttribute() searches the list of image attributes and replaces the attribute value. If it is not found in the list, the attribute name and value is added to the list.

+

Deprecated, replace with:

+ +
+      SetImageProperty(image,key,value);
+
+

The format of the SetImageAttribute method is:

@@ -2302,7 +2716,7 @@ _8c.html" target="source" name="SetImageList">SetImageList
 
 
   unsigned int SetImageList(Image *images,const Image *image,
-    const long offset,ExceptionInfo *exception)
+    const ssize_t offset,ExceptionInfo *exception)
 

A description of each parameter follows:

@@ -2332,11 +2746,17 @@ _8c.html" target="source" name="SetImagePixels">SetImagePixels

Pixels accessed via the returned pointer represent a simple array of type PixelPacket. If the image type is CMYK or the storage class is PseudoClass, call GetAuthenticIndexQueue() after invoking GetAuthenticPixels() to obtain the black color component or the colormap indexes (of type IndexPacket) corresponding to the region. Once the PixelPacket (and/or IndexPacket) array has been updated, the changes must be saved back to the underlying image using SyncAuthenticPixels() or they may be lost.

+

Deprecated, replace with:

+ +
+      QueueAuthenticPixels(image,x,y,columns,rows,&image->exception);
+
+

The format of the SetImagePixels() method is:

-  PixelPacket *SetImagePixels(Image *image,const long x,const long y,
-    const unsigned long columns,const unsigned long rows)
+  PixelPacket *SetImagePixels(Image *image,const ssize_t x,const ssize_t y,
+    const size_t columns,const size_t rows)
 

A description of each parameter follows:

@@ -2360,7 +2780,7 @@ _8c.html" target="source" name="SetMagickRegistry">SetMagickRegistry

The format of the SetMagickRegistry method is:

-  long SetMagickRegistry(const RegistryType type,const void *blob,
+  ssize_t SetMagickRegistry(const RegistryType type,const void *blob,
     const size_t length,ExceptionInfo *exception)
 
@@ -2403,6 +2823,12 @@ _8c.html" target="source" name="ShiftImageList">ShiftImageList

ShiftImageList() removes an image from the beginning of the list.

+

Deprecated, replace with:

+ +
+      RemoveFirstImageFromList(images);
+
+

The format of the ShiftImageList method is:

@@ -2424,8 +2850,8 @@ _8c.html" target="source" name="SpliceImageList">SpliceImageList
 

The format of the SpliceImageList method is:

-  Image *SpliceImageList(Image *images,const long offset,
-    const unsigned long length,const Image *splices,
+  Image *SpliceImageList(Image *images,const ssize_t offset,
+    const size_t length,const Image *splices,
     ExceptionInfo *exception)
 
@@ -2471,6 +2897,12 @@ _8c.html" target="source" name="SyncCacheView">SyncCacheView

SyncCacheView() saves the cache view pixels to the in-memory or disk cache. It returns MagickTrue if the pixel region is synced, otherwise MagickFalse.

+

Deprecated, replace with:

+ +
+      SyncCacheViewAuthenticPixels(cache_view,GetCacheViewException(cache_view));
+
+

The format of the SyncCacheView method is:

@@ -2489,6 +2921,12 @@ _8c.html" target="source" name="SyncCacheViewPixels">SyncCacheViewPixelsSyncCacheViewPixels() saves the cache view pixels to the in-memory or disk cache.  It returns MagickTrue if the pixel region is flushed, otherwise MagickFalse.

+

Deprecated, replace with:

+ +
+      SyncCacheViewAuthenticPixels(cache_view,GetCacheViewException(cache_view));
+
+

The format of the SyncCacheViewPixels method is:

@@ -2510,6 +2948,12 @@ _8c.html" target="source" name="SyncImagePixels">SyncImagePixels
 
 

SyncImagePixels() saves the image pixels to the in-memory or disk cache. The method returns MagickTrue if the pixel region is synced, otherwise MagickFalse.

+

Deprecated, replace with:

+ +
+      SyncAuthenticPixels(image,&image->exception);
+
+

The format of the SyncImagePixels() method is:

@@ -2610,6 +3054,12 @@ _8c.html" target="source" name="TranslateText">TranslateText
 
 

TranslateText() replaces any embedded formatting characters with the appropriate image attribute and returns the translated text.

+

Deprecated, replace with:

+ +
+      InterpretImageProperties(image_info,image,embed_text);
+
+

The format of the TranslateText method is:

@@ -2662,6 +3112,12 @@ _8c.html" target="source" name="UnshiftImageList">UnshiftImageList
 
 

UnshiftImageList() adds the image to the beginning of the list.

+

Deprecated, replace with:

+ +
+      PrependImageToList(images,CloneImageList(image,exception));
+
+

The format of the UnshiftImageList method is:

@@ -2688,7 +3144,7 @@ _8c.html" target="source" name="UnshiftImageList">UnshiftImageList
  
     
       Discourse Server •
-    Studio
+    Studio