ImageMagick: MagickWand, C API for ImageMagick: Deprecated 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:, deprecated, methods, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject

## MagickClipPathImage MagickClipPathImage() clips along the named paths from the 8BIM profile, if present. Later operations take effect inside the path. Id may be a number if preceded with #, to work on a numbered path, e.g., "#1" to use the first path. The format of the MagickClipPathImage method is:
      MagickBooleanType MagickClipPathImage(MagickWand *wand,
        const char *pathname,const MagickBooleanType inside)
A description of each parameter follows: ##### wand the magick wand. ##### pathname name of clipping path resource. If name is preceded by #, use clipping path numbered by name. ##### inside if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path. ## DrawGetFillAlpha DrawGetFillAlpha() returns the alpha used when drawing using the fill color or fill texture. Fully opaque is 1.0. The format of the DrawGetFillAlpha method is:
      double DrawGetFillAlpha(const DrawingWand *wand)
A description of each parameter follows: ##### wand the drawing wand. ## DrawGetStrokeAlpha DrawGetStrokeAlpha() returns the alpha of stroked object outlines. The format of the DrawGetStrokeAlpha method is:
      double DrawGetStrokeAlpha(const DrawingWand *wand)
A description of each parameter follows: ##### wand the drawing wand. ## DrawPeekGraphicWand DrawPeekGraphicWand() returns the current drawing wand. The format of the PeekDrawingWand method is:
      DrawInfo *DrawPeekGraphicWand(const DrawingWand *wand)
A description of each parameter follows: ##### wand the drawing wand. ## DrawPopGraphicContext DrawPopGraphicContext() destroys the current drawing wand and returns to the previously pushed drawing wand. Multiple drawing wands may exist. It is an error to attempt to pop more drawing wands than have been pushed, and it is proper form to pop all drawing wands which have been pushed. The format of the DrawPopGraphicContext method is:
      MagickBooleanType DrawPopGraphicContext(DrawingWand *wand)
A description of each parameter follows: ##### wand the drawing wand. ## DrawPushGraphicContext DrawPushGraphicContext() clones the current drawing wand to create a new drawing wand. The original drawing wand(s) may be returned to by invoking PopDrawingWand(). The drawing wands are stored on a drawing wand stack. For every Pop there must have already been an equivalent Push. The format of the DrawPushGraphicContext method is:
      MagickBooleanType DrawPushGraphicContext(DrawingWand *wand)
A description of each parameter follows: ##### wand the drawing wand. ## DrawSetFillAlpha DrawSetFillAlpha() sets the alpha to use when drawing using the fill color or fill texture. Fully opaque is 1.0. The format of the DrawSetFillAlpha method is:
      void DrawSetFillAlpha(DrawingWand *wand,const double fill_alpha)
A description of each parameter follows: ##### wand the drawing wand. ##### fill_alpha fill alpha ## DrawSetStrokeAlpha DrawSetStrokeAlpha() specifies the alpha of stroked object outlines. The format of the DrawSetStrokeAlpha method is:
      void DrawSetStrokeAlpha(DrawingWand *wand,const double stroke_alpha)
A description of each parameter follows: ##### wand the drawing wand. ##### stroke_alpha stroke alpha. The value 1.0 is opaque. ## MagickColorFloodfillImage MagickColorFloodfillImage() changes the color value of any pixel that matches target and is an immediate neighbor. If the method FillToBorderMethod is specified, the color value is changed for any neighbor pixel that does not match the bordercolor member of image. The format of the MagickColorFloodfillImage method is:
      MagickBooleanType MagickColorFloodfillImage(MagickWand *wand,
        const PixelWand *fill,const double fuzz,const PixelWand *bordercolor,
        const long x,const long y)
A description of each parameter follows: ##### wand the magick wand. ##### fill the floodfill color pixel wand. ##### fuzz 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. ##### bordercolor the border color pixel wand. ##### x,y the starting location of the operation. ## MagickDescribeImage MagickDescribeImage() identifies an image by printing its attributes to the file. Attributes include the image width, height, size, and others. The format of the MagickDescribeImage method is:
      const char *MagickDescribeImage(MagickWand *wand)
