NAME

decode - Methods to Read Image Formats


SYNOPSIS

image=ReadAVSImage(image_info)

image=ReadBMPImage(image_info)

image=ReadCMYKImage(image_info)

image=ReadDCMImage(image_info)

image=ReadDPSImage(image_info)

image=ReadFAXImage(image_info)

image=ReadFITSImage(image_info)

image=ReadFPXImage(image_info)

image=ReadGIFImage(image_info)

image=ReadGRADATIONImage(image_info)

image=ReadGRAYImage(image_info)

image=ReadHDFImage(image_info)

image=ReadHISTOGRAMImage(image_info)

image=ReadICCImage(image_info)

image=ReadICONImage(image_info)

image=ReadIPTCImage(image_info)

image=ReadImage(image_info)

image=ReadImages(image_info)

image=ReadJBIGImage(image_info)

image=ReadJPEGImage(image_info)

image=ReadLABELImage(image_info)

image=ReadLOGOImage(image_info)

image=ReadMAPImage(image_info)

image=ReadMIFFImage(filename)

image=ReadMONOImage(image_info)

image=ReadMTVImage(image_info)

image=ReadNULLImage(image_info)

image=ReadPCDImage(image_info)

image=ReadPCLImage(image_info)

image=ReadPCXImage(image_info)

image=ReadPDFImage(image_info)

image=ReadPICTImage(image_info)

image=ReadPIXImage(image_info)

image=ReadPLASMAImage(image_info)

image=ReadPNGImage(image_info)

image=ReadPNMImage(image_info)

image=ReadPSDImage(image_info)

image=ReadPSImage(image_info)

image=ReadRGBImage(image_info)

image=ReadRLAImage(image_info)

image=ReadRLEImage(image_info)

image=ReadSGIImage(image_info)

image=ReadSTEGANOImage(image_info)

image=ReadSUNImage(image_info)

image=ReadTGAImage(image_info)

image=ReadTIFFImage(image_info)

image=ReadTILEImage(image_info)

image=ReadTIMImage(image_info)

image=ReadTTFImage(image_info)

image=ReadTXTImage(image_info)

image=ReadUILImage(image_info)

image=ReadUYVYImage(image_info)

image=ReadVICARImage(image_info)

image=ReadVIDImage(image_info)

image=ReadVIFFImage(image_info)

image=ReadXBMImage(image_info)

image=ReadXCImage(image_info)

image=ReadXImage(image_info)

image=ReadXPMImage(image_info)

image=ReadXWDImage(image_info)

image=ReadYUVImage(image_info)


FUNCTION DESCRIPTIONS


ReadAVSImage

Method ReadAVSImage reads an AVS X image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadAVSImage routine is:

        image=ReadAVSImage(image_info)

A description of each parameter follows:

image:

Method ReadAVSImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadBMPImage

Method ReadBMPImage reads a Microsoft Windows bitmap image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadBMPImage routine is:

        image=ReadBMPImage(image_info)

A description of each parameter follows:

image:

Method ReadBMPImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadCMYKImage

Method ReadCMYKImage reads an image of raw cyan, magenta, yellow, and black bytes and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadCMYKImage routine is:

        image=ReadCMYKImage(image_info)

A description of each parameter follows:

image:

Method ReadCMYKImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadDCMImage

Method ReadDCMImage reads a Digital Imaging and Communications in Medicine (DICOM) file and returns it. It It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadDCMImage routine is:

        image=ReadDCMImage(image_info)

A description of each parameter follows:

image:

Method ReadDCMImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadDPSImage

Method ReadDPSImage reads a Adobe Postscript image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadDPSImage routine is:

        image=ReadDPSImage(image_info)

A description of each parameter follows:

image:

Method ReadDPSImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadFAXImage

Method ReadFAXImage reads a Group 3 FAX image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadFAXImage routine is:

        image=ReadFAXImage(image_info)

A description of each parameter follows:

image:

Method ReadFAXImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadFITSImage

Method ReadFITSImage reads a FITS image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadFITSImage routine is:

        image=ReadFITSImage(image_info)

A description of each parameter follows:

image:

Method ReadFITSImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

filename:

Specifies the name of the image to read.


ReadFPXImage

Method ReadFPXImage reads a FlashPix image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image. This routine was contributed by BillR@corbis.com.

