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

#include <OgreFreeImageCodec2.h>

Inheritance diagram for Ogre::FreeImageCodec2:

Public Member Functions
	FreeImageCodec2 (const String &type, unsigned int fiType)

	~FreeImageCodec2 () override

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

DataStreamPtr	encode (MemoryDataStreamPtr &input, CodecDataPtr &pData) const override
	Codes the data in the input stream and saves the result in the output stream. More...

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

void	encodeToFile (MemoryDataStreamPtr &input, const String &outFileName, CodecDataPtr &pData) const override
	Codes the data in the input chunk and saves the result in the output filename provided. More...

virtual 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...

ValidationStatus	validateMagicNumber (const char *magicNumberPtr, size_t maxbytes) const override
	validateMagicNumber Returns whether a magic number header matches this codec. More...

Public Member Functions inherited from Ogre::ImageCodec2
	~ImageCodec2 () override

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

Public Member Functions inherited from Ogre::Codec
virtual	~Codec ()

virtual bool	magicNumberMatch (const char *magicNumberPtr, size_t maxbytes) const
	Returns whether a magic number header matches this codec. More...

Static Public Member Functions
static void	shutdown ()
	Static method to shutdown FreeImage and unregister the FreeImage codecs. More...

static void	startup ()
	Static method to startup FreeImage and register the FreeImage codecs. More...

Static Public Member Functions inherited from Ogre::Codec
static Codec *	getCodec (char *magicNumberPtr, size_t maxbytes)
	Gets the codec that can handle the given 'magic' identifier. More...

static Codec *	getCodec (const String &extension)
	Gets the codec registered for the passed in file extension. More...

static CodecIterator	getCodecIterator ()
	Gets the iterator for the registered codecs. More...

static StringVector	getExtensions ()
	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< CodecData >	CodecDataPtr

typedef ConstMapIterator< CodecList >	CodecIterator

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

enum	ValidationStatus { CodecValid , CodecInvalid , CodecUnknown }

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

◆ FreeImageCodec2()

Ogre::FreeImageCodec2::FreeImageCodec2	(	const String &	type,
		unsigned int	fiType
	)

◆ ~FreeImageCodec2()

Ogre::FreeImageCodec2::~FreeImageCodec2 ( )

inlineoverride

Member Function Documentation

◆ decode()

DecodeResult Ogre::FreeImageCodec2::decode ( DataStreamPtr & input ) const

overridevirtual

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

Parameters

input Stream containing the encoded data

Implements Ogre::Codec.

◆ encode()

DataStreamPtr Ogre::FreeImageCodec2::encode	(	MemoryDataStreamPtr &	input,
		CodecDataPtr &	pData
	)		const

overridevirtual

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

Implements Ogre::Codec.

◆ encodeBitmap()

FIBITMAP* Ogre::FreeImageCodec2::encodeBitmap	(	MemoryDataStreamPtr &	input,
		CodecDataPtr &	pData
	)		const

Common encoding routine.

◆ encodeToFile()

void Ogre::FreeImageCodec2::encodeToFile	(	MemoryDataStreamPtr &	input,
		const String &	outFileName,
		CodecDataPtr &	pData
	)		const

overridevirtual

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.

◆ getType()

virtual String Ogre::FreeImageCodec2::getType ( ) const

overridevirtual

Returns the type of the codec as a String.

Implements Ogre::Codec.

◆ magicNumberToFileExt()

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

overridevirtual

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

Parameters

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

Returns: A blank string if the magic number was unknown, or a file extension.

Implements Ogre::Codec.

◆ shutdown()

static void Ogre::FreeImageCodec2::shutdown ( )

static

Static method to shutdown FreeImage and unregister the FreeImage codecs.

◆ startup()

static void Ogre::FreeImageCodec2::startup ( )

static

Static method to startup FreeImage and register the FreeImage codecs.

◆ validateMagicNumber()

ValidationStatus Ogre::FreeImageCodec2::validateMagicNumber	(	const char *	magicNumberPtr,
		size_t	maxbytes
	)		const

overridevirtual

validateMagicNumber Returns whether a magic number header matches this codec.

At least 4 bytes must be supplied.

Parameters

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

Returns: Validation status.

Implements Ogre::Codec.

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

OgreFreeImageCodec2.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FreeImageCodec2()

◆ ~FreeImageCodec2()

Member Function Documentation

◆ decode()

◆ encode()

◆ encodeBitmap()

◆ encodeToFile()

◆ getType()

◆ magicNumberToFileExt()

◆ shutdown()

◆ startup()

◆ validateMagicNumber()