Ogre::FreeImageCodec Class Reference

Codec specialized in images loaded using FreeImage. More...

#include <OgreFreeImageCodec.h>

Inheritance diagram for Ogre::FreeImageCodec:
[legend]

List of all members.

Public Types

typedef SharedPtr
< CodecData > 
CodecDataPtr
typedef
ConstMapIterator
< CodecList
CodecIterator
typedef std::pair
< MemoryDataStreamPtr,
CodecDataPtr
DecodeResult
 Result of a decoding; both a decoded data stream and CodecData metadata.

Public Member Functions

 FreeImageCodec (const String &type, unsigned int fiType)
virtual ~FreeImageCodec ()
DataStreamPtr code (MemoryDataStreamPtr &input, CodecDataPtr &pData) const
 Codes the data in the input stream and saves the result in the output stream.
void codeToFile (MemoryDataStreamPtr &input, const String &outFileName, CodecDataPtr &pData) const
 Codes the data in the input chunk and saves the result in the output filename provided.

Provided for efficiency since coding to memory is progressive therefore memory required is unknown leading to reallocations.

Parameters:
input The input data
outFileName The filename to write to
pData Extra information to be passed to the codec (codec type specific)

DecodeResult decode (DataStreamPtr &input) const
 Codes the data from the input chunk into the output chunk.

Parameters:
input Stream containing the encoded data
Note:
Has a variable number of arguments, which depend on the codec type.

virtual String getType () const
 Returns the type of the codec as a String.
String getDataType () const
 Returns the type of the data that supported by this codec as a String.

Static Public Member Functions

static void startup (void)
 Static method to startup FreeImage and register the FreeImage codecs.
static void shutdown (void)
 Static method to shutdown FreeImage and unregister the FreeImage codecs.
static void registerCodec (Codec *pCodec)
 Registers a new codec in the database.
static void unRegisterCodec (Codec *pCodec)
 Unregisters a codec from the database.
static CodecIterator getCodecIterator (void)
 Gets the iterator for the registered codecs.
static StringVector getExtensions (void)
 Gets the file extension list for the registered codecs.
static CodecgetCodec (const String &extension)
 Gets the codec registered for the passed in file extension.

Protected Types

typedef std::map
< String, Codec * > 
CodecList

Static Protected Attributes

static CodecList ms_mapCodecs
 A map that contains all the registered codecs.

Private Types

typedef std::list
< ImageCodec * > 
RegisteredCodecList

Private Member Functions

FIBITMAP * encode (MemoryDataStreamPtr &input, CodecDataPtr &pData) const
 Common encoding routine.

Private Attributes

String mType
unsigned int mFreeImageType

Static Private Attributes

static
RegisteredCodecList 
msCodecList


Detailed Description

Codec specialized in images loaded using FreeImage.

Remarks:
The users implementing subclasses of ImageCodec are required to return a valid pointer to a ImageData class from the decode(...) function.

Definition at line 43 of file OgreFreeImageCodec.h.


Member Typedef Documentation

typedef std::list<ImageCodec*> Ogre::FreeImageCodec::RegisteredCodecList [private]

Definition at line 49 of file OgreFreeImageCodec.h.

typedef std::map< String, Codec* > Ogre::Codec::CodecList [protected, inherited]

Definition at line 52 of file OgreCodec.h.

typedef SharedPtr<CodecData> Ogre::Codec::CodecDataPtr [inherited]

Definition at line 67 of file OgreCodec.h.

typedef ConstMapIterator<CodecList> Ogre::Codec::CodecIterator [inherited]

Definition at line 69 of file OgreCodec.h.

typedef std::pair<MemoryDataStreamPtr, CodecDataPtr> Ogre::Codec::DecodeResult [inherited]

Result of a decoding; both a decoded data stream and CodecData metadata.

Definition at line 114 of file OgreCodec.h.


Constructor & Destructor Documentation

Ogre::FreeImageCodec::FreeImageCodec ( const String type,
unsigned int  fiType 
)

virtual Ogre::FreeImageCodec::~FreeImageCodec (  )  [virtual]

Definition at line 57 of file OgreFreeImageCodec.h.


Member Function Documentation

FIBITMAP* Ogre::FreeImageCodec::encode ( MemoryDataStreamPtr input,
CodecDataPtr pData 
) const [private]

Common encoding routine.

DataStreamPtr Ogre::FreeImageCodec::code ( MemoryDataStreamPtr input,
CodecDataPtr pData 
) const [virtual]

Codes the data in the input stream and saves the result in the output stream.

Implements Ogre::Codec.

void Ogre::FreeImageCodec::codeToFile ( MemoryDataStreamPtr input,
const String outFileName,
CodecDataPtr pData 
) const [virtual]

Codes the data in the input chunk and saves the result in the output filename provided.

Provided for efficiency since coding to memory is progressive therefore memory required is unknown leading to reallocations.

Parameters:
input The input data
outFileName The filename to write to
pData Extra information to be passed to the codec (codec type specific)

Implements Ogre::Codec.

DecodeResult Ogre::FreeImageCodec::decode ( DataStreamPtr input  )  const [virtual]

Codes the data from the input chunk into the output chunk.

Parameters:
input Stream containing the encoded data
Note:
Has a variable number of arguments, which depend on the codec type.

Implements Ogre::Codec.

virtual String Ogre::FreeImageCodec::getType (  )  const [virtual]

Returns the type of the codec as a String.

Implements Ogre::Codec.

static void Ogre::FreeImageCodec::startup ( void   )  [static]

Static method to startup FreeImage and register the FreeImage codecs.

static void Ogre::FreeImageCodec::shutdown ( void   )  [static]

Static method to shutdown FreeImage and unregister the FreeImage codecs.

String Ogre::ImageCodec::getDataType (  )  const [virtual, inherited]

Returns the type of the data that supported by this codec as a String.

Implements Ogre::Codec.

Definition at line 74 of file OgreImageCodec.h.

static void Ogre::Codec::registerCodec ( Codec pCodec  )  [static, inherited]

Registers a new codec in the database.

Definition at line 76 of file OgreCodec.h.

References Ogre::Codec::getType().

static void Ogre::Codec::unRegisterCodec ( Codec pCodec  )  [static, inherited]

Unregisters a codec from the database.

Definition at line 83 of file OgreCodec.h.

References Ogre::Codec::getType().

static CodecIterator Ogre::Codec::getCodecIterator ( void   )  [static, inherited]

Gets the iterator for the registered codecs.

Definition at line 89 of file OgreCodec.h.

static StringVector Ogre::Codec::getExtensions ( void   )  [static, inherited]

Gets the file extension list for the registered codecs.

static Codec* Ogre::Codec::getCodec ( const String extension  )  [static, inherited]

Gets the codec registered for the passed in file extension.


Member Data Documentation

String Ogre::FreeImageCodec::mType [private]

Definition at line 46 of file OgreFreeImageCodec.h.

unsigned int Ogre::FreeImageCodec::mFreeImageType [private]

Definition at line 47 of file OgreFreeImageCodec.h.

RegisteredCodecList Ogre::FreeImageCodec::msCodecList [static, private]

Definition at line 50 of file OgreFreeImageCodec.h.

CodecList Ogre::Codec::ms_mapCodecs [static, protected, inherited]

A map that contains all the registered codecs.

Definition at line 55 of file OgreCodec.h.


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

Copyright © 2000-2005 by The OGRE Team
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Mon Jun 16 12:49:44 2008