OGRE  13.4
Object-Oriented Graphics Rendering Engine
Ogre::ImageCodec Class Reference

Codec specialized in images. More...

#include <OgreImageCodec.h>

+ Inheritance diagram for Ogre::ImageCodec:

Classes

class  ImageData
 Codec return class for images. More...
 

Public Types

typedef SharedPtr< ImageDataCodecDataPtr
 
typedef std::pair< MemoryDataStreamPtr, CodecDataPtrDecodeResult
 Result of a decoding; both a decoded data stream and CodecData metadata. More...
 

Public Member Functions

virtual ~ImageCodec ()
 
virtual DecodeResult decode (const DataStreamPtr &input) const
 
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 ()
 
virtual String getType () const =0
 Returns the type of the codec as a String. More...
 
bool magicNumberMatch (const char *magicNumberPtr, size_t maxbytes) const
 Returns whether a magic number header matches this codec. More...
 
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. More...
 

Additional Inherited Members

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

Detailed Description

Codec specialized in images.

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

Member Typedef Documentation

◆ CodecDataPtr

◆ DecodeResult

Result of a decoding; both a decoded data stream and CodecData metadata.

Constructor & Destructor Documentation

◆ ~ImageCodec()

virtual Ogre::ImageCodec::~ImageCodec ( )
virtual

Member Function Documentation

◆ decode() [1/3]

void Ogre::ImageCodec::decode ( const DataStreamPtr input,
const Any output 
) const
overridevirtual

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

Parameters
inputStream containing the encoded data
outputcodec type specific result

Implements Ogre::Codec.

◆ encode() [1/3]

DataStreamPtr Ogre::ImageCodec::encode ( const Any input) const
overridevirtual

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

Reimplemented from Ogre::Codec.

◆ encodeToFile() [1/3]

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

Reimplemented from Ogre::Codec.

◆ encode() [2/3]

virtual DataStreamPtr Ogre::ImageCodec::encode ( const MemoryDataStreamPtr input,
const CodecDataPtr pData 
) const
inlinevirtual
Deprecated:

Reimplemented in Ogre::STBIImageCodec, and Ogre::FreeImageCodec.

References encode().

Referenced by encode().

◆ encodeToFile() [2/3]

virtual void Ogre::ImageCodec::encodeToFile ( const MemoryDataStreamPtr input,
const String outFileName,
const CodecDataPtr pData 
) const
inlinevirtual

◆ decode() [2/3]

virtual DecodeResult Ogre::ImageCodec::decode ( const DataStreamPtr input) const
inlinevirtual

◆ decode() [3/3]

virtual void Ogre::Codec::decode

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

Parameters
inputStream containing the encoded data
outputcodec type specific result

◆ encode() [3/3]

virtual DataStreamPtr Ogre::Codec::encode

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

◆ encodeToFile() [3/3]

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

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