The format of the ReadFPXImage routine is:

        image=ReadFPXImage(image_info)

A description of each parameter follows:

image:

Method ReadFPXImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadGIFImage

Method ReadGIFImage reads a Compuserve Graphics image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadGIFImage routine is:

        image=ReadGIFImage(image_info)

A description of each parameter follows:

image:

Method ReadGIFImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or an error occurs.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadGRADATIONImage

Method ReadGRADATIONImage creates a gradation image and initializes it to the X server color range as specified by the filename. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadGRADATIONImage routine is:

        image=ReadGRADATIONImage(image_info)

A description of each parameter follows:

image:

Method ReadGRADATIONImage returns a pointer to the image after creating it. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadGRAYImage

Method ReadGRAYImage reads an image of raw grayscale bytes and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadGRAYImage routine is:

        image=ReadGRAYImage(image_info)

A description of each parameter follows:

image:

Method ReadGRAYImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadHDFImage

Method ReadHDFImage reads a Hierarchical Data Format image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadHDFImage routine is:

        image=ReadHDFImage(image_info)

A description of each parameter follows:

image:

Method ReadHDFImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadHISTOGRAMImage

Method ReadHISTOGRAMImage reads a HISTOGRAM image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadHISTOGRAMImage routine is:

        image=ReadHISTOGRAMImage(image_info)

A description of each parameter follows:

image:

Method ReadHISTOGRAMImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadICCImage

Method ReadICCImage reads an image file in the ICC format and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image. This method differs from the other decoder methods in that only the color profile information is useful in the returned image.

The format of the ReadICCImage routine is:

        image=ReadICCImage(image_info)

A description of each parameter follows:

image:

Method ReadICCImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadICONImage

Method ReadICONImage reads a Microsoft icon image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadICONImage routine is:

        image=ReadICONImage(image_info)

A description of each parameter follows:

image:

Method ReadICONImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadImages

Method ReadImages reads a list of image names from a file and then returns the images as a linked list.

The format of the ReadImage routine is:

        image=ReadImages(image_info)

A description of each parameter follows:

image:

Method ReadImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadIPTCImage

Method ReadIPTCImage reads an image file in the IPTC format and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image. This method differs from the other decoder methods in that only the iptc profile information is useful in the returned image.

The format of the ReadIPTCImage routine is:

        image=ReadIPTCImage(image_info)

A description of each parameter follows:

image:

Method ReadIPTCImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadJBIGImage

Method ReadJBIGImage reads a JBIG image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadJBIGImage routine is:

        image=ReadJBIGImage(image_info)

A description of each parameter follows:

image:

Method ReadJBIGImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadJPEGImage

Method ReadJPEGImage reads a JPEG image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadJPEGImage routine is:

        image=ReadJPEGImage(image_info)

A description of each parameter follows:

image:

Method ReadJPEGImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

filename:

Specifies the name of the jpeg image to read.


ReadLABELImage

Method ReadLABELImage reads a LABEL image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadLABELImage routine is:

        image=ReadLABELImage(image_info)

A description of each parameter follows:

image:

Method ReadLABELImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadLOGOImage

Method ReadLOGOImage reads a LOGO image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadLOGOImage routine is:

        image=ReadLOGOImage(image_info)

A description of each parameter follows:

image:

Method ReadLOGOImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadMAPImage

Method ReadMAPImage reads an image of raw RGB colormap and colormap index bytes and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadMAPImage routine is:

        image=ReadMAPImage(image_info)

A description of each parameter follows:

image:

Method ReadMAPImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadMIFFImage

Method ReadMIFFImage reads a MIFF image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadMIFFImage routine is:

        image=ReadMIFFImage(filename)

A description of each parameter follows:

image:

Method ReadMIFFImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadMONOImage

Method ReadMONOImage reads an image of raw bites in LSB order and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadMONOImage routine is:

        image=ReadMONOImage(image_info)

A description of each parameter follows:

image:

Method ReadMONOImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadMTVImage

Method ReadMTVImage reads a MTV image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadMTVImage routine is:

        image=ReadMTVImage(image_info)

A description of each parameter follows:

image:

Method ReadMTVImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadNULLImage

