CrystalSpace

Public API Reference

Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

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:

csImageMemory csImageBase iImage iBase List of all members.

Protected Member Functions

virtual bool Load (csRef< iDataBuffer > source)
 Load an image from a data buffer.
virtual csRef< iImageFileLoaderInitLoader (csRef< iDataBuffer > source)=0
 Create a loader object, which will handle the actual loading.
void WaitForJob () const
 Wait for the current image loading job to finish.
void MakeImageData ()
 Convert data from the loader ro actual image data.
virtual const void * GetImageData ()
 Get image data: returns either (csRGBpixel *) or (unsigned char *) depending on format.
virtual const csRGBpixelGetPalette ()
 Get image palette (or 0 if no palette).
virtual const uint8GetAlpha ()
 Get alpha map for 8-bit paletted image.
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 csRef< iDataBufferGetRawData () const
 Get the raw data of the image (or 0 if raw data is not provided).

Friends

class csCommonImageFileLoader

Detailed Description

A base class for image loader plugin iImage implementations.

Definition at line 117 of file commonimagefile.h.


Member Function Documentation

virtual const uint8* csCommonImageFile::GetAlpha  )  [protected, virtual]
 

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.

virtual const void* csCommonImageFile::GetImageData  )  [protected, virtual]
 

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.

virtual const csRGBpixel* csCommonImageFile::GetPalette  )  [protected, virtual]
 

Get image palette (or 0 if no palette).

Reimplemented from csImageMemory.

virtual csRef<iDataBuffer> csCommonImageFile::GetRawData  )  const [protected, virtual]
 

Get the raw data of the image (or 0 if raw data is not provided).

Reimplemented from csImageBase.

virtual const char* csCommonImageFile::GetRawFormat  )  const [protected, virtual]
 

Get a string identifying the format of the raw data of the image (or 0 if raw data is not provided).

Reimplemented from csImageBase.

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 and data type already set.

virtual bool csCommonImageFile::Load csRef< iDataBuffer source  )  [protected, virtual]
 

Load an image from a data buffer.

void csCommonImageFile::MakeImageData  )  [protected]
 

Convert data from the loader ro actual image data.

void csCommonImageFile::WaitForJob  )  const [protected]
 

Wait for the current image loading job to finish.


The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.3.9.1