Main Page | Class Hierarchy | Class List | Directories | File List | Class Members | Related Pages

gcn::ImageLoader Class Reference

#include <imageloader.hpp>

Inheritance diagram for gcn::ImageLoader:

gcn::AllegroImageLoader gcn::OpenGLImageLoader gcn::SDLImageLoader List of all members.

Detailed Description

ImageLoaders base class.

Contains basic image loading functions every image loader should have. Image loaders should inherit from this class and impements it's functions.

Definition at line 72 of file imageloader.hpp.

Public Member Functions

virtual ~ImageLoader ()
 Destructor.
virtual void prepare (const std::string &filename)=0
 Prepares an image for reading.
virtual void free (Image *image)=0
 This function frees an image.
virtual void * getRawData ()=0
 Rreturns a pointer of raw data of an image.
virtual void * finalize ()=0
 Finalizes an image meaning it will return the image data.
virtual void discard ()=0
 Discards a prepared image.
virtual int getHeight () const =0
 Gets the height if the image.
virtual int getWidth () const =0
 Gets the width of an image.
virtual Color getPixel (int x, int y)=0
 Gets the color of a pixel at coordinate x and y.
virtual void putPixel (int x, int y, const Color &color)=0
 Puts a pixel with a certain color at coordinate x and y.


Member Function Documentation

virtual void gcn::ImageLoader::discard  )  [pure virtual]
 

Discards a prepared image.

Exceptions:
Exception when no image has been prepared.

Implemented in gcn::AllegroImageLoader, gcn::OpenGLImageLoader, and gcn::SDLImageLoader.

Referenced by gcn::OpenGLImageLoader::discard(), and gcn::OpenGLImageLoader::finalize().

virtual void* gcn::ImageLoader::finalize  )  [pure virtual]
 

Finalizes an image meaning it will return the image data.

If the image contains pixels with "magic pink" (0xff00ff) they will be treated as transparent pixels.

Returns:
a pointer to the image data.
Exceptions:
Exception when no image has been prepared.

Implemented in gcn::AllegroImageLoader, gcn::OpenGLImageLoader, and gcn::SDLImageLoader.

Referenced by gcn::Image::Image(), and gcn::ImageFont::ImageFont().

virtual void gcn::ImageLoader::free Image image  )  [pure virtual]
 

This function frees an image.

NOTE: There is generally no reason to call this function as it is called upon by the Image object when destroying an Image.

Parameters:
filename the file to be freed and removed.
Exceptions:
Exception when image points to NULL.

Implemented in gcn::AllegroImageLoader, gcn::OpenGLImageLoader, and gcn::SDLImageLoader.

Referenced by gcn::Image::~Image().

virtual int gcn::ImageLoader::getHeight  )  const [pure virtual]
 

Gets the height if the image.

Returns:
the height of the image.
Exceptions:
Exception if no image have been prepared.

Implemented in gcn::AllegroImageLoader, gcn::OpenGLImageLoader, and gcn::SDLImageLoader.

Referenced by gcn::OpenGLImageLoader::finalize(), gcn::OpenGLImageLoader::getHeight(), gcn::Image::Image(), and gcn::ImageFont::ImageFont().

virtual Color gcn::ImageLoader::getPixel int  x,
int  y
[pure virtual]
 

Gets the color of a pixel at coordinate x and y.

Parameters:
x the x coordinate.
y the y coordinate.
Returns:
the color of the pixel.

Implemented in gcn::AllegroImageLoader, gcn::OpenGLImageLoader, and gcn::SDLImageLoader.

Referenced by gcn::OpenGLImageLoader::getPixel(), and gcn::ImageFont::ImageFont().

virtual void* gcn::ImageLoader::getRawData  )  [pure virtual]
 

Rreturns a pointer of raw data of an image.

The raw data is in 32 bit RGBA format. The funcion will not free a prepared image, so finalize or discard should be used afterwards.

Returns:
a pointer to the raw image data.

Implemented in gcn::AllegroImageLoader, gcn::OpenGLImageLoader, and gcn::SDLImageLoader.

Referenced by gcn::OpenGLImageLoader::finalize(), and gcn::OpenGLImageLoader::getRawData().

virtual int gcn::ImageLoader::getWidth  )  const [pure virtual]
 

Gets the width of an image.

Returns:
the width of the image.
Exceptions:
Exception if no image have been prepared.

Implemented in gcn::AllegroImageLoader, gcn::OpenGLImageLoader, and gcn::SDLImageLoader.

Referenced by gcn::OpenGLImageLoader::finalize(), gcn::OpenGLImageLoader::getWidth(), gcn::Image::Image(), and gcn::ImageFont::ImageFont().

virtual void gcn::ImageLoader::prepare const std::string &  filename  )  [pure virtual]
 

Prepares an image for reading.

After you have called this function you can retrieve information about it and edit it.

Parameters:
filename the image file to prepare.
Exceptions:
Exception when called without having finalized or disposed to last image or when unable to load the image.

Implemented in gcn::AllegroImageLoader, gcn::OpenGLImageLoader, and gcn::SDLImageLoader.

Referenced by gcn::Image::Image(), and gcn::OpenGLImageLoader::prepare().

virtual void gcn::ImageLoader::putPixel int  x,
int  y,
const Color color
[pure virtual]
 

Puts a pixel with a certain color at coordinate x and y.

Parameters:
x the x coordinate.
y the y coordinate.
color the color of the pixel to put.

Implemented in gcn::AllegroImageLoader, gcn::OpenGLImageLoader, and gcn::SDLImageLoader.

Referenced by gcn::OpenGLImageLoader::putPixel().


The documentation for this class was generated from the following file:
Generated on Tue May 17 21:23:26 2005 for Guichan by  doxygen 1.4.1