Module magick-property Methods

MagickDeleteImageArtifact() deletes a wand artifact.

The format of the MagickDeleteImageArtifact method is:

  MagickBooleanType MagickDeleteImageArtifact(MagickWand *wand,
    const char *artifact)

A description of each parameter follows:

image

the image.

artifact

the image artifact.

MagickDeleteImageProperty() deletes a wand property.

The format of the MagickDeleteImageProperty method is:

  MagickBooleanType MagickDeleteImageProperty(MagickWand *wand,
    const char *property)

A description of each parameter follows:

image

the image.

property

the image property.

MagickDeleteOption() deletes a wand option.

The format of the MagickDeleteOption method is:

  MagickBooleanType MagickDeleteOption(MagickWand *wand,
    const char *option)

A description of each parameter follows:

image

the image.

option

the image option.

MagickGetAntialias() returns the antialias property associated with the wand.

The format of the MagickGetAntialias method is:

  MagickBooleanType MagickGetAntialias(const MagickWand *wand)

A description of each parameter follows:

wand

the magick wand.

MagickGetBackgroundColor() returns the wand background color.

The format of the MagickGetBackgroundColor method is:

  PixelWand *MagickGetBackgroundColor(MagickWand *wand)

A description of each parameter follows:

wand

the magick wand.

MagickGetColorspace() gets the wand colorspace type.

The format of the MagickGetColorspace method is:

  ColorspaceType MagickGetColorspace(MagickWand *wand)

A description of each parameter follows:

wand

the magick wand.

MagickGetCompression() gets the wand compression type.

The format of the MagickGetCompression method is:

  CompressionType MagickGetCompression(MagickWand *wand)

A description of each parameter follows:

wand

the magick wand.

MagickGetCompressionQuality() gets the wand compression quality.

The format of the MagickGetCompressionQuality method is:

  size_t MagickGetCompressionQuality(MagickWand *wand)

A description of each parameter follows:

wand

the magick wand.

MagickGetCopyright() returns the ImageMagick API copyright as a string constant.

The format of the MagickGetCopyright method is:

  const char *MagickGetCopyright(void)

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.

MagickGetFont() returns the font associated with the MagickWand.

The format of the MagickGetFont method is:

  char *MagickGetFont(MagickWand *wand)

A description of each parameter follows:

wand

the magick wand.

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.

MagickGetGravity() gets the wand gravity.

The format of the MagickGetGravity method is:

  GravityType MagickGetGravity(MagickWand *wand)

A description of each parameter follows:

wand

the magick wand.

MagickGetHomeURL() returns the ImageMagick home URL.

The format of the MagickGetHomeURL method is:

  char *MagickGetHomeURL(void)

MagickGetImageArtifact() returns a value associated with the specified artifact. Use MagickRelinquishMemory() to free the value when you are finished with it.

The format of the MagickGetImageArtifact method is:

  char *MagickGetImageArtifact(MagickWand *wand,const char *artifact)

A description of each parameter follows:

wand

the magick wand.

artifact

the artifact.

MagickGetImageArtifacts() returns all the artifact names that match the specified pattern associated with a wand. Use MagickGetImageProperty() to return the value of a particular artifact. Use MagickRelinquishMemory() to free the value when you are finished with it.

The format of the MagickGetImageArtifacts method is:

  char *MagickGetImageArtifacts(MagickWand *wand,
    const char *pattern,size_t *number_artifacts)

A description of each parameter follows:

wand

the magick wand.

pattern

Specifies a pointer to a text string containing a pattern.

number_artifacts

the number artifacts associated with this wand.

MagickGetImageProfile() returns the named image profile.

The format of the MagickGetImageProfile method is:

  unsigned char *MagickGetImageProfile(MagickWand *wand,const char *name,
    size_t *length)

A description of each parameter follows:

wand

the magick wand.

name

Name of profile to return: ICC, IPTC, or generic profile.

length