A description of each parameter follows: ##### wand the magick wand. ## MagickFlattenImages MagickFlattenImages() merges a sequence of images. This useful for combining Photoshop layers into a single image. The format of the MagickFlattenImages method is:
      MagickWand *MagickFlattenImages(MagickWand *wand)
A description of each parameter follows: ##### wand the magick wand. ## MagickGetImageAttribute MagickGetImageAttribute() returns a value associated with the specified property. Use MagickRelinquishMemory() to free the value when you are finished with it. The format of the MagickGetImageAttribute method is:
      char *MagickGetImageAttribute(MagickWand *wand,const char *property)
A description of each parameter follows: ##### wand the magick wand. ##### property the property. ## MagickGetImageMatte MagickGetImageMatte() returns MagickTrue if the image has a matte channel otherwise MagickFalse. The format of the MagickGetImageMatte method is:
      unsigned long MagickGetImageMatte(MagickWand *wand)
A description of each parameter follows: ##### wand the magick wand. ## MagickMapImage MagickMapImage() replaces the colors of an image with the closest color from a reference image. The format of the MagickMapImage method is:
      MagickBooleanType MagickMapImage(MagickWand *wand,
        const MagickWand *map_wand,const MagickBooleanType dither)
A description of each parameter follows: ##### wand the magick wand. ##### map the map wand. ##### dither Set this integer value to something other than zero to dither the mapped image. ## MagickMatteFloodfillImage MagickMatteFloodfillImage() changes the transparency value of any pixel that matches target and is an immediate neighbor. If the method FillToBorderMethod is specified, the transparency value is changed for any neighbor pixel that does not match the bordercolor member of image. The format of the MagickMatteFloodfillImage method is:
      MagickBooleanType MagickMatteFloodfillImage(MagickWand *wand,
        const double alpha,const double fuzz,const PixelWand *bordercolor,
        const long x,const long y)
A description of each parameter follows: ##### wand the magick wand. ##### alpha the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent. ##### fuzz 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. ##### bordercolor the border color pixel wand. ##### x,y the starting location of the operation. ## MagickMosaicImages MagickMosaicImages() inlays an image sequence to form a single coherent picture. It returns a wand with each image in the sequence composited at the location defined by the page offset of the image. The format of the MagickMosaicImages method is:
      MagickWand *MagickMosaicImages(MagickWand *wand)
A description of each parameter follows: ##### wand the magick wand. ## MagickOpaqueImage MagickOpaqueImage() changes any pixel that matches color with the color defined by fill. The format of the MagickOpaqueImage method is:
      MagickBooleanType MagickOpaqueImage(MagickWand *wand,
        const PixelWand *target,const PixelWand *fill,const double fuzz)
A description of each parameter follows: ##### wand the magick wand. ##### channel the channel(s). ##### target Change this target color to the fill color within the image. ##### fill the fill pixel wand. ##### fuzz 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. ## MagickPaintFloodfillImage MagickPaintFloodfillImage() changes the color value of any pixel that matches target and is an immediate neighbor. If the method FillToBorderMethod is specified, the color value is changed for any neighbor pixel that does not match the bordercolor member of image. The format of the MagickPaintFloodfillImage method is:
      MagickBooleanType MagickPaintFloodfillImage(MagickWand *wand,
        const ChannelType channel,const PixelWand *fill,const double fuzz,
        const PixelWand *bordercolor,const long x,const long y)
A description of each parameter follows: ##### wand the magick wand. ##### channel the channel(s). ##### fill the floodfill color pixel wand. ##### fuzz 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. ##### bordercolor the border color pixel wand. ##### x,y the starting location of the operation. ## MagickPaintOpaqueImage MagickPaintOpaqueImage() changes any pixel that matches color with the color defined by fill. The format of the MagickPaintOpaqueImage method is:
      MagickBooleanType MagickPaintOpaqueImage(MagickWand *wand,
        const PixelWand *target,const PixelWand *fill,const double fuzz)
      MagickBooleanType MagickPaintOpaqueImageChannel(MagickWand *wand,
        const ChannelType channel,const PixelWand *target,
        const PixelWand *fill,const double fuzz)
