Crazy Eddies GUI System  0.7.2
Public Member Functions | Protected Attributes | List of all members
CEGUI::OgreImageCodec Class Reference

ImageCodec object that loads data via image loading facilities in Ogre. More...

+ Inheritance diagram for CEGUI::OgreImageCodec:
+ Collaboration diagram for CEGUI::OgreImageCodec:

Public Member Functions

 OgreImageCodec ()
 Constructor.
 
void setImageFileDataType (const String &type)
 Set the file-type identifier that will be used for future load operations. More...
 
const StringgetImageFileDataType () const
 Return the string descibing the currently set file type.
 
Textureload (const RawDataContainer &data, Texture *result)
 Load an image from a memory buffer. More...
 
- Public Member Functions inherited from CEGUI::ImageCodec
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...
 

Protected Attributes

String d_dataTypeID
 Holds currently set file data type specifier (i.e. the file extension).
 
- Protected Attributes inherited from CEGUI::ImageCodec
String d_supportedFormat
 list all image file format supported
 

Additional Inherited Members

- Protected Member Functions inherited from CEGUI::ImageCodec
 ImageCodec (const String &name)
 

Detailed Description

ImageCodec object that loads data via image loading facilities in Ogre.

Member Function Documentation

Texture* CEGUI::OgreImageCodec::load ( const RawDataContainer data,
Texture result 
)
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

Implements CEGUI::ImageCodec.

void CEGUI::OgreImageCodec::setImageFileDataType ( const String type)

Set the file-type identifier that will be used for future load operations.

This allows us to pass the type on to Ogre when we process the image
data (because it's just file data; we do not have a filename nor file
extension).  Ogre needs this sometimes in order to correctly select the
right codec to use for the final decoding of the data.  If this value
is not set, loading may still succeed, though that will depend upon the
specific libraries and codecs that the Ogre installation has available
to it.
Parameters
typeString object that describes the type of file data that will be passed in subsequent load operations. Note that this type will typically be the file extension (or equivalent).