Synopsis

AppendImageToList( Image ** images, Image *image );

Description

AppendImageToList() appends an image to the end of the list. Please note that this API allows the list pointer ('images') to be updated and in fact it now updates the list pointer to be the image (or the end of the image list) which was just added. This means that GetFirstImageInList() must be used to retrieve the head of the list.

If image is NULL, then there is no effect

The format of the AppendImageToList method is:

AppendImageToList( Image ** images, Image *image );

A description of each parameter follows:

images:

The image list.

image:

The image.

Synopsis

Image *CloneImageList( const Image *images, ExceptionInfo *exception );

Description

CloneImageList() returns a duplicate of the image list. Although all image metadata and the colormap are duplicated (deep copy), the image pixel caches (which contain the pixel data) use reference counting so duplicating the list does not double the resource consumption.

If images is NULL, then NULL is returned.

The format of the CloneImageList method is:

Image *CloneImageList( const Image *images, ExceptionInfo *exception );

A description of each parameter follows:

images:

The image list.

exception:

Return any errors or warnings in this structure.

Synopsis

DeleteImageFromList( Image ** images );

Description

DeleteImageFromList() deletes the currently-referenced image from the list and destroys it.

If images is NULL, then there is no effect.

The format of the DeleteImageFromList method is:

DeleteImageFromList( Image ** images );

A description of each parameter follows:

images:

The image list.

Synopsis

void DestroyImageList( Image *image );

Description

DestroyImageList() destroys an image list.

If the image pointer is NULL, then there is no effect.

The format of the DestroyImageList method is:

void DestroyImageList( Image *image );

A description of each parameter follows:

image:

The image sequence.

Synopsis

Image *GetFirstImageInList( const Image *images );

Description

GetFirstImageInList() returns a pointer to the first image in the list. If the images list is NULL, then NULL is returned.

If images have been appended to the list using AppendImageToList(), then using GetFirstImageInList() is necessary to get the head of the list.

The format of the GetFirstImageInList method is:

Image *GetFirstImageInList( const Image *images );

A description of each parameter follows:

images:

The image list.

Synopsis

Image *GetImageFromList( const Image *images, const long offset );

Description

GetImageFromList() returns an image at the specified offset from the head of the list. Negative 'offset' values currently have no meaning.

If the images list is NULL, then NULL is returned.

The format of the GetImageFromList method is:

Image *GetImageFromList( const Image *images, const long offset );

A description of each parameter follows:

images:

The image list.

offset:

The position within the list.

Synopsis

long GetImageIndexInList( const Image *images );

Description

GetImageIndexInList() returns the offset in the list of the specified image.

If the images list is NULL, then the value negative one (-1) is returned.

The format of the GetImageIndexInList method is:

long GetImageIndexInList( const Image *images );

A description of each parameter follows:

images:

The image list.

Synopsis

unsigned long GetImageListLength( const Image *images );

Description

GetImageListLength() returns the length of the list (the number of images in the whole list). This function may be performed given any member of the list.

If the images list is NULL, then the value zero (0) is returned.

The format of the GetImageListLength method is:

unsigned long GetImageListLength( const Image *images );

A description of each parameter follows:

images:

The image list.

Synopsis

Image *GetLastImageInList( const Image *images );

Description

GetLastImageInList() returns a pointer to the last image in the list, given a pointer to any image in the list.

If the images list is NULL, then NULL is returned.

The format of the GetLastImageInList method is:

Image *GetLastImageInList( const Image *images );

A description of each parameter follows:

images:

The image list.

Synopsis

Image *GetNextImageInList( const Image *images );

Description

GetNextImageInList() returns the next image in the list given a pointer to an image in the list.

If the images list is NULL, then NULL is returned.

The format of the GetNextImageInList method is:

Image *GetNextImageInList( const Image *images );

A description of each parameter follows:

images:

The image list.

Synopsis

Image *GetPreviousImageInList( const Image *images );

Description

GetPreviousImageInList() returns the previous image in the list given a pointer to an image in the list.

If the images list is NULL, then NULL is returned.

The format of the GetPreviousImageInList method is:

Image *GetPreviousImageInList( const Image *images );

A description of each parameter follows:

images:

The image list.

Synopsis

InsertImageInList( Image ** images, Image *image );

Description

InsertImageInList() inserts an image in the list at the current position.

If the images list is NULL, then there is no effect.

The format of the InsertImageInList method is:

InsertImageInList( Image ** images, Image *image );

A description of each parameter follows:

images:

The image list.

image:

The image.

Synopsis

Image *NewImageList( void );

Description

NewImageList() creates an empty image list.

The format of the NewImageList method is:

Image *NewImageList( void );

Synopsis

PrependImageToList( Image *images, Image *image );

Description

PrependImageToList() prepends the image to the beginning of the list.

The format of the PrependImageToList method is:

PrependImageToList( Image *images, Image *image );

A description of each parameter follows:

images:

The image list.

image:

The image.

Synopsis

Image *RemoveFirstImageFromList( Image ** images );

Description

RemoveFirstImageFromList() removes an image from the beginning of the list. A pointer to the removed image is returned and should be destroyed when no longer needed. In conjunction with AppendImageToList(), this could be used to implement a producer/consumer model.

If the images list is NULL then NULL is returned.

The format of the RemoveFirstImageFromList method is:

Image *RemoveFirstImageFromList( Image ** images );

A description of each parameter follows:

images:

The image list.

Synopsis

Image *RemoveLastImageFromList( Image ** images );

Description

RemoveLastImageFromList() removes the last image from the list. A pointer to the removed image is returned and should be destroyed when no longer needed.

If the images list is NULL then NULL is returned.

The format of the RemoveLastImageFromList method is:

Image *RemoveLastImageFromList( Image ** images );

A description of each parameter follows:

images:

The image list.

Synopsis

ReplaceImageInList( Image ** images, Image *image );

Description

ReplaceImageInList() replaces an image in the list. The image which was replaced is destroyed.

If the images list is NULL then there is no effect.

The format of the ReplaceImageInList method is:

ReplaceImageInList( Image ** images, Image *image );

A description of each parameter follows:

images:

The image list.

image:

The image.

Synopsis

ReverseImageList( const Image ** images );

Description

ReverseImageList() reverses the image list.

If the images list is NULL then there is no effect.

The format of the ReverseImageList method is:

ReverseImageList( const Image ** images );

A description of each parameter follows:

images:

The image list.

Synopsis

SpliceImageIntoList( Image ** images, const unsigned long length, Image *splice );

Description

SpliceImageIntoList() removes 'length' images from the list and replaces them with the specified splice. The images which were removed are destroyed.

If the images list is NULL then there is no effect.

The format of the SpliceImageIntoList method is:

SpliceImageIntoList( Image ** images, const unsigned long length, Image *splice );

images:

The image list.

length:

The length of the image list to remove.

splice:

Replace the removed image list with this list.

Synopsis

Image *SplitImageList( Image *images );

Description

SplitImageList() splits an image list into two lists at the current position in the list. The new list is returned.

If the images list is NULL, or the images next image is NULL then NULL is returned.

The format of the SplitImageList method is:

Image *SplitImageList( Image *images );

A description of each parameter follows:

images:

The image list.