Saga3D API Documentation  1.0-RC4
saga::video::IImageLoader Class Referenceabstract

Class which is able to create a image from a file. More...

#include <IImageLoader.h>

Public Member Functions

virtual bool isALoadableFileExtension (const std::string &filename) const =0
 Check if the file might be loaded by this class. More...
 
virtual bool isALoadableFileFormat (io::IReadFile *file) const =0
 Check if the file might be loaded by this class. More...
 
virtual IImage * loadImage (io::IReadFile *file) const =0
 Creates a surface from the file. More...
 
virtual std::vector< IImage * > loadImages (io::IReadFile *file, E_TEXTURE_TYPE *type) const
 Creates a multiple surfaces from the file eg. whole cube map. More...
 

Detailed Description

Class which is able to create a image from a file.

If you want the Irrlicht Engine be able to load textures of currently unsupported file formats (e.g .gif), then implement this and add your new Surface loader with IVideoDriver::addExternalImageLoader() to the engine.

Definition at line 28 of file IImageLoader.h.

Member Function Documentation

◆ isALoadableFileExtension()

virtual bool saga::video::IImageLoader::isALoadableFileExtension ( const std::string &  filename) const
pure virtual

Check if the file might be loaded by this class.

Check is based on the file extension (e.g. ".tga")

Parameters
filenameName of file to check.
Returns
True if file seems to be loadable.

◆ isALoadableFileFormat()

virtual bool saga::video::IImageLoader::isALoadableFileFormat ( io::IReadFile *  file) const
pure virtual

Check if the file might be loaded by this class.

Check might look into the file.

Parameters
fileFile handle to check.
Returns
True if file seems to be loadable.

◆ loadImage()

virtual IImage* saga::video::IImageLoader::loadImage ( io::IReadFile *  file) const
pure virtual

Creates a surface from the file.

Parameters
fileFile handle to check.
Returns
Pointer to newly created image, or 0 upon error.

◆ loadImages()

virtual std::vector<IImage*> saga::video::IImageLoader::loadImages ( io::IReadFile *  file,
E_TEXTURE_TYPE type 
) const
inlinevirtual

Creates a multiple surfaces from the file eg. whole cube map.

Parameters
fileFile handle to check.
typePointer to E_TEXTURE_TYPE where a recommended type of the texture will be stored.
Returns
Array of pointers to newly created images.

Definition at line 53 of file IImageLoader.h.


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