www/api/image.html
Select API Method
AcquireImage() returns a pointer to an image structure initialized to default values.
The format of the AcquireImage method is:
Image \*AcquireImage(const ImageInfo \*image\_info,ExceptionInfo \*exception)
A description of each parameter follows:
image_infoMany of the image default values are set from this structure. For example, filename, compression, depth, background color, and others. exceptionreturn any errors or warnings in this structure.
AcquireImageInfo() allocates the ImageInfo structure.
The format of the AcquireImageInfo method is:
ImageInfo \*AcquireImageInfo(void)
AcquireNextImage() initializes the next image in a sequence to default values. The next member of image points to the newly allocated image. If there is a memory shortage, next is assigned NULL.
The format of the AcquireNextImage method is:
void AcquireNextImage(const ImageInfo \*image\_info,Image \*image, ExceptionInfo \*exception)
A description of each parameter follows:
image_infoMany of the image default values are set from this structure. For example, filename, compression, depth, background color, and others. imagethe image. exceptionreturn any errors or warnings in this structure.
AppendImages() takes all images from the current image pointer to the end of the image list and appends them to each other top-to-bottom if the stack parameter is true, otherwise left-to-right.
The current gravity setting effects how the image is justified in the final image.
The format of the AppendImages method is:
Image \*AppendImages(const Image \*images,const MagickBooleanType stack, ExceptionInfo \*exception)
A description of each parameter follows:
imagesthe image sequence. stackA value other than 0 stacks the images top-to-bottom. exceptionreturn any errors or warnings in this structure.
CatchImageException() returns if no exceptions are found in the image sequence, otherwise it determines the most severe exception and reports it as a warning or error depending on the severity.
The format of the CatchImageException method is:
ExceptionType CatchImageException(Image \*image)
A description of each parameter follows:
imageAn image sequence.
ClipImagePath() sets the image clip mask based any clipping path information if it exists.
The format of the ClipImagePath method is:
MagickBooleanType ClipImagePath(Image \*image,const char \*pathname, const MagickBooleanType inside,ExceptionInfo \*exception)
A description of each parameter follows:
imagethe image. pathnamename of clipping path resource. If name is preceded by #, use clipping path numbered by name. insideif non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path. exceptionreturn any errors or warnings in this structure.
CloneImage() copies an image and returns the copy as a new image object.
If the specified columns and rows is 0, an exact copy of the image is returned, otherwise the pixel data is undefined and must be initialized with the QueueAuthenticPixels() and SyncAuthenticPixels() methods. On failure, a NULL image is returned and exception describes the reason for the failure.
The format of the CloneImage method is:
Image \*CloneImage(const Image \*image,const size\_t columns, const size\_t rows,const MagickBooleanType orphan, ExceptionInfo \*exception)
A description of each parameter follows:
imagethe image. columnsthe number of columns in the cloned image. rowsthe number of rows in the cloned image. detach With a value other than 0, the cloned image is detached from its parent I/O stream. exceptionreturn any errors or warnings in this structure.
CloneImageInfo() makes a copy of the given image info structure. If NULL is specified, a new image info structure is created initialized to default values.
The format of the CloneImageInfo method is:
ImageInfo \*CloneImageInfo(const ImageInfo \*image\_info)
A description of each parameter follows:
image_infothe image info.
CopyImagePixels() copies pixels from the source image as defined by the geometry the destination image at the specified offset.
The format of the CopyImagePixels method is:
MagickBooleanType CopyImagePixels(Image \*image,const Image \*source\_image, const RectangleInfo \*geometry,const OffsetInfo \*offset, ExceptionInfo \*exception)
A description of each parameter follows:
imagethe destination image. source_imagethe source image. geometrydefine the dimensions of the source pixel rectangle. offsetdefine the offset in the destination image. exceptionreturn any errors or warnings in this structure.
DestroyImage() dereferences an image, deallocating memory associated with the image if the reference count becomes zero.
The format of the DestroyImage method is:
Image \*DestroyImage(Image \*image)
A description of each parameter follows:
imagethe image.
DestroyImageInfo() deallocates memory associated with an ImageInfo structure.
The format of the DestroyImageInfo method is:
ImageInfo \*DestroyImageInfo(ImageInfo \*image\_info)
A description of each parameter follows:
image_infothe image info.
GetImageInfo() initializes image_info to default values.
The format of the GetImageInfo method is:
void GetImageInfo(ImageInfo \*image\_info)
A description of each parameter follows:
image_infothe image info.
GetImageInfoFile() returns the image info file member.
The format of the GetImageInfoFile method is:
FILE \*GetImageInfoFile(const ImageInfo \*image\_info)
A description of each parameter follows:
image_infothe image info.
GetImageMask() returns the mask associated with the image.
The format of the GetImageMask method is:
Image \*GetImageMask(const Image \*image,const PixelMask type, ExceptionInfo \*exception)
A description of each parameter follows:
imagethe image. typethe mask type, ReadPixelMask or WritePixelMask.
GetImageVirtualPixelMethod() gets the "virtual pixels" method for the image. A virtual pixel is any pixel access that is outside the boundaries of the image cache.
The format of the GetImageVirtualPixelMethod() method is:
VirtualPixelMethod GetImageVirtualPixelMethod(const Image \*image)
A description of each parameter follows:
imagethe image.
InterpretImageFilename() interprets embedded characters in an image filename. The filename length is returned.
The format of the InterpretImageFilename method is:
size\_t InterpretImageFilename(const ImageInfo \*image\_info,Image \*image, const char \*format,int value,char \*filename,ExceptionInfo \*exception)
A description of each parameter follows.
image_info
the image info..
image
the image.
format
A filename describing the format to use to write the numeric argument. Only the first numeric format identifier is replaced.
value
Numeric value to substitute into format filename.
filename
return the formatted filename in this character buffer.
exception
return any errors or warnings in this structure.
IsHighDynamicRangeImage() returns MagickTrue if any pixel component is non-integer or exceeds the bounds of the quantum depth (e.g. for Q16 0..65535.
The format of the IsHighDynamicRangeImage method is:
MagickBooleanType IsHighDynamicRangeImage(const Image \*image, ExceptionInfo \*exception)
A description of each parameter follows:
imagethe image. exceptionreturn any errors or warnings in this structure.
IsImageObject() returns MagickTrue if the image sequence contains a valid set of image objects.
The format of the IsImageObject method is:
MagickBooleanType IsImageObject(const Image \*image)
A description of each parameter follows:
imagethe image.
IsTaintImage() returns MagickTrue any pixel in the image has been altered since it was first constituted.
The format of the IsTaintImage method is:
MagickBooleanType IsTaintImage(const Image \*image)
A description of each parameter follows:
imagethe image.
ModifyImage() ensures that there is only a single reference to the image to be modified, updating the provided image pointer to point to a clone of the original image if necessary.
The format of the ModifyImage method is:
MagickBooleanType ModifyImage(Image \*image,ExceptionInfo \*exception)
A description of each parameter follows:
imagethe image. exceptionreturn any errors or warnings in this structure.
NewMagickImage() creates a blank image canvas of the specified size and background color.
The format of the NewMagickImage method is:
Image \*NewMagickImage(const ImageInfo \*image\_info,const size\_t width, const size\_t height,const PixelInfo \*background, ExceptionInfo \*exception)
A description of each parameter follows:
imagethe image. widththe image width. heightthe image height. backgroundthe image color. exceptionreturn any errors or warnings in this structure.
ReferenceImage() increments the reference count associated with an image returning a pointer to the image.
The format of the ReferenceImage method is:
Image \*ReferenceImage(Image \*image)
A description of each parameter follows:
imagethe image.
ResetImagePage() resets the image page canvas and position.
The format of the ResetImagePage method is:
MagickBooleanType ResetImagePage(Image \*image,const char \*page)
A description of each parameter follows:
imagethe image. pagethe relative page specification.
ResetImagePixels() reset the image pixels, that is, all the pixel components are zeroed.
The format of the SetImage method is:
MagickBooleanType ResetImagePixels(Image \*image, ExceptionInfo \*exception)
A description of each parameter follows:
imagethe image. exceptionreturn any errors or warnings in this structure.
SetImageAlpha() sets the alpha levels of the image.
The format of the SetImageAlpha method is:
MagickBooleanType SetImageAlpha(Image \*image,const Quantum alpha, ExceptionInfo \*exception)
A description of each parameter follows:
imagethe image. alphathe level of transparency: 0 is fully transparent and QuantumRange is fully opaque. exceptionreturn any errors or warnings in this structure.
SetImageBackgroundColor() initializes the image pixels to the image background color. The background color is defined by the background_color member of the image structure.
The format of the SetImage method is:
MagickBooleanType SetImageBackgroundColor(Image \*image, ExceptionInfo \*exception)
A description of each parameter follows:
imagethe image. exceptionreturn any errors or warnings in this structure.
SetImageChannelMask() sets the image channel mask from the specified channel mask.
The format of the SetImageChannelMask method is:
ChannelType SetImageChannelMask(Image \*image, const ChannelType channel\_mask)
A description of each parameter follows:
imagethe image. channel_maskthe channel mask.
SetImageColor() set the entire image canvas to the specified color.
The format of the SetImageColor method is:
MagickBooleanType SetImageColor(Image \*image,const PixelInfo \*color, ExceptionInfo \*exception)
A description of each parameter follows:
imagethe image. backgroundthe image color. exceptionreturn any errors or warnings in this structure.
SetImageStorageClass() sets the image class: DirectClass for true color images or PseudoClass for colormapped images.
The format of the SetImageStorageClass method is:
MagickBooleanType SetImageStorageClass(Image \*image, const ClassType storage\_class,ExceptionInfo \*exception)
A description of each parameter follows:
imagethe image. storage_class The image class. exceptionreturn any errors or warnings in this structure.
SetImageExtent() sets the image size (i.e. columns & rows).
The format of the SetImageExtent method is:
MagickBooleanType SetImageExtent(Image \*image,const size\_t columns, const size\_t rows,ExceptionInfo \*exception)
A description of each parameter follows:
imagethe image. columns The image width in pixels. rows The image height in pixels. exceptionreturn any errors or warnings in this structure.
SetImageInfoBlob() sets the image info blob member.
The format of the SetImageInfoBlob method is:
void SetImageInfoBlob(ImageInfo \*image\_info,const void \*blob, const size\_t length)
A description of each parameter follows:
image_infothe image info. blobthe blob. lengththe blob length.
SetImageInfoCustomStream() sets the image info custom stream handlers.
The format of the SetImageInfoCustomStream method is:
void SetImageInfoCustomStream(ImageInfo \*image\_info, CustomStreamInfo \*custom\_stream)
A description of each parameter follows:
image_infothe image info. custom_streamyour custom stream methods.
SetImageInfoFile() sets the image info file member.
The format of the SetImageInfoFile method is:
void SetImageInfoFile(ImageInfo \*image\_info,FILE \*file)
A description of each parameter follows:
image_infothe image info. filethe file.
SetImageMask() associates a mask with the image. The mask must be the same dimensions as the image.
The format of the SetImageMask method is:
MagickBooleanType SetImageMask(Image \*image,const PixelMask type, const Image \*mask,ExceptionInfo \*exception)
A description of each parameter follows:
imagethe image. typethe mask type, ReadPixelMask or WritePixelMask. maskthe image mask. exceptionreturn any errors or warnings in this structure.
SetImageRegionMask() associates a mask with the image as defined by the specified region.
The format of the SetImageRegionMask method is:
MagickBooleanType SetImageRegionMask(Image \*image,const PixelMask type, const RectangleInfo \*region,ExceptionInfo \*exception)
A description of each parameter follows:
imagethe image. typethe mask type, ReadPixelMask or WritePixelMask. geometrythe mask region. exceptionreturn any errors or warnings in this structure.
SetImageVirtualPixelMethod() sets the "virtual pixels" method for the image and returns the previous setting. A virtual pixel is any pixel access that is outside the boundaries of the image cache.
The format of the SetImageVirtualPixelMethod() method is:
VirtualPixelMethod SetImageVirtualPixelMethod(Image \*image, const VirtualPixelMethod virtual\_pixel\_method,ExceptionInfo \*exception)
A description of each parameter follows:
imagethe image. virtual_pixel_methodchoose the type of virtual pixel. exceptionreturn any errors or warnings in this structure.
SmushImages() takes all images from the current image pointer to the end of the image list and smushes them to each other top-to-bottom if the stack parameter is true, otherwise left-to-right.
The current gravity setting now effects how the image is justified in the final image.
The format of the SmushImages method is:
Image \*SmushImages(const Image \*images,const MagickBooleanType stack, ExceptionInfo \*exception)
A description of each parameter follows:
imagesthe image sequence. stackA value other than 0 stacks the images top-to-bottom. offsetminimum distance in pixels between images. exceptionreturn any errors or warnings in this structure.
StripImage() strips an image of all profiles and comments.
The format of the StripImage method is:
MagickBooleanType StripImage(Image \*image,ExceptionInfo \*exception)
A description of each parameter follows:
imagethe image. exceptionreturn any errors or warnings in this structure.
SyncImageSettings() syncs any image_info global options into per-image attributes.
Note: in IMv6 free form 'options' were always mapped into 'artifacts', so that operations and coders can find such settings. In IMv7 if a desired per-image artifact is not set, then it will directly look for a global option as a fallback, as such this copy is no longer needed, only the link set up.
The format of the SyncImageSettings method is:
MagickBooleanType SyncImageSettings(const ImageInfo \*image\_info, Image \*image,ExceptionInfo \*exception) MagickBooleanType SyncImagesSettings(const ImageInfo \*image\_info, Image \*image,ExceptionInfo \*exception)
A description of each parameter follows:
image_infothe image info. imagethe image. exceptionreturn any errors or warnings in this structure.