DLGIFImage Class Reference

GIF image I/O class. More...

#include <DLGIFImage.h>

Inheritance diagram for DLGIFImage:

DLBaseImage List of all members.

Public Member Functions

void dlLoadImage (const char *filename, DLImage &image)
void dlConvertStructToDLImage (struct DLGifImageFormat *oimage, DLImage &dLImage)
DLImage dlLoadImage (const void *pMemLoc, int nSize)
DLImage dlLoadImage (const char *filename)
DLImage dlLoadImageAtPage (const char *filename, int pageNumber)
DLImage dlLoadImageAtPage (const void *pMemLoc, int nSize, int pageNumber)
void dlSaveImage (const char *filename, const DLImage &image_in)
void * dlSaveImageToMem (int &nSize, const DLImage &dlimage)
bool dlSupportImageFile (const char *filename)
bool dlSupportImageBuffer (const void *pMemLoc, int size)
int dlGetTotalPages (void *pMemLoc, int nSize)
int dlGetTotalPages (const char *filename)

Static Public Member Functions

static DLGIFImagecreateImageReader ()
 
Returns:
A handle to the DLGIFImage object


Protected Member Functions

virtual ~DLGIFImage (void)

Classes

class  DLGlobalGIFImage
class  DLLocalGIFImage

Detailed Description

GIF image I/O class.

Implements loading and saving for the GIF image format, and is used by DLImageFactory. See DLImage for the typical interface for loading and saving images.

Definition at line 122 of file DLGIFImage.h.


Constructor & Destructor Documentation

virtual DLGIFImage::~DLGIFImage ( void   )  [protected, virtual]

Default DLGIFImage Destructor


Member Function Documentation

static DLGIFImage* DLGIFImage::createImageReader (  )  [static]

Returns:
A handle to the DLGIFImage object

void DLGIFImage::dlLoadImage ( const char *  filename,
DLImage image 
)

Load GIF Image

Parameters:
[in] filename name of file to be loaded
[out] image DLImage object passed by reference; will be overwritten with contents of the GIF file

void DLGIFImage::dlConvertStructToDLImage ( struct DLGifImageFormat *  oimage,
DLImage dLImage 
)

Converts image_format structure to an DLImage

Parameters:
[in] oimage image_format
[out] dLImage reference to DLImage to copy data to

DLImage DLGIFImage::dlLoadImage ( const void *  pMemLoc,
int  nSize 
) [virtual]

Load GIF Image from memory

Parameters:
pMemLoc pointer to beginning of memory buffer
nSize size of buffer in bytes
Returns:
DLImage for the GIF Image

Implements DLBaseImage.

DLImage DLGIFImage::dlLoadImage ( const char *  filename  )  [virtual]

Load GIF Image

Parameters:
filename name of GIF image file to be opened
Returns:
DLImage containing GIF image

Implements DLBaseImage.

DLImage DLGIFImage::dlLoadImageAtPage ( const char *  filename,
int  pageNumber 
) [virtual]

dlLoadImageAtPage will load a particular page from a multiple page image into a DLImage

Parameters:
filename file name of image to be opened
pageNumber number of page in file to be opened
Returns:
DLImage containing desired page

Implements DLBaseImage.

DLImage DLGIFImage::dlLoadImageAtPage ( const void *  pMemLoc,
int  nSize,
int  pageNumber 
) [virtual]

dlLoadImageAtPage will load a particular page from multiple page image buffer into a DLImage

Parameters:
pMemLoc pointer to beginning of memory image buffer to be opened
nSize size of buffer in bytes
pageNumber number of page to be opened
Returns:
DLImage containing desired page

Implements DLBaseImage.

void DLGIFImage::dlSaveImage ( const char *  filename,
const DLImage image_in 
) [virtual]

Save GIF Image

Parameters:
filename name of file to be saved
image_in DLImage to save

Implements DLBaseImage.

void* DLGIFImage::dlSaveImageToMem ( int &  nSize,
const DLImage dlimage 
) [virtual]

Save GIF Image to memory

Parameters:
[out] nSize size of tiff file in memory
[in] dlimage DLImage* GIF Image
Returns:
pointer to the memory buffer in which the image was saved
Exceptions:
DL_NOT_SUPPORTED_EXCEPTION 

Implements DLBaseImage.

bool DLGIFImage::dlSupportImageFile ( const char *  filename  )  [virtual]

Determines if the image file is in the GIF format and is supported for loading by DLGIFImage.

Parameters:
filename name of file to check
Returns:
boolean: true if supported

Implements DLBaseImage.

bool DLGIFImage::dlSupportImageBuffer ( const void *  pMemLoc,
int  size 
) [virtual]

Determines if the image in a memory buffer is in the GIF format and is supported for loading by DLGIFImage. dlSupportImageFile determines if the image is supported.

Parameters:
pMemLoc pointer to beginning of memory buffer
size size of buffer in bytes
Returns:
boolean: true if supported

Implements DLBaseImage.

int DLGIFImage::dlGetTotalPages ( void *  pMemLoc,
int  nSize 
) [virtual]

Get the total number of pages in the image

Parameters:
pMemLoc pointer to beginning of memory buffer
nSize buffer size in bytes
Returns:
number of pages

Implements DLBaseImage.

int DLGIFImage::dlGetTotalPages ( const char *  filename  )  [virtual]

Get the total number of pages in the image

Parameters:
filename file name
Returns:
number of pages

Implements DLBaseImage.


The documentation for this class was generated from the following file:

DOCLIB is being developed under contract by a collaboration between:
The Laboratory for Language and Media Processing
Unviersity of Maryland, College Park
and
Booz | Allen | Hamilton

All Rights Reserved, 2003-2007