DLBMPImage Class Reference

BMP image I/O class. More...

#include <DLBMPImage.h>

Inheritance diagram for DLBMPImage:

DLBaseImage List of all members.

Public Member Functions

void dlLoadImage (const char *filename, DLImage &dlimage)
DLImage dlLoadImage (const char *filename)
DLImage dlLoadImage (const void *pMemLoc, int nSize)
DLImage dlLoadImageAtPage (const char *filename, int pageNumber)
DLImage dlLoadImageAtPage (const void *pMemLoc, int nSize, int pageNumber)
void dlSaveImage (const char *filename, const DLImage &dlimage)
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 DLBMPImagecreateImageReader ()
 
Returns:
A handle to the DLBMPImage object


Protected Member Functions

virtual ~DLBMPImage ()
DLImage dlLoadImage (DLIOStream &dlStream)
void dlSaveImage (DLIOStream &dlStream, const DLImage &dlimage)

Detailed Description

BMP image I/O class.

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

Definition at line 15 of file DLBMPImage.h.


Constructor & Destructor Documentation

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

Default DLBMPImage Destructor


Member Function Documentation

DLImage DLBMPImage::dlLoadImage ( DLIOStream dlStream  )  [protected]

dlStream is a private IO object that handles the reads and writes. BMP uses this object to read/write the image output source

Parameters:
dlStream Doclib IO stream for read/write
Returns:
dlimage

void DLBMPImage::dlSaveImage ( DLIOStream dlStream,
const DLImage dlimage 
) [protected]

save a dlimage to the dlStream

Parameters:
dlStream Doclib IO stream for read/write
dlimage DLImage object to be saved

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

Returns:
A handle to the DLBMPImage object

void DLBMPImage::dlLoadImage ( const char *  filename,
DLImage dlimage 
)

Load BMP Image

Parameters:
[in] filename name of file to be loaded
[out] dlimage DLImage object passed by reference; will be overwritten to contain image from BMP file.

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

Load BMP Image

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

Implements DLBaseImage.

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

Load BMP Image from memory

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

Implements DLBaseImage.

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

Loads a particular page of a multiple page image into a DLImage

Parameters:
filename File name of image to be opened
pageNumber page number to be opened
Returns:
page as a DLImage

Implements DLBaseImage.

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

Loads a particular page of a multiple page image 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 to be returned

Implements DLBaseImage.

void DLBMPImage::dlSaveImage ( const char *  filename,
const DLImage dlimage 
) [virtual]

Save BMP Image

Parameters:
filename name of file to be saved
dlimage BMP Image to be saved

Implements DLBaseImage.

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

Save BMP Image to a memory buffer

Parameters:
[out] nSize size of the buffer needed by the image
[in] dlimage BMP Image to be saved
Returns:
pointer to the beginning of the saved image buffer

Implements DLBaseImage.

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

Determines if the image file is in the BMP format and is supported for loading by DLBMPImage.

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

Implements DLBaseImage.

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

Determines if the memory buffer is in the BMP format and is supported for loading by DLBMPImage.

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

Implements DLBaseImage.

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