csCommonImageFile Class Reference
[Common Plugin Classes]
A base class for image loader plugin iImage implementations.
More...
#include <csplugincommon/imageloader/commonimagefile.h>
Inheritance diagram for csCommonImageFile:

Protected Member Functions | |
virtual const uint8 * | GetAlpha () |
Get alpha map for 8-bit paletted image. | |
virtual const void * | GetImageData () |
Get image data: returns either (csRGBpixel *) or (unsigned char *) depending on format. | |
virtual void | GetKeyColor (int &r, int &g, int &b) const |
Get the keycolour stored with the image. | |
virtual const csRGBpixel * | GetPalette () |
Get image palette (or 0 if no palette). | |
virtual csRef< iDataBuffer > | GetRawData () const |
Get the raw data of the image (or 0 if raw data is not provided). | |
virtual const char * | GetRawFormat () const |
Get a string identifying the format of the raw data of the image (or 0 if raw data is not provided). | |
virtual bool | HasKeyColor () const |
Check if image has a keycolour stored with it. | |
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 () |
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. | |
iObjectRegistry * | object_reg |
Friends | |
class | csCommonImageFileLoader |
Classes | |
class | LoaderJob |
Detailed Description
A base class for image loader plugin iImage implementations.
Definition at line 137 of file commonimagefile.h.
Member Function Documentation
|
Convert an image loader data type into a raw data description (if supported).
|
|
Get alpha map for 8-bit paletted image. RGBA images contains alpha within themself. If image has no alpha map, or the image is in RGBA format, this function will return 0. Reimplemented from csImageMemory. |
|
Get image data: returns either (csRGBpixel *) or (unsigned char *) depending on format. Note that for RGBA images the csRGBpixel structure contains the alpha channel as well, so GetAlpha (see below) method will return 0 (because alpha is not stored separately, as for paletted images). Reimplemented from csImageMemory. |
|
Get the keycolour stored with the image.
Reimplemented from csImageMemory. Definition at line 201 of file commonimagefile.h. |
|
Get image palette (or 0 if no palette).
Reimplemented from csImageMemory. |
|
Get the raw data of the image (or 0 if raw data is not provided).
Reimplemented from csImageBase. |
|
Get a string identifying the format of the raw data of the image (or 0 if raw data is not provided).
Reimplemented from csImageBase. |
|
Check if image has a keycolour stored with it.
Reimplemented from csImageMemory. Definition at line 190 of file commonimagefile.h. |
|
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. |
|
Load an image from a data buffer.
|
|
Convert data from the loader to actual image data.
|
|
Wait for the current image loading job to finish.
|
Member Data Documentation
|
Reference to job queue.
Definition at line 162 of file commonimagefile.h. |
|
Reference to the job for loading this image.
Definition at line 160 of file commonimagefile.h. |
The documentation for this class was generated from the following file:
- csplugincommon/imageloader/commonimagefile.h
Generated for Crystal Space by doxygen 1.4.4