ImageMagick: MagickWand, C API for ImageMagick: Magick Wand Attribute Methods
Author: ImageMagick Studio LLC
Description: ImageMagick (TM) is a free software suite to create, edit and compose bitmap images. It can read, convert and write images in a large variety of formats. Images can be cropped, colors can be changed, various effects can be applied, images can be rotated and combined, and text, lines, polygons, ellipses and Bézier curves can be added to images and stretched and rotated. ImageMagick is free software: it is delivered with full source code and can be freely used, copied, modified and distributed. Its license is compatible with the GPL. It runs on all major operating systems. Most of the functionality of ImageMagick can be used interactively from the command line; more often, however, the features are used from programs written in the programming languages Perl, C, C++, Python, PHP, Ruby or Java, for which ready-made ImageMagick interfaces (PerlMagick, Magick++, PythonMagick, MagickWand for PHP, RubyMagick, and JMagick) are available. This makes it possible to modify or create images automa [cell cut: 1159 characters, first 1000 kept]
Keywords: magickwc, api, for, imagemagick:, magick, wattribute, methods, ImageMagick, PerlMagick, Magick++, Image, Magick

## MagickGetCompression MagickGetCompression() gets the wand compression. The format of the MagickGetCompression method is:
      CompressionType MagickGetCompression(MagickWand *wand)
A description of each parameter follows: #### wand The magick wand. ## MagickGetCompression MagickGetCompression() gets the wand compression quality. The format of the MagickGetCompression method is:
      unsigned long MagickGetCompression(MagickWand *wand)
A description of each parameter follows: #### wand The magick wand. ## MagickGetCopyright MagickGetCopyright() returns the ImageMagick API copyright as a string constant. The format of the MagickGetCopyright method is:
      const char *MagickGetCopyright(void)
## MagickGetException MagickGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API. The format of the MagickGetException method is:
      char *MagickGetException(MagickWand *wand,ExceptionType *severity)
A description of each parameter follows: #### wand The magick wand. #### severity The severity of the error is returned here. ## MagickGetFilename MagickGetFilename() returns the filename associated with an image sequence. The format of the MagickGetFilename method is:
      const char *MagickGetFilename(const MagickWand *wand)
A description of each parameter follows: #### wand The magick wand. ## MagickGetFormat MagickGetFormat() returns the format of the magick wand. The format of the MagickGetFormat method is:
      const char MagickGetFormat(MagickWand *wand)
A description of each parameter follows: #### wand The magick wand. ## MagickGetHomeURL MagickGetHomeURL() returns the ImageMagick home URL. The format of the MagickGetHomeURL method is:
      char *MagickGetHomeURL(void)
## MagickGetInterlaceScheme MagickGetInterlaceScheme() gets the wand interlace scheme. The format of the MagickGetInterlaceScheme method is:
      InterlaceType MagickGetInterlaceScheme(MagickWand *wand)
A description of each parameter follows: #### wand The magick wand. ## MagickGetOption MagickGetOption() returns a value associated with a wand and the specified key. Use MagickRelinquishMemory() to free the value when you are finished with it. The format of the MagickGetOption method is:
      char *MagickGetOption(MagickWand *wand,const char *key)
A description of each parameter follows: #### wand The magick wand. #### key The key. ## MagickGetName MagickGetName() returns the ImageMagick package name as a string constant. The format of the MagickGetName method is:
      const char *MagickGetName(void)
## MagickGetPage MagickGetPage() returns the page geometry associated with the magick wand. The format of the MagickGetPage method is:
      MagickBooleanType MagickGetPage(MagickWand *wand,unsigned long *width,
        unsigned long *height,long *x,long *y)
A description of each parameter follows: #### wand The magick wand. #### width The page width. #### height page height. #### x The page x-offset. #### y The page y-offset. ## MagickGetQuantumDepth MagickGetQuantumDepth() returns the ImageMagick quantum depth as a string constant. The format of the MagickGetQuantumDepth method is:
      const char *MagickGetQuantumDepth(unsigned long *depth)
A description of each parameter follows: #### depth The quantum depth is returned as a number. ## MagickGetQuantumRange MagickGetQuantumRange() returns the ImageMagick quantum range as a string constant. The format of the MagickGetQuantumRange method is:
      const char *MagickGetQuantumRange(unsigned long *range)
