csCommonImageFileLoader Class Reference
[Common Plugin Classes]
Base image loader implementation.  
More...
#include <csplugincommon/imageloader/commonimagefile.h>
Inheritance diagram for csCommonImageFileLoader:

| Public Member Functions | |
| virtual void | ApplyTo (csImageMemory *image) | 
| Copy the image data into an image object. | |
| virtual csLoaderDataType | GetDataType () | 
| Return type of raw data. | |
| virtual int | GetFormat () | 
| Query format. | |
| virtual int | GetHeight () | 
| Query height. | |
| virtual void | GetKeyColor (int &r, int &g, int &b) const | 
| Query keycolor. | |
| virtual csRef< iDataBuffer > | GetRawData () | 
| Return "raw data" (if supported). | |
| virtual int | GetWidth () | 
| Query width. | |
| virtual bool | HasKeyColor () const | 
| Query whether a keycolor is set. | |
| Protected Attributes | |
| uint8 * | alpha | 
| Alpha data for indexed images. | |
| csLoaderDataType | dataType | 
| The type of image data this loader provides. | |
| int | Format | 
| Format of the image. | |
| bool | hasKeycolor | 
| Whether the image has a keycolor. | |
| int | Height | 
| uint8 * | indexData | 
| Pointer to indexed data (if dataType == rdtIndexed). | |
| csRGBcolor | keycolor | 
| Keycolor. | |
| csRGBpixel * | palette | 
| Palette for indexed colors. | |
| size_t | paletteCount | 
| Number of entries in the palette. | |
| csRef< iDataBuffer > | rawData | 
| Buffer with raw data. | |
| csRGBpixel * | rgbaData | 
| Pointer to RGBA data (if dataType == rdtRGBpixel). | |
| int | Width | 
| Image dimensions. | |
Detailed Description
Base image loader implementation.
Definition at line 89 of file commonimagefile.h.
Member Function Documentation
| virtual void csCommonImageFileLoader::ApplyTo | ( | csImageMemory * | image | ) |  [virtual] | 
| virtual csLoaderDataType csCommonImageFileLoader::GetDataType | ( | ) |  [inline, virtual] | 
Return type of raw data.
Implements iImageFileLoader.
Definition at line 121 of file commonimagefile.h.
| virtual int csCommonImageFileLoader::GetFormat | ( | ) |  [inline, virtual] | 
| virtual int csCommonImageFileLoader::GetHeight | ( | ) |  [inline, virtual] | 
| virtual void csCommonImageFileLoader::GetKeyColor | ( | int & | r, | |
| int & | g, | |||
| int & | b | |||
| ) | const  [inline, virtual] | 
| virtual csRef<iDataBuffer> csCommonImageFileLoader::GetRawData | ( | ) |  [inline, virtual] | 
Return "raw data" (if supported).
Implements iImageFileLoader.
Definition at line 119 of file commonimagefile.h.
| virtual int csCommonImageFileLoader::GetWidth | ( | ) |  [inline, virtual] | 
| virtual bool csCommonImageFileLoader::HasKeyColor | ( | ) | const  [inline, virtual] | 
Query whether a keycolor is set.
Implements iImageFileLoader.
Definition at line 127 of file commonimagefile.h.
Member Data Documentation
| uint8* csCommonImageFileLoader::alpha  [protected] | 
| csLoaderDataType csCommonImageFileLoader::dataType  [protected] | 
| int csCommonImageFileLoader::Format  [protected] | 
| bool csCommonImageFileLoader::hasKeycolor  [protected] | 
| uint8* csCommonImageFileLoader::indexData  [protected] | 
Pointer to indexed data (if dataType == rdtIndexed).
Definition at line 102 of file commonimagefile.h.
| csRGBcolor csCommonImageFileLoader::keycolor  [protected] | 
| csRGBpixel* csCommonImageFileLoader::palette  [protected] | 
| size_t csCommonImageFileLoader::paletteCount  [protected] | 
| csRef<iDataBuffer> csCommonImageFileLoader::rawData  [protected] | 
| csRGBpixel* csCommonImageFileLoader::rgbaData  [protected] | 
Pointer to RGBA data (if dataType == rdtRGBpixel).
Definition at line 100 of file commonimagefile.h.
| int csCommonImageFileLoader::Width  [protected] | 
The documentation for this class was generated from the following file:
- csplugincommon/imageloader/commonimagefile.h
Generated for Crystal Space by doxygen 1.4.7

