Crazy Eddie's GUI System  0.8.7
CEGUI::ImageCodec Class Referenceabstract

Abstract ImageLoader class. An image loader encapsulate the loading of a texture. More...

Inherits CEGUI::AllocatedObject< ImageCodec >.

Inherited by CEGUI::CoronaImageCodec, CEGUI::DevILImageCodec, CEGUI::FreeImageImageCodec, CEGUI::IrrlichtImageCodec, CEGUI::OgreImageCodec, CEGUI::PVRImageCodec, CEGUI::SDL2ImageCodec, CEGUI::SILLYImageCodec, CEGUI::STBImageCodec, and CEGUI::TGAImageCodec.

+ Collaboration diagram for CEGUI::ImageCodec:

Public Member Functions

virtual ~ImageCodec ()
 Destructor.
 
const StringgetIdentifierString () const
 Return the name of the image codec object. More...
 
const StringgetSupportedFormat () const
 Return the list of image file format supported. More...
 
virtual Textureload (const RawDataContainer &data, Texture *result)=0
 Load an image from a memory buffer. More...
 

Protected Member Functions

 ImageCodec (const String &name)
 

Protected Attributes

String d_supportedFormat
 list all image file format supported
 

Detailed Description

Abstract ImageLoader class. An image loader encapsulate the loading of a texture.

This class define the loading of an abstract

Member Function Documentation

const String& CEGUI::ImageCodec::getIdentifierString ( ) const

Return the name of the image codec object.

Return the name of the image codec

Returns
a string containing image codec name
const String& CEGUI::ImageCodec::getSupportedFormat ( ) const

Return the list of image file format supported.

Return a list of space separated image format supported by this codec

Returns
list of supported image file format separated with space
virtual Texture* CEGUI::ImageCodec::load ( const RawDataContainer data,
Texture result 
)
pure virtual

Load an image from a memory buffer.

Parameters
datathe image data
resultthe texture to use for storing the image data
Returns
result on success or 0 if the load failed

Implemented in CEGUI::TGAImageCodec, CEGUI::OgreImageCodec, CEGUI::DevILImageCodec, CEGUI::SDL2ImageCodec, CEGUI::SILLYImageCodec, CEGUI::STBImageCodec, CEGUI::FreeImageImageCodec, CEGUI::CoronaImageCodec, CEGUI::IrrlichtImageCodec, and CEGUI::PVRImageCodec.