OGRE  1.12.9
Object-Oriented Graphics Rendering Engine
Ogre::ETCCodec Class Reference

Codec specialized in loading ETC (Ericsson Texture Compression) images. More...

#include <OgreETCCodec.h>

+ Inheritance diagram for Ogre::ETCCodec:

Public Member Functions

 ETCCodec (const String &type)
 
virtual ~ETCCodec ()
 
DecodeResult decode (const DataStreamPtr &input) const override
 
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 ()
 
virtual DecodeResult decode (const DataStreamPtr &input) const
 
virtual void decode (const DataStreamPtr &input, const Any &output) const
 Codes the data from the input chunk into the output chunk. More...
 
void decode (const DataStreamPtr &input, const Any &output) const override
 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
 
String getDataType () const
 
- Public Member Functions inherited from Ogre::Codec
virtual ~Codec ()
 
virtual DataStreamPtr encode (const MemoryDataStreamPtr &input, const CodecDataPtr &pData) const
 
virtual void encodeToFile (const MemoryDataStreamPtr &input, const String &outFileName, const CodecDataPtr &pData) const
 
bool magicNumberMatch (const char *magicNumberPtr, size_t maxbytes) const
 Returns whether a magic number header matches this codec. More...
 

Static Public Member Functions

static void shutdown (void)
 Static method to shutdown and unregister the ETC codec. More...
 
static void startup (void)
 Static method to startup and register the ETC codec. 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...
 

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

Detailed Description

Codec specialized in loading ETC (Ericsson Texture Compression) images.

Remarks
We implement our own codec here since we need to be able to keep ETC data compressed if the card supports it.

Constructor & Destructor Documentation

◆ ETCCodec()

Ogre::ETCCodec::ETCCodec ( const String type)

◆ ~ETCCodec()

virtual Ogre::ETCCodec::~ETCCodec ( )
inlinevirtual

Member Function Documentation

◆ decode() [1/2]

DecodeResult Ogre::ETCCodec::decode ( const DataStreamPtr input) const
overridevirtual
Deprecated:

Reimplemented from Ogre::Codec.

◆ magicNumberToFileExt()

String Ogre::ETCCodec::magicNumberToFileExt ( const char *  magicNumberPtr,
size_t  maxbytes 
) const
overridevirtual

Maps a magic number header to a file extension, if this codec recognises it.

Parameters
magicNumberPtrPointer 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.
maxbytesThe number of bytes passed
Returns
A blank string if the magic number was unknown, or a file extension.

Implements Ogre::Codec.

◆ getType()

String Ogre::ETCCodec::getType ( ) const
overridevirtual

Returns the type of the codec as a String.

Implements Ogre::Codec.

◆ startup()

static void Ogre::ETCCodec::startup ( void  )
static

Static method to startup and register the ETC codec.

◆ shutdown()

static void Ogre::ETCCodec::shutdown ( void  )
static

Static method to shutdown and unregister the ETC codec.

◆ decode() [2/2]

void Ogre::ImageCodec::decode
override

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