DLPNGImage Class Reference

PNG image I/O class. More...

#include <DLPNGImage.h>

Inheritance diagram for DLPNGImage:

DLBaseImage List of all members.

Public Member Functions

DLImage dlLoadImage (FILE *fp)
void dlLoadImage (const char *filename, DLImage &image)
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)
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 DLPNGImagecreateImageReader ()
static void dlSaveImage (const char *filename, const DLImage &dlimage, int PNG_COMPRESSION_TYPE)
 Save a PNG image with a particular compression scheme.

Protected Member Functions

virtual ~DLPNGImage ()

Detailed Description

PNG image I/O class.

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

Definition at line 19 of file DLPNGImage.h.


Constructor & Destructor Documentation

virtual DLPNGImage::~DLPNGImage (  )  [protected, virtual]

Default DLPNGImage Destructor


Member Function Documentation

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

Returns:
A handle to the DLPNGImage object.

DLImage DLPNGImage::dlLoadImage ( FILE *  fp  ) 

Load PNG Image

Parameters:
fp 
Returns:
DLImage to PNG Image

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

Load PNG Image

Parameters:
[in] filename name of file to load
[out] image DLImage object passed by reference; will be overwritten to contain image from PNG file

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

Load PNG Image from a memory buffer

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

Implements DLBaseImage.

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

Load PNG Image

Parameters:
filename name of file to be opened
Returns:
DLImage of file

Implements DLBaseImage.

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

dlLoadImageAtPage will load a particular page from a multiple page image.

Parameters:
filename name of file to be opened
pageNumber number of page to be opened
Returns:
DLImage of particular page

Implements DLBaseImage.

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

dlLoadImageAtPage will load a particular page from a multiple page image residing in a memory buffer.

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 of particular page in buffer

Implements DLBaseImage.

void DLPNGImage::dlSaveImage ( const char *  filename,
const DLImage image 
) [virtual]

Save PNG Image

Parameters:
filename name of file to be saved
image image to be saved

Implements DLBaseImage.

static void DLPNGImage::dlSaveImage ( const char *  filename,
const DLImage dlimage,
int  PNG_COMPRESSION_TYPE 
) [static]

Save a PNG image with a particular compression scheme.

Not yet implemented.

Parameters:
filename pathname for file to be saved
dlimage image object to be saved
PNG_COMPRESSION_TYPE png compression type

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

Save PNG Image to memory

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

Implements DLBaseImage.

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

Determines if an image file is in the PNG format and is supported for loading by DLPNGImage.

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

Implements DLBaseImage.

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

Determines if an image memory buffer is in the PNG format and is supported for loading by DLPNGImage.

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

Implements DLBaseImage.

int DLPNGImage::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 DLPNGImage::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