the length of the profile.

MagickGetImageProfiles() returns all the profile names that match the specified pattern associated with a wand. Use MagickGetImageProfile() to return the value of a particular property. Use MagickRelinquishMemory() to free the value when you are finished with it.

The format of the MagickGetImageProfiles method is:

  char *MagickGetImageProfiles(MagickWand *wand,
    size_t *number_profiles)

A description of each parameter follows:

wand

the magick wand.

pattern

Specifies a pointer to a text string containing a pattern.

number_profiles

the number profiles associated with this wand.

MagickGetImageProperty() returns a value associated with the specified property. Use MagickRelinquishMemory() to free the value when you are finished with it.

The format of the MagickGetImageProperty method is:

  char *MagickGetImageProperty(MagickWand *wand,const char *property)

A description of each parameter follows:

wand

the magick wand.

property

the property.

MagickGetImageProperties() returns all the property names that match the specified pattern associated with a wand. Use MagickGetImageProperty() to return the value of a particular property. Use MagickRelinquishMemory() to free the value when you are finished with it.

The format of the MagickGetImageProperties method is:

  char *MagickGetImageProperties(MagickWand *wand,
    const char *pattern,size_t *number_properties)

A description of each parameter follows:

wand

the magick wand.

pattern

Specifies a pointer to a text string containing a pattern.

number_properties

the number properties associated with this wand.

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.

MagickGetInterpolateMethod() gets the wand compression.

The format of the MagickGetInterpolateMethod method is:

  InterpolatePixelMethod MagickGetInterpolateMethod(MagickWand *wand)

A description of each parameter follows:

wand

the magick wand.

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.

MagickGetOptions() returns all the option names that match the specified pattern associated with a wand. Use MagickGetOption() to return the value of a particular option. Use MagickRelinquishMemory() to free the value when you are finished with it.

The format of the MagickGetOptions method is:

  char *MagickGetOptions(MagickWand *wand,size_t *number_options)

A description of each parameter follows:

wand

the magick wand.

pattern

Specifies a pointer to a text string containing a pattern.

number_options

the number options associated with this wand.

MagickGetOrientation() gets the wand orientation type.

The format of the MagickGetOrientation method is:

  OrientationType MagickGetOrientation(MagickWand *wand)

A description of each parameter follows:

wand

the magick wand.

MagickGetPackageName() returns the ImageMagick package name as a string constant.

The format of the MagickGetPackageName method is:

  const char *MagickGetPackageName(void)

MagickGetPage() returns the page geometry associated with the magick wand.

