BmpImageLoader Class Reference

#include <bmpimage.h>

Inheritance diagram for BmpImageLoader:

Public Member Functions
const char *	Description ()
const char *	Version ()
const char *	FilterString ()
const char *	FilterDescription ()
const char *	GenerateHeader ()
const char *	GenerateDeclaration ()
bool	SupportsExtension (const char *ext)
bool	IsFileType (const char *filename)
virtual Image *	LoadTexture (const char *filename, const Image::LoadOptions &options, bool allowNPOT=true)
Public Member Functions inherited from TextureLoader
virtual const char *	PluginType ()
void	AddToList (TextureLoaderList *list=TextureLoaderList::Instance())
Public Member Functions inherited from Plugin
virtual const char *	PluginDataName ()
virtual void	WritePluginData (DistiAttributePluginData *)
virtual void	ReadPluginData (DistiAttributePluginData *)
virtual void	ResetPluginData ()
bool	IsPluginType (const char *str)

Detailed Description

The BmpImage class. Implements loading Bmp image files.

Member Function Documentation

const char* Description ( )

virtual

Returns

A description string used for informational display by the plugin GUI

Implements Plugin.

const char* FilterDescription ( )

virtual

Returns

A filter string description that is used by the windows FileBrowser to build the list of files to display in the browser

Implements TextureLoader.

const char* FilterString ( )

virtual

Returns

A filter string that is used by the windows FileBrowser to build the list of files to display in the browser

Implements TextureLoader.

const char* GenerateDeclaration ( )

virtual

Returns

The string to be generated to generate an instance of this object

Implements TextureLoader.

const char* GenerateHeader ( )

virtual

Returns

The name of the header file to include when generating code for this plugin

Implements TextureLoader.

bool IsFileType ( const char *  filename )

virtual

Returns

TRUE if the file pointer appears to contain an image that can be loaded by this class. This method must close the file if it returns TRUE. It must rewind the file if it returns FALSE

Implements TextureLoader.

virtual Image* LoadTexture ( const char *  filename, const Image::LoadOptions &  options, bool  allowNPOT = true  )

virtual

Load the specified texture file. Try all loaders to see if any of them support the given file type.

Parameters

filename	The file to load the image from
options	Options to load the image with
allowNPOT	If the image is allowed to be non-power of two (NPOT)

Returns

NULL if the file type isn't supported or if loading fails

Implements TextureLoader.

bool SupportsExtension ( const char *  ext )

virtual

Returns

TRUE if the class can load files with the given extension.

Implements TextureLoader.

const char* Version ( )

virtual

Returns

A version string used for informational display by the plugin GUI

Implements Plugin.

---

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

• bmpimage.h