CrystalSpace

Public API Reference

csCommonImageFileLoader Class Reference
[Common Plugin Classes]

Base image loader implementation. More...

#include <csplugincommon/imageloader/commonimagefile.h>

Inheritance diagram for csCommonImageFileLoader:

List of all members.

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< iDataBufferGetRawData ()
 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.
uint8 * indexData
 Pointer to indexed data (if dataType == rdtIndexed).
csRGBcolor keycolor
 Keycolor.
csRGBpixelpalette
 Palette for indexed colors.
size_t paletteCount
 Number of entries in the palette.
csRef< iDataBufferrawData
 Buffer with raw data.
csRGBpixelrgbaData
 Pointer to RGBA data (if dataType == rdtRGBpixel).
int Width
 Image dimensions.

Detailed Description

Base image loader implementation.

Definition at line 90 of file commonimagefile.h.


Member Function Documentation

virtual void csCommonImageFileLoader::ApplyTo ( csImageMemory image  )  [virtual]

Copy the image data into an image object.

Implements iImageFileLoader.

virtual csLoaderDataType csCommonImageFileLoader::GetDataType (  )  [inline, virtual]

Return type of raw data.

Implements iImageFileLoader.

Definition at line 126 of file commonimagefile.h.

virtual int csCommonImageFileLoader::GetFormat (  )  [inline, virtual]

Query format.

Implements iImageFileLoader.

Definition at line 130 of file commonimagefile.h.

virtual int csCommonImageFileLoader::GetHeight (  )  [inline, virtual]

Query height.

Implements iImageFileLoader.

Definition at line 129 of file commonimagefile.h.

virtual void csCommonImageFileLoader::GetKeyColor ( int &  r,
int &  g,
int &  b 
) const [inline, virtual]

Query keycolor.

Implements iImageFileLoader.

Definition at line 133 of file commonimagefile.h.

virtual csRef<iDataBuffer> csCommonImageFileLoader::GetRawData (  )  [inline, virtual]

Return "raw data" (if supported).

Implements iImageFileLoader.

Definition at line 124 of file commonimagefile.h.

virtual int csCommonImageFileLoader::GetWidth (  )  [inline, virtual]

Query width.

Implements iImageFileLoader.

Definition at line 128 of file commonimagefile.h.

virtual bool csCommonImageFileLoader::HasKeyColor (  )  const [inline, virtual]

Query whether a keycolor is set.

Implements iImageFileLoader.

Definition at line 132 of file commonimagefile.h.


Member Data Documentation

uint8* csCommonImageFileLoader::alpha [protected]

Alpha data for indexed images.

Definition at line 113 of file commonimagefile.h.

The type of image data this loader provides.

Definition at line 102 of file commonimagefile.h.

Format of the image.

Definition at line 95 of file commonimagefile.h.

Whether the image has a keycolor.

Definition at line 115 of file commonimagefile.h.

Pointer to indexed data (if dataType == rdtIndexed).

Definition at line 107 of file commonimagefile.h.

Keycolor.

Definition at line 117 of file commonimagefile.h.

Palette for indexed colors.

Definition at line 109 of file commonimagefile.h.

Number of entries in the palette.

Definition at line 111 of file commonimagefile.h.

Buffer with raw data.

Really only used for rdtR8G8B8.

Definition at line 100 of file commonimagefile.h.

Pointer to RGBA data (if dataType == rdtRGBpixel).

Definition at line 105 of file commonimagefile.h.

Image dimensions.

Definition at line 119 of file commonimagefile.h.


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

Generated for Crystal Space 2.1 by doxygen 1.6.1