#include <DLPBMImage.h>
Inheritance diagram for DLPBMImage:
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 DLPBMImage * | createImageReader () |
| |
Protected Member Functions | |
virtual | ~DLPBMImage () |
DLImage | dlLoadImage (DLIOStream &dlStream) |
void | dlSaveImage (DLIOStream &dlStream, const DLImage &dlimage) |
Implements loading and saving for the PBM image format, and is used by DLImageFactory. See DLImage for the typical interface for loading and saving images.
Definition at line 14 of file DLPBMImage.h.
virtual DLPBMImage::~DLPBMImage | ( | ) | [protected, virtual] |
Default DLPBMImage Destructor
DLImage DLPBMImage::dlLoadImage | ( | DLIOStream & | dlStream | ) | [protected] |
dlStream is a private IO object that handles the reads and writes. PBM uses this object to read/write the image output source
dlStream | Doclib IO stream for read/write |
void DLPBMImage::dlSaveImage | ( | DLIOStream & | dlStream, | |
const DLImage & | dlimage | |||
) | [protected] |
save a dlimage to the dlStream
dlStream | Doclib IO stream for read/write | |
dlimage | DLImage object to be saved |
static DLPBMImage* DLPBMImage::createImageReader | ( | ) | [static] |
void DLPBMImage::dlLoadImage | ( | const char * | filename, | |
DLImage & | dlimage | |||
) |
Load PBM Image
[in] | filename | name of file to be loaded |
[out] | dlimage | DLImage object passed by reference; will be overwritten to contain image from PBM file. |
DLImage DLPBMImage::dlLoadImage | ( | const char * | filename | ) | [virtual] |
Load PBM Image
filename | name of PBM image file to be opened |
Implements DLBaseImage.
DLImage DLPBMImage::dlLoadImage | ( | const void * | pMemLoc, | |
int | nSize | |||
) | [virtual] |
Load PBM Image from memory
pMemLoc | pointer to beginning of memory buffer | |
nSize | size of memory buffer in bytes |
Implements DLBaseImage.
DLImage DLPBMImage::dlLoadImageAtPage | ( | const char * | filename, | |
int | pageNumber | |||
) | [virtual] |
Loads a particular page of a multiple page image into a DLImage
filename | name of image file to be opened | |
pageNumber | number of page to be opened |
Implements DLBaseImage.
DLImage DLPBMImage::dlLoadImageAtPage | ( | const void * | pMemLoc, | |
int | nSize, | |||
int | pageNumber | |||
) | [virtual] |
Loads a particular page of a multiple page image from an image buffer in memory.
pMemLoc | pointer to beginning of memory image buffer to be opened | |
nSize | size of buffer in bytes | |
pageNumber | number of page to be opened |
Implements DLBaseImage.
void DLPBMImage::dlSaveImage | ( | const char * | filename, | |
const DLImage & | dlimage | |||
) | [virtual] |
Save PBM Image
filename | name of file to be saved | |
dlimage | PBM Image to be saved |
Implements DLBaseImage.
void* DLPBMImage::dlSaveImageToMem | ( | int & | nSize, | |
const DLImage & | dlimage | |||
) | [virtual] |
Save PBM Image to a memory buffer. See documentation on DLImage for example code.
[out] | nSize | size of the buffer to which the image was saved |
[in] | dlimage | PBM Image to be saved |
Implements DLBaseImage.
bool DLPBMImage::dlSupportImageFile | ( | const char * | filename | ) | [virtual] |
Determines if the image file is in the PBM format and is supported for loading by DLPBMImage.
filename | name of file to check |
Implements DLBaseImage.
bool DLPBMImage::dlSupportImageBuffer | ( | const void * | pMemLoc, | |
int | size | |||
) | [virtual] |
Determines if the memory buffer is in the PBM format and is supported for loading by DLPBMImage.
pMemLoc | pointer to beginning of buffer to check | |
size | size of buffer in bytes |
Implements DLBaseImage.
int DLPBMImage::dlGetTotalPages | ( | void * | pMemLoc, | |
int | nSize | |||
) | [virtual] |
Get the total number of pages in the image
pMemLoc | pointer to beginning of memory buffer | |
nSize | buffer size in bytes |
Implements DLBaseImage.
int DLPBMImage::dlGetTotalPages | ( | const char * | filename | ) | [virtual] |
Get the total number of pages in the image
filename | file name |
Implements DLBaseImage.