Method ReadNULLImage reads a NULL image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadNULLImage routine is:

        image=ReadNULLImage(image_info)

A description of each parameter follows:

image:

Method ReadNULLImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadPCDImage

Method ReadPCDImage reads a Photo CD image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image. Much of the PCD decoder was derived from the program hpcdtoppm(1) by Hadmut Danisch.

The format of the ReadPCDImage routine is:

        image=ReadPCDImage(image_info)

A description of each parameter follows:

image:

Method ReadPCDImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadPCLImage

Method ReadPCLImage reads a Page Control Language image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadPCLImage routine is:

        image=ReadPCLImage(image_info)

A description of each parameter follows:

image:

Method ReadPCLImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadPCXImage

Method ReadPCXImage reads a ZSoft IBM PC Paintbrush file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadPCXImage routine is:

        image=ReadPCXImage(image_info)

A description of each parameter follows:

image:

Method ReadPCXImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadPDFImage

Method ReadPDFImage reads a Portable Document Format image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadPDFImage routine is:

        image=ReadPDFImage(image_info)

A description of each parameter follows:

image:

Method ReadPDFImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadPICTImage

Method ReadPICTImage reads an Apple Macintosh QuickDraw/PICT image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadPICTImage routine is:

        image=ReadPICTImage(image_info)

A description of each parameter follows:

image:

Method ReadPICTImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadPIXImage

Method ReadPIXImage reads a Alias/Wavefront RLE image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadPIXImage routine is:

        image=ReadPIXImage(image_info)

A description of each parameter follows:

image:

Method ReadPIXImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadPLASMAImage

Method ReadPLASMAImage creates a plasma fractal image. The image is initialized to to the X server color as specified by the filename.

The format of the ReadPLASMAImage routine is:

        image=ReadPLASMAImage(image_info)

A description of each parameter follows:

image:

Method ReadPLASMAImage returns a pointer to the image after creating it. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadPNGImage

Method ReadPNGImage reads a Portable Network Graphics image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadPNGImage routine is:

        image=ReadPNGImage(image_info)

A description of each parameter follows:

image:

Method ReadPNGImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadPNMImage

Method ReadPNMImage reads a Portable Anymap image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadPNMImage routine is:

        image=ReadPNMImage(image_info)

A description of each parameter follows:

image:

Method ReadPNMImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadPSImage

Method ReadPSImage reads a Adobe Postscript image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadPSImage routine is:

        image=ReadPSImage(image_info)

A description of each parameter follows:

image:

Method ReadPSImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadPSDImage

Method ReadPSDImage reads an Adobe Photoshop image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadPSDImage routine is:

        image=ReadPSDImage(image_info)

A description of each parameter follows:

image:

Method ReadPSDImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadRGBImage

Method ReadRGBImage reads an image of raw red, green, and blue bytes and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadRGBImage routine is:

        image=ReadRGBImage(image_info)

A description of each parameter follows:

image:

Method ReadRGBImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadRLAImage

Method ReadRLAImage reads a run-length encoded Wavefront RLA image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

Note: This module was contributed by Lester Vecsey (master@internexus.net)

The format of the ReadRLAImage routine is:

        image=ReadRLAImage(image_info)

A description of each parameter follows:

image:

Method ReadRLAImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadRLEImage

Method ReadRLEImage reads a run-length encoded Utah Raster Toolkit image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadRLEImage routine is:

        image=ReadRLEImage(image_info)

A description of each parameter follows:

image:

Method ReadRLEImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadSGIImage

Method ReadSGIImage reads a SGI RGB image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadSGIImage routine is:

        image=ReadSGIImage(image_info)

A description of each parameter follows:

image:

Method ReadSGIImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadSTEGANOImage

Method ReadSTEGANOImage reads a steganographic image hidden within another image type. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadSTEGANOImage routine is:

        image=ReadSTEGANOImage(image_info)

A description of each parameter follows:

image:

Method ReadSTEGANOImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage of if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadSUNImage

Method ReadSUNImage reads a SUN image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadSUNImage routine is:

        image=ReadSUNImage(image_info)

A description of each parameter follows:

image:

Method ReadSUNImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadTGAImage

Method ReadTGAImage reads a Truevision TGA image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadTGAImage routine is:

        image=ReadTGAImage(image_info)

