CrystalSpace

Public API Reference

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 >.

List of all members.

Protected Member Functions

virtual csRef< iImageFileLoaderInitLoader (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< iJobQueuejobQueue
 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

Reference to job queue.

Definition at line 169 of file commonimagefile.h.

csRef<LoaderJob> csCommonImageFile::loadJob [mutable, protected]

Reference to the job for loading this image.

Definition at line 167 of file commonimagefile.h.


The documentation for this class was generated from the following file:

Generated for Crystal Space 1.4.1 by doxygen 1.7.1