A description of each parameter follows: ##### wand the magick wand. ##### channel the channel(s). ##### target Change this target color to the fill color within the image. ##### fill the fill pixel wand. ##### fuzz 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. ## MagickPaintTransparentImage MagickPaintTransparentImage() changes any pixel that matches color with the color defined by fill. The format of the MagickPaintTransparentImage method is:
      MagickBooleanType MagickPaintTransparentImage(MagickWand *wand,
        const PixelWand *target,const double alpha,const double fuzz)
A description of each parameter follows: ##### wand the magick wand. ##### target Change this target color to specified opacity value within the image. ##### alpha the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent. ##### fuzz 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. ## MagickSetImageAttribute MagickSetImageAttribute() associates a property with an image. The format of the MagickSetImageAttribute method is:
      MagickBooleanType MagickSetImageAttribute(MagickWand *wand,
        const char *property,const char *value)
A description of each parameter follows: ##### wand the magick wand. ##### property the property. ##### value the value. ## MagickSetImageIndex MagickSetImageIndex() set the current image to the position of the list specified with the index parameter. The format of the MagickSetImageIndex method is:
      MagickBooleanType MagickSetImageIndex(MagickWand *wand,const long index)
A description of each parameter follows: ##### wand the magick wand. ##### index the scene number. ## MagickTransparentImage MagickTransparentImage() changes any pixel that matches color with the color defined by fill. The format of the MagickTransparentImage method is:
      MagickBooleanType MagickTransparentImage(MagickWand *wand,
        const PixelWand *target,const double alpha,const double fuzz)
A description of each parameter follows: ##### wand the magick wand. ##### target Change this target color to specified opacity value within the image. ##### alpha the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent. ##### fuzz 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. ## MagickRegionOfInterestImage MagickRegionOfInterestImage() extracts a region of the image and returns it as a new wand. The format of the MagickRegionOfInterestImage method is:
      MagickWand *MagickRegionOfInterestImage(MagickWand *wand,
        const unsigned long width,const unsigned long height,const long x,
        const long y)
A description of each parameter follows: ##### wand the magick wand. ##### width the region width. ##### height the region height. ##### x the region x offset. ##### y the region y offset. ## MagickGetImageSize MagickGetImageSize() returns the image length in bytes. The format of the MagickGetImageSize method is:
      MagickBooleanType MagickGetImageSize(MagickWand *wand,
        MagickSizeType *length)
A description of each parameter follows: ##### wand the magick wand. ##### length the image length in bytes. ## MagickWriteImageBlob MagickWriteImageBlob() implements direct to memory image formats. It returns the image as a blob and its length. Use MagickSetFormat() to set the format of the returned blob (GIF, JPEG, PNG, etc.). Use MagickRelinquishMemory() to free the blob when you are done with it. The format of the MagickWriteImageBlob method is:
      unsigned char *MagickWriteImageBlob(MagickWand *wand,size_t *length)
A description of each parameter follows: ##### wand the magick wand. ##### length the length of the blob. ## MagickSetImageVirtualPixelMethod MagickSetImageVirtualPixelMethod() sets the image virtual pixel method. The format of the MagickSetImageVirtualPixelMethod method is:
      VirtualPixelMethod MagickSetImageVirtualPixelMethod(MagickWand *wand,
        const VirtualPixelMethod method)
A description of each parameter follows: ##### wand the magick wand. ##### method the image virtual pixel method : UndefinedVirtualPixelMethod, ConstantVirtualPixelMethod, EdgeVirtualPixelMethod, MirrorVirtualPixelMethod, or TileVirtualPixelMethod. ## PixelGetNextRow PixelGetNextRow() returns the next row as an array of pixel wands from the pixel iterator. The format of the PixelGetNextRow method is:
      PixelWand **PixelGetNextRow(PixelIterator *iterator,
        unsigned long *number_wands)
A description of each parameter follows: ##### iterator the pixel iterator. ##### number_wands the number of pixel wands. ## PixelIteratorGetException PixelIteratorGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API. The format of the PixelIteratorGetException method is:
      char *PixelIteratorGetException(const Pixeliterator *iterator,
        ExceptionType *severity)
A description of each parameter follows: ##### iterator the pixel iterator. ##### severity the severity of the error is returned here. |

Discourse Server • Mailing Lists • Cafe • Studio