ImageMagick: MagickWand, C API for ImageMagick: Deprecated Methods

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() 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 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.

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.

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

bordercolor

The border color pixel wand.

x,y

The starting location of the operation.

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

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

MagickRegionOfInterestImage

MagickRegionOfInterestImage() extracts a region of the image and returns it as a 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.