www/api/magick-property.html
Select API Method
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:
imagethe image. artifactthe 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:
imagethe image. propertythe 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:
imagethe image. optionthe 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:
wandthe 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:
wandthe 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:
wandthe 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:
wandthe 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:
wandthe 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:
wandthe 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:
wandthe 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:
wandthe magick wand.
MagickGetFilter() gets the wand filter.
The format of the MagickGetFilter method is:
FilterType MagickGetFilter(MagickWand \*wand)
A description of each parameter follows:
wandthe magick wand.
MagickGetGravity() gets the wand gravity.
The format of the MagickGetGravity method is:
GravityType MagickGetGravity(MagickWand \*wand)
A description of each parameter follows:
wandthe 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:
wandthe magick wand. artifactthe 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:
wandthe magick wand. patternSpecifies a pointer to a text string containing a pattern. number_artifactsthe 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:
wandthe magick wand. nameName of profile to return: ICC, IPTC, or generic profile. lengththe 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,const char \*pattern, size\_t \*number\_profiles)
A description of each parameter follows:
wandthe magick wand. patternSpecifies a pointer to a text string containing a pattern. number_profilesthe 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:
wandthe magick wand. propertythe 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:
wandthe magick wand. patternSpecifies a pointer to a text string containing a pattern. number_propertiesthe 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:
wandthe magick wand.
MagickGetInterpolateMethod() gets the wand compression.
The format of the MagickGetInterpolateMethod method is:
PixelInterpolateMethod MagickGetInterpolateMethod(MagickWand \*wand)
A description of each parameter follows:
wandthe 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:
wandthe magick wand. keythe 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,const char \*pattern, size\_t \*number\_options)
A description of each parameter follows:
wandthe magick wand. patternSpecifies a pointer to a text string containing a pattern. number_optionsthe 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:
wandthe 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:
wandthe magick wand. widththe page width. heightpage height. xthe page x-offset. ythe 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:
wandthe 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:
depththe 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:
rangethe 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:
wandthe magick wand. xthe x-resolution. ythe 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:
wandthe 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:
wandthe 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:
wandthe magick wand. number_factorsthe 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:
wandthe magick wand. columnsthe width in pixels. heightthe 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:
wandthe magick wand. offsetthe image offset.
MagickGetType() returns the wand type.
The format of the MagickGetType method is:
ImageType MagickGetType(MagickWand \*wand)
A description of each parameter follows:
wandthe 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:
versionthe 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:
wandthe magick wand. nameName of profile to add or remove: ICC, IPTC, or generic profile. profilethe profile. lengththe 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:
wandthe magick wand. nameName of profile to return: ICC, IPTC, or generic profile. lengththe length of the profile.
MagickSetAntialias() sets the antialias property of the wand.
The format of the MagickSetAntialias method is:
MagickBooleanType MagickSetAntialias(MagickWand \*wand, const MagickBooleanType antialias)
A description of each parameter follows:
wandthe magick wand. antialiasthe 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:
wandthe magick wand. backgroundthe 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:
wandthe magick wand. colorspacethe 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:
wandthe magick wand. compressionthe 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:
wandthe magick wand. qualitythe 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:
wandthe magick wand. depththe 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:
wandthe magick wand. geometrythe 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:
wandthe magick wand. filenamethe 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:
wandthe magick wand. fontthe 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:
wandthe magick wand. formatthe image format.
MagickSetFilter() sets the filter type.
The format of the MagickSetFilter type is:
MagickBooleanType MagickSetFilter(MagickWand \*wand, const FilterType type)
A description of each parameter follows:
wandthe magick wand. typethe filter type.
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:
wandthe magick wand. typethe gravity type.
MagickSetImageArtifact() sets a key-value pair in the image artifact namespace. Artifacts differ from properties. Properties are public and are generally exported to an external image format if the format supports it. Artifacts are private and are utilized by the internal ImageMagick API to modify the behavior of certain algorithms.
The format of the MagickSetImageArtifact method is:
MagickBooleanType MagickSetImageArtifact(MagickWand \*wand, const char \*artifact,const char \*value)
A description of each parameter follows:
wandthe magick wand. artifactthe artifact. valuethe 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:
wandthe magick wand. nameName of profile to add or remove: ICC, IPTC, or generic profile. profilethe profile. lengththe 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:
wandthe magick wand. propertythe property. valuethe 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:
wandthe magick wand. interlace_schemethe 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:
wandthe magick wand. methodthe interpolate pixel method.
MagickSetOption() associates one or options with the wand (.e.g MagickSetOption(wand,"jpeg:preserve","yes")).
The format of the MagickSetOption method is:
MagickBooleanType MagickSetOption(MagickWand \*wand,const char \*key, const char \*value)
A description of each parameter follows:
wandthe 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:
wandthe magick wand. orientationthe 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:
wandthe magick wand. widththe page width. heightthe page height. xthe page x-offset. ythe 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:
wandthe magick wand. passphrasethe 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:
wandthe magick wand. pointsizethe 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:
wandthe magick wand. progress_monitorSpecifies a pointer to a method to monitor progress of an image operation. client_dataSpecifies 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:
typethe 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 double y\_resolution)
A description of each parameter follows:
wandthe magick wand. x_resolutionthe image x resolution. y_resolutionthe 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:
wandthe magick wand. number_factorsthe number of factors. sampling_factorsAn array of doubles representing the sampling factor for each color component (in RGB order).
MagickSetSeed() sets the pseudo-random number generator seed. Use it to generate a predictable sequence of random numbers.
The format of the MagickSetSeed method is:
void MagickSetSeed(const unsigned long seed)
A description of each parameter follows:
seedthe seed.
MagickSetSecurityPolicy() sets the ImageMagick security policy. It returns MagickFalse if the policy is already set or if the policy does not parse.
The format of the MagickSetAntialias method is:
MagickBooleanType MagickSetAntialias(MagickWand \*wand, const char \*policy)
A description of each parameter follows:
wandthe magick wand. policythe security policy in the XML format.
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:
wandthe magick wand. columnsthe width in pixels. rowsthe 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:
wandthe magick wand. columnsthe image width in pixels. rowsthe image rows in pixels. offsetthe 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:
wandthe magick wand. image_typethe image type: UndefinedType, BilevelType, GrayscaleType, GrayscaleAlphaType, PaletteType, PaletteAlphaType, TrueColorType, TrueColorAlphaType, ColorSeparationType, ColorSeparationAlphaType, or OptimizeType.