OGRE  1.12.9
Object-Oriented Graphics Rendering Engine
Ogre::FreeImageCodec Class Reference

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

#include <OgreFreeImageCodec.h>

+ Inheritance diagram for Ogre::FreeImageCodec:

Public Member Functions

 FreeImageCodec (const String &type, unsigned int fiType)
 
virtual ~FreeImageCodec ()
 
virtual DecodeResult decode (const DataStreamPtr &input) const
 
DecodeResult decode (const DataStreamPtr &input) const override
 
virtual void decode (const DataStreamPtr &input, const Any &output) const
 Codes the data from the input chunk into the output chunk. More...
 
void decode (const DataStreamPtr &input, const Any &output) const override
 
virtual DataStreamPtr encode (const Any &input) const
 Codes the input and saves the result in the output stream. More...
 
DataStreamPtr encode (const Any &input) const override
 
virtual DataStreamPtr encode (const MemoryDataStreamPtr &input, const CodecDataPtr &pData) const
 
DataStreamPtr encode (const MemoryDataStreamPtr &input, const CodecDataPtr &pData) const override
 
virtual void encodeToFile (const Any &input, const String &outFileName) const
 Codes the data in the input chunk and saves the result in the output filename provided. More...
 
void encodeToFile (const Any &input, const String &outFileName) const override
 
virtual void encodeToFile (const MemoryDataStreamPtr &input, const String &outFileName, const CodecDataPtr &pData) const
 
void encodeToFile (const MemoryDataStreamPtr &input, const String &outFileName, const CodecDataPtr &pData) const override
 
String getType () const override
 Returns the type of the codec as a String. More...
 
String magicNumberToFileExt (const char *magicNumberPtr, size_t maxbytes) const override
 Maps a magic number header to a file extension, if this codec recognises it. More...
 
- Public Member Functions inherited from Ogre::ImageCodec
virtual ~ImageCodec ()
 
virtual DecodeResult decode (const DataStreamPtr &input) const
 
virtual void decode (const DataStreamPtr &input, const Any &output) const
 Codes the data from the input chunk into the output chunk. More...
 
void decode (const DataStreamPtr &input, const Any &output) const override
 Codes the data from the input chunk into the output chunk. More...
 
virtual DataStreamPtr encode (const Any &input) const
 Codes the input and saves the result in the output stream. More...
 
DataStreamPtr encode (const Any &input) const override
 Codes the input and saves the result in the output stream. More...
 
virtual DataStreamPtr encode (const MemoryDataStreamPtr &input, const CodecDataPtr &pData) const
 
virtual void encodeToFile (const Any &input, const String &outFileName) const
 Codes the data in the input chunk and saves the result in the output filename provided. More...
 
void encodeToFile (const Any &input, const String &outFileName) const override
 Codes the data in the input chunk and saves the result in the output filename provided. More...
 
virtual void encodeToFile (const MemoryDataStreamPtr &input, const String &outFileName, const CodecDataPtr &pData) const
 
String getDataType () const
 
- Public Member Functions inherited from Ogre::Codec
virtual ~Codec ()
 
bool magicNumberMatch (const char *magicNumberPtr, size_t maxbytes) const
 Returns whether a magic number header matches this codec. More...
 

Static Public Member Functions

static _OgreFreeImageCodecExport void shutdown (void)
 Static method to shutdown FreeImage and unregister the FreeImage codecs. More...
 
static _OgreFreeImageCodecExport void startup (void)
 Static method to startup FreeImage and register the FreeImage codecs. More...
 
- Static Public Member Functions inherited from Ogre::Codec
static CodecgetCodec (char *magicNumberPtr, size_t maxbytes)
 Gets the codec that can handle the given 'magic' identifier. More...
 
static CodecgetCodec (const String &extension)
 Gets the codec registered for the passed in file extension. More...
 
static CodecIterator getCodecIterator (void)
 
static StringVector getExtensions (void)
 Gets the file extension list for the registered codecs. More...
 
static bool isCodecRegistered (const String &codecType)
 Return whether a codec is registered already. More...
 
static void registerCodec (Codec *pCodec)
 Registers a new codec in the database. More...
 
static void unregisterCodec (Codec *pCodec)
 Unregisters a codec from the database. More...
 

Additional Inherited Members

- Public Types inherited from Ogre::Codec
typedef SharedPtr< CodecDataCodecDataPtr
 
typedef ConstMapIterator< CodecList > CodecIterator
 
typedef std::pair< MemoryDataStreamPtr, CodecDataPtrDecodeResult
 Result of a decoding; both a decoded data stream and CodecData metadata. More...
 

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.

Constructor & Destructor Documentation

◆ FreeImageCodec()

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

◆ ~FreeImageCodec()

virtual Ogre::FreeImageCodec::~FreeImageCodec ( )
inlinevirtual

Member Function Documentation

◆ encode() [1/4]

DataStreamPtr Ogre::FreeImageCodec::encode ( const MemoryDataStreamPtr input,
const CodecDataPtr pData 
) const
overridevirtual
Deprecated:

Reimplemented from Ogre::Codec.

◆ encodeToFile() [1/4]

void Ogre::FreeImageCodec::encodeToFile ( const MemoryDataStreamPtr input,
const String outFileName,
const CodecDataPtr pData 
) const
overridevirtual
Deprecated:

Reimplemented from Ogre::Codec.

◆ decode() [1/4]

DecodeResult Ogre::FreeImageCodec::decode ( const DataStreamPtr input) const
overridevirtual
Deprecated:

Reimplemented from Ogre::Codec.

◆ getType()

String Ogre::FreeImageCodec::getType ( ) const
overridevirtual

Returns the type of the codec as a String.

Implements Ogre::Codec.

◆ magicNumberToFileExt()

String Ogre::FreeImageCodec::magicNumberToFileExt ( const char *  magicNumberPtr,
size_t  maxbytes 
) const
overridevirtual

Maps a magic number header to a file extension, if this codec recognises it.

Parameters
magicNumberPtrPointer 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.
maxbytesThe number of bytes passed
Returns
A blank string if the magic number was unknown, or a file extension.

Implements Ogre::Codec.

◆ startup()

static _OgreFreeImageCodecExport void Ogre::FreeImageCodec::startup ( void  )
static

Static method to startup FreeImage and register the FreeImage codecs.

Referenced by Ogre::FreeImagePlugin::install().

◆ shutdown()

static _OgreFreeImageCodecExport void Ogre::FreeImageCodec::shutdown ( void  )
static

Static method to shutdown FreeImage and unregister the FreeImage codecs.

Referenced by Ogre::FreeImagePlugin::uninstall().

◆ decode() [2/4]

void Ogre::ImageCodec::decode
override

◆ decode() [3/4]

virtual DecodeResult Ogre::Codec::decode
inline

◆ decode() [4/4]

virtual void Ogre::Codec::decode
inline

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

Parameters
inputStream containing the encoded data
outputcodec type specific result

◆ encode() [2/4]

DataStreamPtr Ogre::ImageCodec::encode
override

◆ encode() [3/4]

virtual DataStreamPtr Ogre::Codec::encode

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

◆ encode() [4/4]

virtual DataStreamPtr Ogre::Codec::encode
inline

◆ encodeToFile() [2/4]

void Ogre::ImageCodec::encodeToFile
override

◆ encodeToFile() [3/4]

virtual void Ogre::Codec::encodeToFile

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
inputThe input data (codec type specific)
outFileNameThe filename to write to

◆ encodeToFile() [4/4]

virtual void Ogre::Codec::encodeToFile
inline

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