Ogre::STBIImageCodec Class Reference

#include <OgreSTBICodec.h>

Inheritance diagram for Ogre::STBIImageCodec:

Public Member Functions
	STBIImageCodec (const String &type)
virtual	~STBIImageCodec ()
void	decode (const DataStreamPtr &input, const Any &output) const override
	Codes the data from the input chunk into the output chunk. More...
DataStreamPtr	encode (const Any &input) const override
	Codes the input and saves the result in the output stream. 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...
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=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...
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...
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...

Static Public Member Functions
static _OgreSTBICodecExport void	shutdown (void)
	Static method to shutdown and unregister the codecs. More...
static _OgreSTBICodecExport void	startup (void)
	Static method to startup and register the 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 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::ImageCodec
typedef SharedPtr< ImageData >	CodecDataPtr
typedef std::pair< MemoryDataStreamPtr, CodecDataPtr >	DecodeResult
	Result of a decoding; both a decoded data stream and CodecData metadata. More...

Constructor & Destructor Documentation

STBIImageCodec()

Ogre::STBIImageCodec::STBIImageCodec

(

const String &

type

)

~STBIImageCodec()

virtual Ogre::STBIImageCodec::~STBIImageCodec ( )

inlinevirtual

Member Function Documentation

encode()

DataStreamPtr Ogre::STBIImageCodec::encode ( const Any &  input ) const

overridevirtual

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

Reimplemented from Ogre::ImageCodec.

encodeToFile()

void Ogre::STBIImageCodec::encodeToFile ( const Any &  input, const String &  outFileName  ) 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 (codec type specific)
outFileName	The filename to write to

Reimplemented from Ogre::ImageCodec.

decode()

void Ogre::STBIImageCodec::decode ( const DataStreamPtr &  input, const Any &  output  ) const

overridevirtual

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

Parameters

input	Stream containing the encoded data
output	codec type specific result

Reimplemented from Ogre::ImageCodec.

getType()

String Ogre::STBIImageCodec::getType ( ) const

overridevirtual

Returns the type of the codec as a String.

Implements Ogre::Codec.

magicNumberToFileExt()

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

startup()

static _OgreSTBICodecExport void Ogre::STBIImageCodec::startup ( void  )

static

Static method to startup and register the codecs.

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

shutdown()

static _OgreSTBICodecExport void Ogre::STBIImageCodec::shutdown ( void  )

static

Static method to shutdown and unregister the codecs.

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

---

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

• OgreSTBICodec.h