The format of the MagickGetPage method is:

  MagickBooleanType MagickGetPage(const MagickWand *wand,
    size_t *width,size_t *height,ssize_t *x,ssize_t *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.

MagickGetPointsize() returns the font pointsize associated with the MagickWand.

The format of the MagickGetPointsize method is:

  double MagickGetPointsize(MagickWand *wand)

A description of each parameter follows:

wand

the magick wand.

MagickGetQuantumDepth() returns the ImageMagick quantum depth as a string constant.

The format of the MagickGetQuantumDepth method is:

  const char *MagickGetQuantumDepth(size_t *depth)

A description of each parameter follows:

depth

the quantum depth is returned as a number.

MagickGetQuantumRange() returns the ImageMagick quantum range as a string constant.

The format of the MagickGetQuantumRange method is:

  const char *MagickGetQuantumRange(size_t *range)

A description of each parameter follows:

range

the quantum range is returned as a number.

MagickGetReleaseDate() returns the ImageMagick release date as a string constant.

The format of the MagickGetReleaseDate method is:

  const char *MagickGetReleaseDate(void)

MagickGetResolution() gets the image X and Y resolution.

The format of the MagickGetResolution method is:

  MagickBooleanType MagickGetResolution(const MagickWand *wand,double *x,
    double *y)

A description of each parameter follows:

wand

the magick wand.

x

the x-resolution.

y

the y-resolution.

MagickGetResource() returns the specified resource in megabytes.

The format of the MagickGetResource method is:

  MagickSizeType MagickGetResource(const ResourceType type)

A description of each parameter follows:

wand

the magick wand.

MagickGetResourceLimit() returns the specified resource limit in megabytes.

The format of the MagickGetResourceLimit method is:

  MagickSizeType MagickGetResourceLimit(const ResourceType type)

A description of each parameter follows:

wand

the magick wand.

MagickGetSamplingFactors() gets the horizontal and vertical sampling factor.

The format of the MagickGetSamplingFactors method is:

  double *MagickGetSamplingFactor(MagickWand *wand,
    size_t *number_factors)

A description of each parameter follows:

wand

the magick wand.

number_factors

the number of factors in the returned array.

MagickGetSize() returns the size associated with the magick wand.

The format of the MagickGetSize method is:

  MagickBooleanType MagickGetSize(const MagickWand *wand,
    size_t *columns,size_t *rows)

A description of each parameter follows:

wand

the magick wand.

columns

the width in pixels.

height

the height in pixels.

MagickGetSizeOffset() returns the size offset associated with the magick wand.

The format of the MagickGetSizeOffset method is:

  MagickBooleanType MagickGetSizeOffset(const MagickWand *wand,
    ssize_t *offset)

A description of each parameter follows:

wand

the magick wand.

offset

the image offset.

MagickGetType() returns the wand type.

The format of the MagickGetType method is:

  ImageType MagickGetType(MagickWand *wand)

A description of each parameter follows:

wand

the magick wand.

MagickGetVersion() returns the ImageMagick API version as a string constant and as a number.

The format of the MagickGetVersion method is:

  const char *MagickGetVersion(size_t *version)

A description of each parameter follows:

version

the ImageMagick version is returned as a number.

MagickProfileImage() adds or removes a ICC, IPTC, or generic profile from an image. If the profile is NULL, it is removed from the image otherwise added. Use a name of '*' and a profile of NULL to remove all profiles from the image.

The format of the MagickProfileImage method is:

  MagickBooleanType MagickProfileImage(MagickWand *wand,const char *name,
    const void *profile,const size_t length)

A description of each parameter follows:

wand

the magick wand.

name

Name of profile to add or remove: ICC, IPTC, or generic profile.

profile

the profile.

length

the length of the profile.

MagickRemoveImageProfile() removes the named image profile and returns it.

The format of the MagickRemoveImageProfile method is:

  unsigned char *MagickRemoveImageProfile(MagickWand *wand,
    const char *name,size_t *length)

A description of each parameter follows:

wand

the magick wand.

name

Name of profile to return: ICC, IPTC, or generic profile.

length

the length of the profile.

MagickSetAntialias() sets the antialias propery of the wand.

The format of the MagickSetAntialias method is:

  MagickBooleanType MagickSetAntialias(MagickWand *wand,
    const MagickBooleanType antialias)

A description of each parameter follows:

wand

the magick wand.

antialias

the antialias property.

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.

MagickSetColorspace() sets the wand colorspace type.

The format of the MagickSetColorspace method is:

  MagickBooleanType MagickSetColorspace(MagickWand *wand,
    const ColorspaceType colorspace)

A description of each parameter follows:

wand

the magick wand.

colorspace

the wand colorspace.

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() sets the wand compression quality.

The format of the MagickSetCompressionQuality method is:

  MagickBooleanType MagickSetCompressionQuality(MagickWand *wand,
    const size_t quality)

A description of each parameter follows:

wand

the magick wand.

quality

the wand compression quality.

MagickSetDepth() sets the wand pixel depth.

The format of the MagickSetDepth method is:

  MagickBooleanType MagickSetDepth(MagickWand *wand,
    const size_t depth)

A description of each parameter follows:

wand

the magick wand.

depth

the wand pixel depth.

MagickSetExtract() sets the extract geometry before you read or write an image file. Use it for inline cropping (e.g. 200x200+0+0) or resizing (e.g.200x200).

The format of the MagickSetExtract method is:

  MagickBooleanType MagickSetExtract(MagickWand *wand,
    const char *geometry)

A description of each parameter follows:

wand

the magick wand.

geometry

the extract geometry.

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.

MagickSetFont() sets the font associated with the MagickWand.

The format of the MagickSetFont method is:

  MagickBooleanType MagickSetFont(MagickWand *wand, const char *font)

A description of each parameter follows:

wand

the magick wand.

font

the font

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.

MagickSetGravity() sets the gravity type.

The format of the MagickSetGravity type is:

  MagickBooleanType MagickSetGravity(MagickWand *wand,
    const GravityType type)

A description of each parameter follows:

wand

the magick wand.

type

the gravity type.

MagickSetImageArtifact() associates a artifact with an image.

The format of the MagickSetImageArtifact method is:

  MagickBooleanType MagickSetImageArtifact(MagickWand *wand,
    const char *artifact,const char *value)

A description of each parameter follows:

wand

the magick wand.

artifact

the artifact.

value

the value.

MagickSetImageProfile() adds a named profile to the magick wand. If a profile with the same name already exists, it is replaced. This method differs from the MagickProfileImage() method in that it does not apply any CMS color profiles.

The format of the MagickSetImageProfile method is:

  MagickBooleanType MagickSetImageProfile(MagickWand *wand,
    const char *name,const void *profile,const size_t length)

A description of each parameter follows:

wand

the magick wand.

name

Name of profile to add or remove: ICC, IPTC, or generic profile.

profile

the profile.

length

the length of the profile.

MagickSetImageProperty() associates a property with an image.

The format of the MagickSetImageProperty method is:

  MagickBooleanType MagickSetImageProperty(MagickWand *wand,
    const char *property,const char *value)

A description of each parameter follows:

wand

the magick wand.

property

the property.

value

the value.

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.

MagickSetInterpolateMethod() sets the interpolate pixel method.

The format of the MagickSetInterpolateMethod method is:

  MagickBooleanType MagickSetInterpolateMethod(MagickWand *wand,
    const InterpolateMethodPixel method)

A description of each parameter follows:

wand

the magick wand.

method

the interpolate pixel method.

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.

MagickSetOrientation() sets the wand orientation type.

The format of the MagickSetOrientation method is:

  MagickBooleanType MagickSetOrientation(MagickWand *wand,
    const OrientationType orientation)

A description of each parameter follows:

wand

the magick wand.

orientation

the wand orientation.

MagickSetPage() sets the page geometry of the magick wand.

The format of the MagickSetPage method is:

  MagickBooleanType MagickSetPage(MagickWand *wand,
    const size_t width,const size_t height,const ssize_t x,
    const ssize_t 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() 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.

MagickSetPointsize() sets the font pointsize associated with the MagickWand.

The format of the MagickSetPointsize method is:

  MagickBooleanType MagickSetPointsize(MagickWand *wand,
    const double pointsize)

A description of each parameter follows:

wand

the magick wand.

pointsize

the size of the font

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() sets the limit for a particular resource in megabytes.

The format of the MagickSetResourceLimit method is:

  MagickBooleanType MagickSetResourceLimit(const ResourceType type,
    const MagickSizeType 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() 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() sets the image sampling factors.

The format of the MagickSetSamplingFactors method is:

  MagickBooleanType MagickSetSamplingFactors(MagickWand *wand,
    const size_t 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() 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 size_t columns,const size_t rows)

A description of each parameter follows:

wand

the magick wand.

columns

the width in pixels.

rows

the rows in pixels.

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 size_t columns,const size_t rows,
    const ssize_t offset)

A description of each parameter follows:

wand

the magick wand.

columns

the image width in pixels.

rows

the image rows in pixels.

offset

the image offset.

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.