Module image Methods

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:

image_info

Many of the image default values are set from this structure. For example, filename, compression, depth, background color, and others.

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:

image_info

Many of the image default values are set from this structure. For example, filename, compression, depth, background color, and others.

image

the image.

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:

images

the image sequence.

stack

A value other than 0 stacks the images top-to-bottom.

exception

return 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:

image

An 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)

A description of each parameter follows:

image

the image.

pathname

name of clipping path resource. If name is preceded by #, use clipping path numbered by name.

inside

if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.

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:

image

the image.

columns

the number of columns in the cloned image.

rows

the 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.

exception

return 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_info

the image info.

CombineImages() combines one or more images into a single image. The grayscale value of the pixels of each image in the sequence is assigned in order to the specified channels of the combined image. The typical ordering would be image 1 => Red, 2 => Green, 3 => Blue, etc.

The format of the CombineImages method is:

  Image *CombineImages(const Image *image,const ChannelType channel,
    ExceptionInfo *exception)

A description of each parameter follows:

image

the image.

exception

return 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:

image

the 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_info

the image info.

GetImageAlphaChannel() returns MagickFalse if the image alpha channel is not activated. That is, the image is RGB rather than RGBA or CMYK rather than CMYKA.

The format of the GetImageAlphaChannel method is:

  MagickBooleanType GetImageAlphaChannel(const Image *image)

A description of each parameter follows:

image

the image.

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:

image

the image.

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:

image

Specifies a pointer to a list of one or more images.

exception

return the highest severity exception.

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_info

the 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_info

the image info.

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:

image

the image.

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:

image

the image.

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:

image

the 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)

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.

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:

image

the image.

exception

return 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:

image

the 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:

image

the 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:

image

the image.

exception

return 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 MagickPixelPacket *background)

A description of each parameter follows:

image

the image.

width

the image width.

height

the image height.

background

the image color.

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:

image

the 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:

image

the image.

page

the relative page specification.

SeparateImageChannel() separates a channel from the image and returns it as a grayscale image. A channel is a particular color component of each pixel in the image.

The format of the SeparateImageChannel method is:

  MagickBooleanType SeparateImageChannel(Image *image,
    const ChannelType channel)

A description of each parameter follows:

image

the image.

channel

Identify which channel to extract: RedChannel, GreenChannel, BlueChannel, OpacityChannel, CyanChannel, MagentaChannel, YellowChannel, or BlackChannel.

SeparateImages() returns a separate grayscale image for each channel specified.

The format of the SeparateImages method is:

  MagickBooleanType SeparateImages(const Image *image,
    const ChannelType channel,ExceptionInfo *exception)

A description of each parameter follows:

image

the image.

channel

Identify which channels to extract: RedChannel, GreenChannel, BlueChannel, OpacityChannel, CyanChannel, MagentaChannel, YellowChannel, or BlackChannel.

exception

return any errors or warnings in this structure.

SetImageAlphaChannel() activates, deactivates, resets, or sets the alpha channel.

The format of the SetImageAlphaChannel method is:

  MagickBooleanType SetImageAlphaChannel(Image *image,
    const AlphaChannelType alpha_type)

A description of each parameter follows:

image

the image.

alpha_type

The alpha channel type: ActivateAlphaChannel, CopyAlphaChannel, DeactivateAlphaChannel, ExtractAlphaChannel, OpaqueAlphaChannel, ResetAlphaChannel, SetAlphaChannel, ShapeAlphaChannel, and TransparentAlphaChannel.

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:

image

the image.

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:

image

the image.

channels

The number of pixel channels.

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:

image

the image.

background

the image color.

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:

image

the image.

storage_class

The image class.

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:

image

the image.

clip_mask

the image clip path.

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:

image

the image.

columns

The image width in pixels.

rows

The image height in pixels.

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_info

the image info.

blob

the blob.

length

the blob length.

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_info

the image info.

file

the 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 Image *mask)

A description of each parameter follows:

image

the image.

mask

the image mask.

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:

image

the image.

opacity

the level of transparency: 0 is fully opaque and QuantumRange is fully transparent.

SetImageType() sets the type of image. Choose from these types:

Bilevel Grayscale GrayscaleMatte Palette PaletteMatte TrueColor TrueColorMatte ColorSeparation ColorSeparationMatte OptimizeType

The format of the SetImageType method is:

  MagickBooleanType SetImageType(Image *image,const ImageType type)

A description of each parameter follows:

image

the image.

type

Image type.

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:

image

the image.

virtual_pixel_method

choose the type of virtual pixel.

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:

images

the image sequence.

stack

A value other than 0 stacks the images top-to-bottom.

offset

minimum distance in pixels between images.

exception

return 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)

A description of each parameter follows:

image

the image.

SyncImageSettings() sync the image info options to the image.

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:

image_info

the image info.

image

the image.