A description of each parameter follows: #### range The quantum range is returned as a number. ## MagickGetReleaseDate MagickGetReleaseDate() returns the ImageMagick release date as a string constant. The format of the MagickGetReleaseDate method is:
      const char *MagickGetReleaseDate(void)
## MagickGetResourceLimit MagickGetResourceLimit() returns the specified resource in megabytes. The format of the MagickGetResource method is:
      unsigned long MagickGetResource(const ResourceType type)
A description of each parameter follows: #### wand The magick wand. ## MagickGetResourceLimit MagickGetResourceLimit() returns the specified resource limit in megabytes. The format of the MagickGetResourceLimit method is:
      unsigned long MagickGetResourceLimit(const ResourceType type)
A description of each parameter follows: #### wand The magick wand. ## MagickGetSamplingFactors MagickGetSamplingFactors() gets the horizontal and vertical sampling factor. The format of the MagickGetSamplingFactors method is:
      double *MagickGetSamplingFactor(MagickWand *wand,
        unsigned long *number_factors)
A description of each parameter follows: #### wand The magick wand. #### number_factors The number of factors in the returned array. ## MagickGetSize MagickGetSize() returns the size associated with the magick wand. The format of the MagickGetSize method is:
      MagickBooleanType MagickGetSize(const MagickWand *wand,
        unsigned long *columns,unsigned long *rows)
A description of each parameter follows: #### wand The magick wand. #### columns The width in pixels. #### height The height in pixels. ## MagickGetSizeOffset MagickGetSizeOffset() returns the size offset associated with the magick wand. The format of the MagickGetSizeOffset method is:
      MagickBooleanType MagickGetSizeOffset(const MagickWand *wand,
        long *offset)
A description of each parameter follows: #### wand The magick wand. #### offset The image offset. ## MagickGetVersion MagickGetVersion() returns the ImageMagick API version as a string constant and as a number. The format of the MagickGetVersion method is:
      const char *MagickGetVersion(unsigned long *version)
A description of each parameter follows: #### version The ImageMagick version is returned as a number. ## MagickSetBackgroundColor MagickSetBackgroundColor() sets the wand background color. The format of the MagickSetBackgroundColor method is:
      MagickBooleanType MagickSetBackgroundColor(MagickWand *wand,
        const PixelWand *background)
A description of each parameter follows: #### wand The magick wand. #### background The background pixel wand. ## MagickSetCompression MagickSetCompression() sets the wand compression type. The format of the MagickSetCompression method is:
      MagickBooleanType MagickSetCompression(MagickWand *wand,
        const CompressionType compression)
A description of each parameter follows: #### wand The magick wand. #### compression The wand compression. ## MagickSetCompressionQuality MagickSetCompressionQuality() sets the wand compression quality. The format of the MagickSetCompressionQuality method is:
      MagickBooleanType MagickSetCompressionQuality(MagickWand *wand,
        const unsigned long quality)
A description of each parameter follows: #### wand The magick wand. #### quality The wand compression quality. ## MagickSetFilename MagickSetFilename() sets the filename before you read or write an image file. The format of the MagickSetFilename method is:
      MagickBooleanType MagickSetFilename(MagickWand *wand,
        const char *filename)
A description of each parameter follows: #### wand The magick wand. #### filename The image filename. ## MagickSetFormat MagickSetFormat() sets the format of the magick wand. The format of the MagickSetFormat method is:
      MagickBooleanType MagickSetFormat(MagickWand *wand,const char *format)
A description of each parameter follows: #### wand The magick wand. #### format The image format. ## MagickSetInterlaceScheme MagickSetInterlaceScheme() sets the image compression. The format of the MagickSetInterlaceScheme method is:
      MagickBooleanType MagickSetInterlaceScheme(MagickWand *wand,
        const InterlaceType interlace_scheme)
A description of each parameter follows: #### wand The magick wand. #### interlace_scheme The image interlace scheme: NoInterlace, LineInterlace, PlaneInterlace, PartitionInterlace. ## MagickSetOption MagickSetOption() associates one or options with the wand (.e.g MagickSetOption(wand,"jpeg:perserve","yes")). The format of the MagickSetOption method is:
      MagickBooleanType MagickSetOption(MagickWand *wand,const char *key,
        const char *value)
A description of each parameter follows: #### wand The magick wand. #### key The key. #### value The value. ## MagickSetPageSize MagickSetPageSize() sets the page geometry of the magick wand. The format of the MagickSetPage method is:
      MagickBooleanType MagickSetPage(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 page width. #### height The page height. #### x The page x-offset. #### y The page y-offset. ## MagickSetPassphrase MagickSetPassphrase() sets the passphrase. The format of the MagickSetPassphrase method is:
      MagickBooleanType MagickSetPassphrase(MagickWand *wand,
        const char *passphrase)
A description of each parameter follows: #### wand The magick wand. #### passphrase The passphrase. ## MagickSetProgressMonitor MagickSetProgressMonitor() sets the wand progress monitor to the specified method and returns the previous progress monitor if any. The progress monitor method looks like this:
          MagickBooleanType MagickProgressMonitor(const char *text,
      const MagickOffsetType offset,const MagickSizeType span,
      void *client_data)
If the progress monitor returns MagickFalse, the current operation is interrupted. The format of the MagickSetProgressMonitor method is:
      MagickProgressMonitor MagickSetProgressMonitor(MagickWand *wand
        const MagickProgressMonitor progress_monitor,void *client_data)
A description of each parameter follows: #### wand The magick wand. #### progress_monitor Specifies a pointer to a method to monitor progress of an image operation. #### client_data Specifies a pointer to any client data. ## MagickSetResourceLimit MagickSetResourceLimit() sets the limit for a particular resource in megabytes. The format of the MagickSetResourceLimit method is:
      MagickBooleanType MagickSetResourceLimit(const ResourceType type,
        const unsigned long *limit)
A description of each parameter follows: #### type The type of resource: AreaResource, MemoryResource, MapResource, DiskResource, FileResource. o The maximum limit for the resource. ## MagickSetResolution MagickSetResolution() sets the image resolution. The format of the MagickSetResolution method is:
      MagickBooleanType MagickSetResolution(MagickWand *wand,
        const double x_resolution,const doubtl y_resolution)
A description of each parameter follows: #### wand The magick wand. #### x_resolution The image x resolution. #### y_resolution The image y resolution. ## MagickSetSamplingFactors MagickSetSamplingFactors() sets the image sampling factors. The format of the MagickSetSamplingFactors method is:
      MagickBooleanType MagickSetSamplingFactors(MagickWand *wand,
        const unsigned long number_factors,const double *sampling_factors)
A description of each parameter follows: #### wand The magick wand. #### number_factoes The number of factors. #### sampling_factors An array of doubles representing the sampling factor for each color component (in RGB order). ## MagickSetSize MagickSetSize() sets the size of the magick wand. Set it before you read a raw image format such as RGB, GRAY, or CMYK. The format of the MagickSetSize method is:
      MagickBooleanType MagickSetSize(MagickWand *wand,
        const unsigned long columns,const unsigned long rows)
A description of each parameter follows: #### wand The magick wand. #### columns The width in pixels. #### rows The rows in pixels. ## MagickSetSizeOffset MagickSetSizeOffset() sets the size and offset of the magick wand. Set it before you read a raw image format such as RGB, GRAY, or CMYK. The format of the MagickSetSizeOffset method is:
      MagickBooleanType MagickSetSizeOffset(MagickWand *wand,
        const unsigned long columns,const unsigned long rows,
        const long offset)
A description of each parameter follows: #### wand The magick wand. #### columns The width in pixels. #### rows The rows in pixels. #### height The height in pixels. ## MagickSetType MagickSetType() sets the image type attribute. The format of the MagickSetType method is:
      MagickBooleanType MagickSetType(MagickWand *wand,
        const ImageType image_type)
A description of each parameter follows: #### wand The magick wand. #### image_type The image type: UndefinedType, BilevelType, GrayscaleType, GrayscaleMatteType, PaletteType, PaletteMatteType, TrueColorType, TrueColorMatteType, ColorSeparationType, ColorSeparationMatteType, or OptimizeType. |

Discourse Server • Mailing Lists • Image Gallery • ImageMagick Studio
© 1999-2006 ImageMagick Studio LLC