#include <OgreFreeImageCodec.h>
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.
| ||||||||||
DecodeResult | decode (DataStreamPtr &input) const | |||||||||
Codes the data from the input chunk into the output chunk.
| ||||||||||
virtual String | getType () const | |||||||||
Returns the type of the codec as a String. | ||||||||||
String | magicNumberToFileExt (const char *magicNumberPtr, size_t maxbytes) const | |||||||||
Maps a magic number header to a file extension, if this codec recognises it.
| ||||||||||
String | getDataType () const | |||||||||
Returns the type of the data that supported by this codec as a String. | ||||||||||
virtual bool | magicNumberMatch (const char *magicNumberPtr, size_t maxbytes) const | |||||||||
Returns whether a magic number header matches this codec. | ||||||||||
void * | operator new (size_t sz, const char *file, int line, const char *func) | |||||||||
operator new, with debug line info | ||||||||||
void * | operator new (size_t sz) | |||||||||
void * | operator new (size_t sz, void *ptr) | |||||||||
placement operator new | ||||||||||
void * | operator new[] (size_t sz, const char *file, int line, const char *func) | |||||||||
array operator new, with debug line info | ||||||||||
void * | operator new[] (size_t sz) | |||||||||
void | operator delete (void *ptr) | |||||||||
void | operator delete (void *ptr, void *) | |||||||||
void | operator delete (void *ptr, const char *, int, const char *) | |||||||||
void | operator delete[] (void *ptr) | |||||||||
void | operator delete[] (void *ptr, const char *, int, const char *) | |||||||||
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 bool | isCodecRegistered (const String &codecType) | |||||||||
Return whether a codec is registered already. | ||||||||||
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 Codec * | getCodec (const String &extension) | |||||||||
Gets the codec registered for the passed in file extension. | ||||||||||
static Codec * | getCodec (char *magicNumberPtr, size_t maxbytes) | |||||||||
Gets the codec that can handle the given 'magic' identifier. | ||||||||||
Protected Types | ||||||||||
typedef map< String, Codec * > ::type | CodecList | |||||||||
Static Protected Attributes | ||||||||||
static CodecList | ms_mapCodecs | |||||||||
A map that contains all the registered codecs. | ||||||||||
Private Types | ||||||||||
typedef list< ImageCodec * >::type | 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 |
Definition at line 48 of file OgreFreeImageCodec.h.
typedef list<ImageCodec*>::type Ogre::FreeImageCodec::RegisteredCodecList [private] |
Definition at line 54 of file OgreFreeImageCodec.h.
typedef map< String, Codec* >::type Ogre::Codec::CodecList [protected, inherited] |
Definition at line 58 of file OgreCodec.h.
typedef SharedPtr<CodecData> Ogre::Codec::CodecDataPtr [inherited] |
Definition at line 73 of file OgreCodec.h.
typedef ConstMapIterator<CodecList> Ogre::Codec::CodecIterator [inherited] |
Definition at line 75 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 140 of file OgreCodec.h.
Ogre::FreeImageCodec::FreeImageCodec | ( | const String & | type, | |
unsigned int | fiType | |||
) |
virtual Ogre::FreeImageCodec::~FreeImageCodec | ( | ) | [virtual] |
Definition at line 62 of file OgreFreeImageCodec.h.
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.
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.
input | Stream containing the encoded data |
Implements Ogre::Codec.
virtual String Ogre::FreeImageCodec::getType | ( | ) | const [virtual] |
String Ogre::FreeImageCodec::magicNumberToFileExt | ( | const char * | magicNumberPtr, | |
size_t | maxbytes | |||
) | const [virtual] |
Maps a magic number header to a file extension, if this codec recognises it.
magicNumberPtr | Pointer to a stream of bytes which should identify the file. Note that this may be more than needed - each codec may be looking for a different size magic number. | |
maxbytes | The number of bytes passed |
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 79 of file OgreImageCodec.h.
static void Ogre::Codec::registerCodec | ( | Codec * | pCodec | ) | [static, inherited] |
Registers a new codec in the database.
Definition at line 82 of file OgreCodec.h.
References Ogre::Exception::ERR_DUPLICATE_ITEM, Ogre::Codec::getType(), and OGRE_EXCEPT.
static bool Ogre::Codec::isCodecRegistered | ( | const String & | codecType | ) | [static, inherited] |
static void Ogre::Codec::unRegisterCodec | ( | Codec * | pCodec | ) | [static, inherited] |
Unregisters a codec from the database.
Definition at line 101 of file OgreCodec.h.
References Ogre::Codec::getType().
static CodecIterator Ogre::Codec::getCodecIterator | ( | void | ) | [static, inherited] |
static StringVector Ogre::Codec::getExtensions | ( | void | ) | [static, inherited] |
Gets the file extension list for the registered codecs.
Gets the codec registered for the passed in file extension.
static Codec* Ogre::Codec::getCodec | ( | char * | magicNumberPtr, | |
size_t | maxbytes | |||
) | [static, inherited] |
Gets the codec that can handle the given 'magic' identifier.
magicNumberPtr | Pointer to a stream of bytes which should identify the file. Note that this may be more than needed - each codec may be looking for a different size magic number. | |
maxbytes | The number of bytes passed |
virtual bool Ogre::Codec::magicNumberMatch | ( | const char * | magicNumberPtr, | |
size_t | maxbytes | |||
) | const [virtual, inherited] |
Returns whether a magic number header matches this codec.
magicNumberPtr | Pointer to a stream of bytes which should identify the file. Note that this may be more than needed - each codec may be looking for a different size magic number. | |
maxbytes | The number of bytes passed |
Definition at line 162 of file OgreCodec.h.
void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz, | |
const char * | file, | |||
int | line, | |||
const char * | func | |||
) | [inherited] |
void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) | [inherited] |
Definition at line 72 of file OgreMemoryAllocatedObject.h.
void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz, | |
void * | ptr | |||
) | [inherited] |
void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz, | |
const char * | file, | |||
int | line, | |||
const char * | func | |||
) | [inherited] |
void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz | ) | [inherited] |
Definition at line 90 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) | [inherited] |
Definition at line 95 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr, | |
void * | ||||
) | [inherited] |
Definition at line 101 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr, | |
const char * | , | |||
int | , | |||
const char * | ||||
) | [inherited] |
Definition at line 107 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) | [inherited] |
Definition at line 112 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr, | |
const char * | , | |||
int | , | |||
const char * | ||||
) | [inherited] |
Definition at line 118 of file OgreMemoryAllocatedObject.h.
String Ogre::FreeImageCodec::mType [private] |
Definition at line 51 of file OgreFreeImageCodec.h.
unsigned int Ogre::FreeImageCodec::mFreeImageType [private] |
Definition at line 52 of file OgreFreeImageCodec.h.
RegisteredCodecList Ogre::FreeImageCodec::msCodecList [static, private] |
Definition at line 55 of file OgreFreeImageCodec.h.
CodecList Ogre::Codec::ms_mapCodecs [static, protected, inherited] |
Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sat Apr 24 18:02:13 2010