OGRE  1.12.8
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 Member Functions

virtual ~ImageCodec ()
 
String getDataType () const
 
- Public Member Functions inherited from Ogre::Codec
virtual ~Codec ()
 
virtual DecodeResult decode (const DataStreamPtr &input) const =0
 Codes the data from the input chunk into the output chunk. More...
 
virtual DataStreamPtr encode (const MemoryDataStreamPtr &input, const CodecDataPtr &pData) const
 Codes the data in the input stream and saves the result in the output stream. More...
 
virtual void encodeToFile (const MemoryDataStreamPtr &input, const String &outFileName, const CodecDataPtr &pData) const
 Codes the data in the input chunk and saves the result in the output filename provided. More...
 
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

- Public Types inherited from Ogre::Codec
typedef SharedPtr< CodecDataCodecDataPtr
 
typedef ConstMapIterator< CodecList > CodecIterator
 
typedef std::pair< MemoryDataStreamPtr, CodecDataPtrDecodeResult
 Result of a decoding; both a decoded data stream and CodecData metadata. More...
 
- 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 CodecIterator getCodecIterator (void)
 
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.

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

◆ ~ImageCodec()

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

Member Function Documentation

◆ getDataType()

String Ogre::ImageCodec::getDataType ( ) const
inlinevirtual
Deprecated:
do not use

Implements Ogre::Codec.


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