Codec specialized in images. More...

#include <OgreImageCodec2.h>

Inheritance diagram for Ogre::ImageCodec2:

Classes
class	ImageData2
	Codec return class for images. More...

Public Member Functions
	~ImageCodec2 () override

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

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

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

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

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

virtual String	getType () const =0
	Returns the type of the codec as a String.

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

virtual String	magicNumberToFileExt (const char *magicNumberPtr, size_t maxbytes) const =0
	Maps a magic number header to a file extension, if this codec recognises it.

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

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.

enum	ValidationStatus { CodecValid , CodecInvalid , CodecUnknown }

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.

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

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

static StringVector	getExtensions ()
	Gets the file extension list for the registered codecs.

static bool	isCodecRegistered (const String &codecType)
	Return whether a codec is registered already.

static void	registerCodec (Codec *pCodec)
	Registers a new codec in the database.

static void	unregisterCodec (Codec *pCodec)
	Unregisters a codec from the database.

Detailed Description

Codec specialized in images.

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

Constructor & Destructor Documentation

Ogre::ImageCodec2::~ImageCodec2 ( )

override

String Ogre::ImageCodec2::getDataType ( ) const

inlineoverridevirtual

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

Implements Ogre::Codec.

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