csCommonImageFile Class Reference
[Common Plugin Classes]
A base class for image loader plugin iImage implementations.
More...
#include <csplugincommon/imageloader/commonimagefile.h>
Inherits scfImplementationExt0<csCommonImageFile, csImageMemory>.
Protected Member Functions | |
| virtual csRef< iImageFileLoader > | InitLoader (csRef< iDataBuffer > source)=0 |
| Create a loader object, which will handle the actual loading. | |
| virtual bool | Load (csRef< iDataBuffer > source) |
| Load an image from a data buffer. | |
| void | MakeImageData () const |
| Convert data from the loader to actual image data. | |
| void | WaitForJob () const |
| Wait for the current image loading job to finish. | |
Static Protected Member Functions | |
| static const char * | DataTypeString (csLoaderDataType dataType) |
| Convert an image loader data type into a raw data description (if supported). | |
Protected Attributes | |
| csRef< iJobQueue > | jobQueue |
| Reference to job queue. | |
| csRef< LoaderJob > | loadJob |
| Reference to the job for loading this image. | |
Friends | |
| class | csCommonImageFileLoader |
Detailed Description
A base class for image loader plugin iImage implementations.Definition at line 143 of file commonimagefile.h.
Member Function Documentation
| static const char* csCommonImageFile::DataTypeString | ( | csLoaderDataType | dataType | ) | [static, protected] |
Convert an image loader data type into a raw data description (if supported).
| virtual csRef<iImageFileLoader> csCommonImageFile::InitLoader | ( | csRef< iDataBuffer > | source | ) | [protected, pure virtual] |
Create a loader object, which will handle the actual loading.
Note: the returned loader should have a proper width, height, format, data type and keycolor flag (note not the actual color) already set.
| virtual bool csCommonImageFile::Load | ( | csRef< iDataBuffer > | source | ) | [protected, virtual] |
Load an image from a data buffer.
| void csCommonImageFile::MakeImageData | ( | ) | const [protected] |
Convert data from the loader to actual image data.
| void csCommonImageFile::WaitForJob | ( | ) | const [protected] |
Wait for the current image loading job to finish.
Member Data Documentation
csRef<iJobQueue> csCommonImageFile::jobQueue [mutable, protected] |
csRef<LoaderJob> csCommonImageFile::loadJob [mutable, protected] |
The documentation for this class was generated from the following file:
- csplugincommon/imageloader/commonimagefile.h
Generated for Crystal Space 1.4.0 by doxygen 1.5.8
