AcquireImage • AcquireImageInfo • AcquireNextImage • AppendImages • CatchImageException • ClipImagePath • CloneImage • CloneImageInfo • CopyImagePixels • DestroyImage • DestroyImageInfo • GetImageClipMask • GetImageException • GetImageInfo • GetImageInfoFile • GetImageMask • GetImageChannels • GetImageVirtualPixelMethod • InterpretImageFilename • IsHighDynamicRangeImage • IsImageObject • IsTaintImage • ModifyImage • NewMagickImage • ReferenceImage • ResetImagePage • ResetImagePixels • SetImageBackgroundColor • SetImageChannels • SetImageColor • SetImageStorageClass • SetImageClipMask • SetImageExtent • SetImageInfoBlob • SetImageInfoFile • SetImageMask • SetImageOpacity • SetImageVirtualPixelMethod • SmushImages • StripImage • SyncImageSettings
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)
A description of each parameter follows:
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)
A description of each parameter follows:
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 now 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:
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:
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)
A description of each parameter follows:
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:
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:
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:
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:
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:
GetImageClipMask() returns the clip path associated with the image.
The format of the GetImageClipMask method is:
Image *GetImageClipMask(const Image *image,ExceptionInfo *exception)
A description of each parameter follows:
GetImageException() traverses an image sequence and returns any error more severe than noted by the exception parameter.
The format of the GetImageException method is:
void GetImageException(Image *image,ExceptionInfo *exception)
A description of each parameter follows:
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:
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:
GetImageMask() returns the mask associated with the image.
The format of the GetImageMask method is:
Image *GetImageMask(const Image *image,ExceptionInfo *exception)
A description of each parameter follows:
GetImageChannels() returns the number of pixel channels associated with the specified image.
The format of the GetChannels method is:
size_t GetImageChannels(Image *image)
A description of each parameter follows:
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:
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)
A description of each parameter follows.
the image info..
the image.
A filename describing the format to use to write the numeric argument. Only the first numeric format identifier is replaced.
Numeric value to substitute into format filename.
return the formatted filename in this character buffer.
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:
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:
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:
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:
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 MagickPixelPacket *background)
A description of each parameter follows:
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:
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:
ResetImagePixels() reset the image pixels, that is, all the pixel components are zereod.
The format of the SetImage method is:
MagickBooleanType ResetImagePixels(Image *image, ExceptionInfo *exception)
A description of each parameter follows:
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)
A description of each parameter follows:
SetImageChannels() sets the number of pixels channels associated with the image.
The format of the SetImageChannels method is:
MagickBooleanType SetImageChannels(Image *image,const size_t channels)
A description of each parameter follows:
SetImageColor() set the entire image canvas to the specified color.
The format of the SetImageColor method is:
MagickBooleanType SetImageColor(Image *image, const MagickPixelPacket *color)
A description of each parameter follows:
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)
A description of each parameter follows:
SetImageClipMask() associates a clip path with the image. The clip path must be the same dimensions as the image. Set any pixel component of the clip path to TransparentOpacity to prevent that corresponding image pixel component from being updated when SyncAuthenticPixels() is applied.
The format of the SetImageClipMask method is:
MagickBooleanType SetImageClipMask(Image *image,const Image *clip_mask)
A description of each parameter follows:
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)
A description of each parameter follows:
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:
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:
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 Image *mask)
A description of each parameter follows:
SetImageOpacity() sets the opacity levels of the image.
The format of the SetImageOpacity method is:
MagickBooleanType SetImageOpacity(Image *image,const Quantum opacity)
A description of each parameter follows:
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(const Image *image, const VirtualPixelMethod virtual_pixel_method)
A description of each parameter follows:
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:
StripImage() strips an image of all profiles and comments.
The format of the StripImage method is:
MagickBooleanType StripImage(Image *image)
A description of each parameter follows:
SyncImageSettings() syncs image_info options into per-image attributes.
The format of the SyncImageSettings method is:
MagickBooleanType SyncImageSettings(const ImageInfo *image_info, Image *image) MagickBooleanType SyncImagesSettings(const ImageInfo *image_info, Image *image)
A description of each parameter follows: