Ogre::EXRCodec Class Reference

#include <OgreEXRCodec.h>

Inheritance diagram for Ogre::EXRCodec:

Public Member Functions
	EXRCodec ()
virtual	~EXRCodec ()
virtual DecodeResult	decode (const DataStreamPtr &input) const
DecodeResult	decode (const DataStreamPtr &input) const override
virtual void	decode (const DataStreamPtr &input, const Any &output) const =0
	Codes the data from the input chunk into the output chunk. More...
void	decode (const DataStreamPtr &input, const Any &output) 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 ()
void	decode (const DataStreamPtr &input, const Any &output) const override
	Codes the data from the input chunk into the output chunk. More...
virtual void	decode (const DataStreamPtr &input, const Any &output) const=0
	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
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...

Additional Inherited Members
Public Types inherited from Ogre::ImageCodec
typedef SharedPtr< ImageData >	CodecDataPtr
typedef std::pair< MemoryDataStreamPtr, CodecDataPtr >	DecodeResult
	Result of a decoding; both a decoded data stream and CodecData metadata. 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 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...

Constructor & Destructor Documentation

EXRCodec()

Ogre::EXRCodec::EXRCodec

(

)

~EXRCodec()

virtual Ogre::EXRCodec::~EXRCodec ( )

virtual

Member Function Documentation

decode() [1/4]

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

overridevirtual

Deprecated:

Reimplemented from Ogre::ImageCodec.

magicNumberToFileExt()

String Ogre::EXRCodec::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.

getType()

String Ogre::EXRCodec::getType ( ) const

overridevirtual

Returns the type of the codec as a String.

Implements Ogre::Codec.

decode() [2/4]

void Ogre::ImageCodec::decode

override

decode() [3/4]

virtual DecodeResult Ogre::ImageCodec::decode

inline

Deprecated:

decode() [4/4]

virtual void Ogre::Codec::decode

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

Parameters

input	Stream containing the encoded data
output	codec type specific result

---

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

• OgreEXRCodec.h