gcn::ImageLoader Class Reference

#include <imageloader.hpp>

Inheritance diagram for gcn::ImageLoader:

List of all members.

---

Detailed Description

Abstract class for providing functions for loading images.

Guichan contains implementations of ImageLoader for common libraries like the Allegro library, the HGE library, he OpenLayer library, and the SDL library. To make Guichan usable with other libraries, an ImageLoader class must be implemented.

To make Guichan use an image loader, the image loader needs to be passed to the Image class using the static method Image::setImageLoader.

See also:

Image::setImageLoader, Image::getImageLoader, AllegroImageLoader, HGEImageLoader, OpenLayerImageLoader, OpenGLAllegroImageLoader, OpenGLSDLImageLoader, SDLImageLoader

Since:

0.1.0

Definition at line 87 of file imageloader.hpp.

Public Member Functions
virtual Image *	load (const std::string &filename, bool convertToDisplayFormat=true)=0
	Loads an image.
virtual	~ImageLoader ()
	Destructor.

---

Member Function Documentation

virtual Image* gcn::ImageLoader::load	(	const std::string &	filename,
		bool	convertToDisplayFormat = true
	)			[pure virtual]

Loads an image.

NOTE: The functions Image::getPixel and Image::putPixel are only guaranteed to work before an image has been converted to display format.

Parameters:

	filename	The filename of the image to load.
	convertToDisplayFormat	True if the image should be converted to display, false otherwise.

Implemented in gcn::AllegroImageLoader, gcn::HGEImageLoader, gcn::OpenGLAllegroImageLoader, gcn::OpenGLSDLImageLoader, gcn::OpenLayerImageLoader, and gcn::SDLImageLoader.

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

---

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

• imageloader.hpp

---