image - ImageMagick Image Methods
Image * AllocateImage( const ImageInfo *image_info );
unsigned int AllocateImageColormap( Image *image, const unsigned int colors );
void AllocateNextImage( const ImageInfo *image_info, Image *image );
unsigned int AnimateImages( const ImageInfo *image_info, Image *image );
Image * AppendImages( Image *image, const unsigned int stack, ExceptionInfo *exception );
Image * AverageImages( const Image *image, ExceptionInfo *exception );
Image * CloneImage( Image *image, const unsigned int columns, const unsigned int rows, const unsigned int orphan, ExceptionInfo *exception );
ImageInfo * CloneImageInfo( const ImageInfo *image_info );
unsigned int CompositeImage( Image *image, const CompositeOperator compose, Image *composite_image, const int x_offset, const int y_offset );
CycleColormapImage( image, amount );
void DescribeImage( Image *image, FILE *file, const unsigned int verbose );
void DestroyImage( Image *image );
void DestroyImageInfo( ImageInfo *image_info );
void DestroyImages( Image *image );
unsigned int DisplayImages( const ImageInfo *image_info, Image *image );
RectangleInfo GetImageBoundingBox( Image *image );
void GetImageInfo( ImageInfo *image_info );
ImageType GetImageType( Image *image );
Image * GetNextImage( Image *image );
unsigned int GetNumberScenes( const Image *image );
void GetPageInfo( RectangleInfo *page );
void GetPixelPacket( PixelPacket *pixel );
unsigned int IsGeometry( const char *geometry );
unsigned int IsSubimage( const char *geometry, const unsigned int pedantic );
unsigned int IsTainted( const Image *image );
unsigned int LayerImage( Image *image, const LayerType layer );
Image ** ListToGroupImage( Image *image, unsigned int *number_images );
void MatteImage( Image *image, Quantum opacity );
unsigned int MogrifyImage( const ImageInfo *image_info, const int argc, char ** argv, Image ** image );
unsigned int MogrifyImages( const ImageInfo *next_info, const int argc, char ** argv, Image ** image );
Image * MosaicImages( const Image *image, ExceptionInfo *exception );
int ParseImageGeometry( const char *geometry, int *x, int *y, unsigned int *width, unsigned int *height );
unsigned int RGBTransformImage( Image *image, const ColorspaceType colorspace );
void SetImage( Image *image, opacity );
unsigned int SetImageInfo( ImageInfo *image_info, const unsigned int rectify );
void SyncImage( Image *image );
void TextureImage( Image *image, Image *texture );
unsigned int TransformRGBImage( Image *image, const ColorspaceType colorspace );
unsigned int TransmitImage( Image *image, ImageInfo *image_info, const TransmitType sendmode, void *param1, void *param2 );
Method AllocateImage allocates an Image structure and initializes each field to a default value.
The format of the AllocateImage method is:
Image *AllocateImage ( const ImageInfo *image_info );
A description of each parameter follows:
Method AllocateImageColormap allocates an Image colormap and initializes it. The minimum number of colormap cells allocated is 256.
The format of the AllocateNextImage method is:
unsigned int AllocateImageColormap ( Image *image, const unsigned int colors );
A description of each parameter follows:
Method AllocateNextImage allocates an Image structure and initializes each field to a default value.
The format of the AllocateNextImage method is:
void AllocateNextImage ( const ImageInfo *image_info, Image *image );
A description of each parameter follows:
Method AnimateImages displays one or more images to an X window.
The format of the AnimateImages method is:
unsigned int AnimateImages ( const ImageInfo *image_info, Image *image );
A description of each parameter follows:
Method AppendImages appends a sequence of images. All the input images must have the same width or height. Images of the same width are stacked top-to-bottom. Images of the same height are stacked left-to-right. If stack is false, rectangular images are stacked left-to-right otherwise top-to-bottom.
The format of the AppendImage method is:
Image *AppendImages ( Image *image, const unsigned int stack, ExceptionInfo *exception );
A description of each parameter follows:
Method AverageImages averages a sequence of images. All the input image must be the same size in pixels.
The format of the AverageImage method is:
Image *AverageImages ( const Image *image, ExceptionInfo *exception );
A description of each parameter follows:
Method CloneImage clones an image. 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 SetImagePixels()
and SyncImagePixels()
methods.
The format of the CloneImage method is:
Image *CloneImage ( Image *image, const unsigned int columns, const unsigned int rows, const unsigned int orphan, ExceptionInfo *exception );
A description of each parameter follows:
Method CloneImageInfo makes a duplicate of the given image info, or if image info is NULL, a new one.
The format of the CloneImageInfo method is:
ImageInfo *CloneImageInfo ( const ImageInfo *image_info );
A description of each parameter follows:
Method CompositeImage returns the second image composited onto the first at the specified offsets.
The format of the CompositeImage method is:
unsigned int CompositeImage ( Image *image, const CompositeOperator compose, Image *composite_image, const int x_offset, const int y_offset );
A description of each parameter follows:
Method CycleColormapImage cycles the image colormap by a specified amount.
The format of the CycleColormapImage method is:
CycleColormapImage ( image, amount );
A description of each parameter follows:
Method DescribeImage describes an image by printing its attributes to stdout.
The format of the DescribeImage method is:
void DescribeImage ( Image *image, FILE *file, const unsigned int verbose );
A description of each parameter follows:
Method DestroyImage deallocates memory associated with an image.
The format of the DestroyImage method is:
void DestroyImage ( Image *image );
A description of each parameter follows:
Method DestroyImageInfo deallocates memory associated with an ImageInfo structure.
The format of the DestroyImageInfo method is:
void DestroyImageInfo ( ImageInfo *image_info );
A description of each parameter follows:
Method DestroyImages deallocates memory associated with a linked list of images.
The format of the DestroyImages method is:
void DestroyImages ( Image *image );
A description of each parameter follows:
Method DisplayImages displays one or more images to an X window.
The format of the AllocateNextImage method is:
unsigned int DisplayImages ( const ImageInfo *image_info, Image *image );
A description of each parameter follows:
Method GetImageBoundingBox returns the bounding box of an image canvas.
The format of the GetImageBoundingBox method is:
RectangleInfo GetImageBoundingBox ( Image *image );
A description of each parameter follows:
Method GetImageInfo initializes the ImageInfo structure.
The format of the GetImageInfo method is:
void GetImageInfo ( ImageInfo *image_info );
A description of each parameter follows:
Method GetImageType returns the type of image (e.g. bilevel, palette, etc).
The format of the GetImageType method is:
ImageType GetImageType ( Image *image );
A description of each parameter follows:
Method GetNextImage returns the next image in an image sequence.
The format of the GetNextImage method is:
Image *GetNextImage ( Image *image );
A description of each parameter follows:
Method GetNumberScenes returns the number of scenes in an image sequence.
The format of the GetNumberScenes method is:
unsigned int GetNumberScenes ( const Image *image );
A description of each parameter follows:
Method GetPageInfo initializes the image page structure.
The format of the GetPageInfo method is:
void GetPageInfo ( RectangleInfo *page );
A description of each parameter follows:
Method GetPixelPacket initializes the PixelPacket structure.
The format of the GetPixelPacket method is:
void GetPixelPacket ( PixelPacket *pixel );
A description of each parameter follows:
Method IsGeometry returns True if the geometry specification is valid as determined by ParseGeometry.
The format of the IsGeometry method is:
unsigned int IsGeometry ( const char *geometry );
A description of each parameter follows:
Method IsSubimage returns True if the geometry is a valid subimage specification (e.g. [1], [1-9], [1,7,4]).
The format of the IsSubimage method is:
unsigned int IsSubimage ( const char *geometry, const unsigned int pedantic );
A description of each parameter follows:
Method IsTainted returns True if the image has been altered since it was first read or if any image in the sequence has a difference magic or filename.
The format of the IsTainted method is:
unsigned int IsTainted ( const Image *image );
A description of each parameter follows:
Method LayerImage extracts the specified layer from the references image.
The format of the LayerImage method is:
unsigned int LayerImage ( Image *image, const LayerType layer );
A description of each parameter follows:
Method ListToGroupImage converts a linked list of images to a sequential array.
The format of the ListToGroupImage method is:
Image **ListToGroupImage ( Image *image, unsigned int *number_images );
A description of each parameter follows:
Method MatteImage initializes the matte channel of the reference image to opaque.
The format of the MatteImage method is:
void MatteImage ( Image *image, Quantum opacity );
A description of each parameter follows:
Method MogrifyImage applies image processing options to an image as prescribed by command line options.
The format of the MogrifyImage method is:
unsigned int MogrifyImage ( const ImageInfo *image_info, const int argc, char **argv, Image **image );
A description of each parameter follows:
Method MogrifyImages applies next processing options to a sequence of images as prescribed by command line options.
The format of the MogrifyImage method is:
unsigned int MogrifyImages ( const ImageInfo *next_info, const int argc, char **argv, Image **image );
A description of each parameter follows:
Method MosaicImages inlays a number of image to form a single coherent picture.
The format of the MosaicImage method is:
Image *MosaicImages ( const Image *image, ExceptionInfo *exception );
A description of each parameter follows:
Method ParseImageGeometry parses a geometry specification and returns the width, height, x, and y values. It also returns flags that indicates which of the four values (width, height, xoffset, yoffset) were located in the string, and whether the x and y values are negative. In addition,
The format of the ParseImageGeometry method is:
int ParseImageGeometry ( const char *geometry, int *x, int *y, unsigned int *width, unsigned int *height );
A description of each parameter follows:
Method RGBTransformImage converts the reference image from RGB to an alternate colorspace. The transformation matrices are not the standard ones: the weights are rescaled to normalized the range of the transformed values to be [0..MaxRGB].
The format of the RGBTransformImage method is:
unsigned int RGBTransformImage ( Image *image, const ColorspaceType colorspace );
A description of each parameter follows:
Method SetImage initializes the reference image to the background color.
The format of the SetImage method is:
void SetImage ( Image *image, opacity );
A description of each parameter follows:
Method SetImageInfo initializes the `magick' field of the ImageInfo structure. It is set to a type of image format based on the prefix or suffix of the filename. For example, `ps:image' returns PS indicating a Postscript image. JPEG is returned for this filename: `image.jpg'. The filename prefix has precendence over the suffix. Use an optional index enclosed in brackets after a file name to specify a desired subimage of a multi-resolution image format like Photo CD (e.g. img0001.pcd[4]).
The format of the SetImageInfo method is:
unsigned int SetImageInfo ( ImageInfo *image_info, const unsigned int rectify );
A description of each parameter follows:
Method SortColormapByIntensity sorts the colormap of a PseudoClass image by decreasing color intensity.
The format of the SortColormapByIntensity method is:
unsigned int SortColormapByIntensity(Image *image)
A description of each parameter follows:
Method SyncImage initializes the red, green, and blue intensities of each pixel as defined by the colormap index.
The format of the SyncImage method is:
void SyncImage ( Image *image );
A description of each parameter follows:
Method TextureImage layers a texture onto the background of an image.
The format of the TextureImage method is:
void TextureImage ( Image *image, Image *texture );
A description of each parameter follows:
Method TransformRGBImage converts the reference image from an alternate colorspace. The transformation matrices are not the standard ones: the weights are rescaled to normalize the range of the transformed values to be [0..MaxRGB].
The format of the TransformRGBImage method is:
unsigned int TransformRGBImage ( Image *image, const ColorspaceType colorspace );
A description of each parameter follows:
Method TransmitImage transmit an image to a variety of destinations. It is used primarily in CGI and ISAPI programs to send an image to a client using either disk, blobs, streaming, or via the normal in memory image structure.
The format of the TransmitImage method is:
unsigned int TransmitImage ( Image *image, ImageInfo *image_info, const TransmitType sendmode, void *param1, void *param2 );
A description of each parameter follows: