jpp::video::IImageLoader Class Reference

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

#include <jimcpp/core/engine/IImageLoader.hpp>

Inheritance diagram for jpp::video::IImageLoader:

Collaboration diagram for jpp::video::IImageLoader:

Public Member Functions
virtual bool	isALoadableFileExtension (const io::path &filename) const =0
	Check if the file might be loaded by this class.
virtual bool	isALoadableFileFormat (io::IReadFile *file) const =0
	Check if the file might be loaded by this class.
virtual IImage *	loadImage (io::IReadFile *file) const =0
	Creates a surface from the file.
virtual core::array< IImage * >	loadImages (io::IReadFile *file, E_TEXTURE_TYPE *type) const
	Creates a multiple surfaces from the file eg. whole cube map.
Public Member Functions inherited from jpp::IReferenceCounted
	IReferenceCounted ()
	Constructor.
virtual	~IReferenceCounted ()
	Destructor.
void	grab () const
	Grabs the object. Increments the reference counter by one.
bool	drop () const
	Drops the object. Decrements the reference counter by one.
s32	getReferenceCount () const
	Get the reference count.
const c8 *	getDebugName () const
	Returns the debug name of the object.

Additional Inherited Members
Protected Member Functions inherited from jpp::IReferenceCounted
void	setDebugName (const c8 *newName)
	Sets the debug name of the object.

Detailed Description

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

If you want the Jimcpp 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.

Member Function Documentation

isALoadableFileExtension()

virtual bool jpp::video::IImageLoader::isALoadableFileExtension ( const io::path &  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

filename

Name of file to check.

Returns

True if file seems to be loadable.

isALoadableFileFormat()

virtual bool jpp::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

file	File handle to check.

Returns

True if file seems to be loadable.

loadImage()

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

pure virtual

Creates a surface from the file.

Parameters

file	File handle to check.

Returns

Pointer to newly created image, or 0 upon error.

loadImages()

virtual core::array< IImage * > jpp::video::IImageLoader::loadImages ( io::IReadFile *  file, E_TEXTURE_TYPE *  type  ) const

inlinevirtual

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

Parameters

file	File handle to check.
type	Pointer to E_TEXTURE_TYPE where a recommended type of the texture will be stored.

Returns

Array of pointers to newly created images.

---

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

• include/jimcpp/core/engine/IImageLoader.hpp