A description of each parameter follows:

image:

Method ReadTGAImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadTIFFImage

Method ReadTIFFImage reads a Tagged image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadTIFFImage routine is:

        image=ReadTIFFImage(image_info)

A description of each parameter follows:

image:

Method ReadTIFFImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadTILEImage

Method ReadTILEImage tiles a texture on an image. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadTILEImage routine is:

        image=ReadTILEImage(image_info)

A description of each parameter follows:

image:

Method ReadTILEImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadTIMImage

Method ReadTIMImage reads a PSX TIM image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

Contributed by os@scee.sony.co.uk.

The format of the ReadTIMImage routine is:

        image=ReadTIMImage(image_info)

A description of each parameter follows:

image:

Method ReadTIMImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadTTFImage

Method ReadTTFImage reads a TrueType font file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadTTFImage routine is:

        image=ReadTTFImage(image_info)

A description of each parameter follows:

image:

Method ReadTTFImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadTXTImage

Method ReadTXTImage reads a text file and returns it as an image. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadTXTImage routine is:

        image=ReadTXTImage(image_info)

A description of each parameter follows:

image:

Method ReadTXTImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadUILImage

Method ReadUILImage reads a X-Motif UIL table and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadUILImage routine is:

        image=ReadUILImage(image_info)

A description of each parameter follows:

image:

Method ReadUILImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadUYVYImage

Method ReadUYVYImage reads an image in the UYVY (16bit/pixel) format and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadUYVYImage routine is:

        image=ReadUYVYImage(image_info)

A description of each parameter follows:

image:

Method ReadUYVYImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadVICARImage

Method ReadVICARImage reads a VICAR image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadVICARImage routine is:

        image=ReadVICARImage(image_info)

A description of each parameter follows:

image:

Method ReadVICARImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

filename:

Specifies the name of the image to read.


ReadVIDImage

Method ReadVIDImage reads one of more images and creates a Visual Image Directory file. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadVIDImage routine is:

        image=ReadVIDImage(image_info)

A description of each parameter follows:

image:

Method ReadVIDImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadVIFFImage

Method ReadVIFFImage reads a Khoros Visualization image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadVIFFImage routine is:

        image=ReadVIFFImage(image_info)

A description of each parameter follows:

image:

Method ReadVIFFImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

filename:

Specifies the name of the image to read.


ReadXImage

Procedure ReadXImage reads an image from an X window.

The format of the ReadXImage routine is:

        image=ReadXImage(image_info)

A description of each parameter follows:

image_info:

Specifies a pointer to an ImageInfo structure.


ReadXBMImage

Method ReadXBMImage reads an X11 bitmap image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadXBMImage routine is:

        image=ReadXBMImage(image_info)

A description of each parameter follows:

image:

Method ReadXBMImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadXCImage

Method ReadXCImage creates a constant image and initializes it to the X server color as specified by the filename. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadXCImage routine is:

        image=ReadXCImage(image_info)

A description of each parameter follows:

image:

Method ReadXCImage returns a pointer to the image after creating it. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadXPMImage

Method ReadXPMImage reads an X11 pixmap image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadXPMImage routine is:

        image=ReadXPMImage(image_info)

A description of each parameter follows:

image:

Method ReadXPMImage returns a pointer to the image after creating it. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadXWDImage

Method ReadXWDImage reads an X Window System window dump image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadXWDImage routine is:

        image=ReadXWDImage(image_info)

A description of each parameter follows:

image:

Method ReadXWDImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadYUVImage

Method ReadYUVImage reads an image with digital YUV (CCIR 601 4:1:1) bytes and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ReadYUVImage routine is:

        image=ReadYUVImage(image_info)

A description of each parameter follows:

image:

Method ReadYUVImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.


ReadImage

Method ReadImage reads an image and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image. By default, the image format is determined by its magic number. To specify a particular image format, precede the filename with an explicit image format name and a colon (i.e. ps:image) or as the filename suffix (i.e. image.ps).

The format of the ReadImage routine is:

        image=ReadImage(image_info)

A description of each parameter follows:

image:

Method ReadImage returns a pointer to the image after reading. A null image is returned if there is a memory shortage or if the image cannot be read.

image_info:

Specifies a pointer to an ImageInfo structure.