The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page

VCF::ImageLoader Class Reference

The ImageLoader interface provides a means to load up images into a generic Bitmap. More...

#include <vcf/GraphicsKit/ImageLoader.h>

Inheritance diagram for VCF::ImageLoader:

List of all members.

Public Member Functions
virtual	~ImageLoader ()
virtual Image *	loadImageFromFile (const String &fileName)=0
	loads the image from a file
virtual Image *	loadImageFromBytes (const unsigned char *imageData, const uint64 &dataLength)=0
virtual Image *	loadImageFromStream (InputStream *stream)=0
virtual bool	canSaveImage ()=0
	does this ImageLoader support saving the image
virtual void	saveImageToFile (const String &fileName, Image *image)=0
	Saves the image to file.

---

Detailed Description

The ImageLoader interface provides a means to load up images into a generic Bitmap.

Examples are JPEG ImageLoaders, GIF, BMP, etc ImageLoaders.

Version:

1.0

Author:

Jim Crafton

---

Constructor & Destructor Documentation

virtual VCF::ImageLoader::~ImageLoader (   )  [inline, virtual]

---

Member Function Documentation

virtual bool VCF::ImageLoader::canSaveImage (   )  [pure virtual]

does this ImageLoader support saving the image Returns: bool returns true if the ImageLoader supports saving the image, otherwise returns false. If the this function does return true, then it is safe to call saveImageToFile() Implemented in VCF::JPEGLoader, VCF::PNGLoader, and VCF::BMPLoader.

virtual Image* VCF::ImageLoader::loadImageFromBytes (  const unsigned char *  imageData, const uint64 &  dataLength )  [pure virtual]

Implemented in VCF::JPEGLoader, VCF::PNGLoader, and VCF::BMPLoader.

virtual Image* VCF::ImageLoader::loadImageFromFile (  const String &  fileName  )  [pure virtual]

loads the image from a file Parameters: String  the fully qualified file name that specifies the image to load Implemented in VCF::JPEGLoader, VCF::PNGLoader, and VCF::BMPLoader.

virtual Image* VCF::ImageLoader::loadImageFromStream (  InputStream *  stream  )  [pure virtual]

Implemented in VCF::JPEGLoader, VCF::PNGLoader, and VCF::BMPLoader.

virtual void VCF::ImageLoader::saveImageToFile (  const String &  fileName, Image *  image )  [pure virtual]

Saves the image to file. Parameters: String  the fully qualified filename that specifies the file to save. Image  the image object that will be saved Implemented in VCF::JPEGLoader, VCF::PNGLoader, and VCF::BMPLoader.

---

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

• vcf/GraphicsKit/ImageLoader.h

Comments or Suggestions?    License Information