OGRE
13.6
Object-Oriented Graphics Rendering Engine
|
Codec specialized in images. More...
#include <OgreImageCodec.h>
Classes | |
class | ImageData |
Codec return class for images. More... | |
Public Types | |
typedef SharedPtr< ImageData > | CodecDataPtr |
typedef std::pair< MemoryDataStreamPtr, CodecDataPtr > | DecodeResult |
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 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... | |
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.
typedef std::pair<MemoryDataStreamPtr, CodecDataPtr> Ogre::ImageCodec::DecodeResult |
Result of a decoding; both a decoded data stream and CodecData metadata.
|
virtual |
|
overridevirtual |
Codes the data from the input chunk into the output chunk.
input | Stream containing the encoded data |
output | codec type specific result |
Implements Ogre::Codec.
Reimplemented in Ogre::STBIImageCodec, Ogre::RsImageCodec, Ogre::FreeImageCodec, and Ogre::EXRCodec.
|
overridevirtual |
Codes the input and saves the result in the output stream.
Reimplemented from Ogre::Codec.
Reimplemented in Ogre::STBIImageCodec, Ogre::RsImageCodec, and Ogre::FreeImageCodec.
|
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.
input | The input data (codec type specific) |
outFileName | The filename to write to |
Reimplemented from Ogre::Codec.
Reimplemented in Ogre::STBIImageCodec, Ogre::RsImageCodec, and Ogre::FreeImageCodec.
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
virtual void Ogre::Codec::decode |
Codes the data from the input chunk into the output chunk.
input | Stream containing the encoded data |
output | codec type specific result |
virtual DataStreamPtr Ogre::Codec::encode |
Codes the input and saves the result in the output stream.
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.
input | The input data (codec type specific) |
outFileName | The filename to write to |