Base Image Module. More...
#include <deBaseImageModule.h>
Public Member Functions | |
Constructors and Destructors | |
| deBaseImageModule (deLoadableModule *loadableModule) | |
| Creates a new module. | |
| virtual | ~deBaseImageModule () |
| Cleans up the module. | |
Management | |
| virtual deBaseImageInfo * | InitLoadImage (decBaseFileReader *file)=0 |
| Do a quick check if the given file can be loaded by this image module. | |
| virtual void | LoadImage (decBaseFileReader *file, deImage *image, deBaseImageInfo *infos)=0 |
| Load the image into the provided storage. | |
| virtual void | SaveImage (decBaseFileWriter *file, deImage *image)=0 |
| Save the image in the provided storage into file. | |
Detailed Description
Base Image Module.
Image modules allow to laod and save images.
- Version:
- 1.0
- Date:
- 2008
Constructor & Destructor Documentation
| deBaseImageModule::deBaseImageModule | ( | deLoadableModule * | loadableModule ) |
Creates a new module.
| virtual deBaseImageModule::~deBaseImageModule | ( | ) | [virtual] |
Cleans up the module.
Member Function Documentation
| virtual deBaseImageInfo* deBaseImageModule::InitLoadImage | ( | decBaseFileReader * | file ) | [pure virtual] |
Do a quick check if the given file can be loaded by this image module.
This is usually a header check and is used to detect with what image module a file could be possibly loaded if it does not match any patterns. If the image can be loaded store the necessary informations into an ImageInfo object and return it. Otherwise return NULL. The returned ImageInfo object is used to create the image and as parameter to LoadImage. You can be sure that the file pointer is located at the beginning of the file.
| virtual void deBaseImageModule::LoadImage | ( | decBaseFileReader * | file, |
| deImage * | image, | ||
| deBaseImageInfo * | infos | ||
| ) | [pure virtual] |
Load the image into the provided storage.
You can be sure that the file pointer is at the same place left off after the prior call of CheckLoadImage on the same file and module. You can be sure that the image object specified in the function call has been created with the information stored in the infos parameter obtained from a prior call to the CheckLoadImage function.
| virtual void deBaseImageModule::SaveImage | ( | decBaseFileWriter * | file, |
| deImage * | image | ||
| ) | [pure virtual] |
Save the image in the provided storage into file.
You can be sure that the file provided has been rewinded prior to this function call.
The documentation for this class was generated from the following file:
