OGRE  1.9.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Member Functions | List of all members
Ogre::ETCCodec Class Reference

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

#include <OgreETCCodec.h>

Inheritance diagram for Ogre::ETCCodec:
Inheritance graph
[legend]

Public Types

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

Public Member Functions

 ETCCodec (const String &type)
 
virtual ~ETCCodec ()
 
DecodeResult decode (DataStreamPtr &input) const
 Codes the data from the input chunk into the output chunk.
 
DataStreamPtr encode (MemoryDataStreamPtr &input, CodecDataPtr &pData) const
 Codes the data in the input stream and saves the result in the output stream.
 
void encodeToFile (MemoryDataStreamPtr &input, const String &outFileName, CodecDataPtr &pData) const
 Codes the data in the input chunk and saves the result in the output filename provided.
 
String getDataType () const
 Returns the type of the data that supported by this codec as a String.
 
virtual String getType () const
 Returns the type of the codec as a String.
 
virtual bool magicNumberMatch (const char *magicNumberPtr, size_t maxbytes) const
 Returns whether a magic number header matches this codec.
 
String magicNumberToFileExt (const char *magicNumberPtr, size_t maxbytes) const
 Maps a magic number header to a file extension, if this codec recognises it.
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete (void *ptr, void *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info
 
voidoperator new (size_t sz, void *ptr)
 placement operator new
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info
 

Static Public Member Functions

static CodecgetCodec (char *magicNumberPtr, size_t maxbytes)
 Gets the codec that can handle the given 'magic' identifier.
 
static CodecgetCodec (const String &extension)
 Gets the codec registered for the passed in file extension.
 
static CodecIterator getCodecIterator (void)
 Gets the iterator for the registered codecs.
 
static StringVector getExtensions (void)
 Gets the file extension list for the registered codecs.
 
static bool isCodecRegistered (const String &codecType)
 Return whether a codec is registered already.
 
static void registerCodec (Codec *pCodec)
 Registers a new codec in the database.
 
static void shutdown (void)
 Static method to shutdown and unregister the ETC codec.
 
static void startup (void)
 Static method to startup and register the ETC codec.
 
static void unregisterCodec (Codec *pCodec)
 Unregisters a codec from the database.
 

Protected Types

typedef map< String, Codec * >::type CodecList
 

Static Protected Member Functions

static void flipEndian (void *pData, size_t size)
 
static void flipEndian (void *pData, size_t size, size_t count)
 

Protected Attributes

String mType
 

Static Protected Attributes

static ETCCodecmsKTXInstance
 
static CodecList msMapCodecs
 A map that contains all the registered codecs.
 
static ETCCodecmsPKMInstance
 Single registered codec instance.
 

Private Member Functions

bool decodeKTX (DataStreamPtr &input, DecodeResult &result) const
 
bool decodePKM (DataStreamPtr &input, DecodeResult &result) const
 

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.

Definition at line 46 of file OgreETCCodec.h.

Member Typedef Documentation

◆ CodecDataPtr

Definition at line 74 of file OgreCodec.h.

◆ CodecIterator

Definition at line 76 of file OgreCodec.h.

◆ CodecList

typedef map<String,Codec*>::type Ogre::Codec::CodecList
protectedinherited

Definition at line 59 of file OgreCodec.h.

◆ DecodeResult

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

Definition at line 141 of file OgreCodec.h.

Constructor & Destructor Documentation

◆ ETCCodec()

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

◆ ~ETCCodec()

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

Definition at line 60 of file OgreETCCodec.h.

Member Function Documentation

◆ decode()

DecodeResult Ogre::ETCCodec::decode ( DataStreamPtr input) const
virtual

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

Parameters
inputStream containing the encoded data

Implements Ogre::Codec.

◆ decodeKTX()

bool Ogre::ETCCodec::decodeKTX ( DataStreamPtr input,
DecodeResult result 
) const
private

◆ decodePKM()

bool Ogre::ETCCodec::decodePKM ( DataStreamPtr input,
DecodeResult result 
) const
private

◆ encode()

DataStreamPtr Ogre::ETCCodec::encode ( MemoryDataStreamPtr input,
CodecDataPtr pData 
) const
virtual

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

Implements Ogre::Codec.

◆ encodeToFile()

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

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
outFileNameThe filename to write to
pDataExtra information to be passed to the codec (codec type specific)

Implements Ogre::Codec.

◆ flipEndian() [1/2]

static void Ogre::ETCCodec::flipEndian ( void pData,
size_t  size 
)
staticprotected

◆ flipEndian() [2/2]

static void Ogre::ETCCodec::flipEndian ( void pData,
size_t  size,
size_t  count 
)
staticprotected

◆ getCodec() [1/2]

static Codec * Ogre::Codec::getCodec ( char magicNumberPtr,
size_t  maxbytes 
)
staticinherited

Gets the codec that can handle the given 'magic' identifier.

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

◆ getCodec() [2/2]

static Codec * Ogre::Codec::getCodec ( const String extension)
staticinherited

Gets the codec registered for the passed in file extension.

◆ getCodecIterator()

static CodecIterator Ogre::Codec::getCodecIterator ( void  )
staticinherited

Gets the iterator for the registered codecs.

Definition at line 108 of file OgreCodec.h.

◆ getDataType()

String Ogre::ImageCodec::getDataType ( ) const
virtualinherited

Returns the type of the data that supported by this codec as a String.

Implements Ogre::Codec.

Definition at line 79 of file OgreImageCodec.h.

◆ getExtensions()

static StringVector Ogre::Codec::getExtensions ( void  )
staticinherited

Gets the file extension list for the registered codecs.

◆ getType()

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

Returns the type of the codec as a String.

Implements Ogre::Codec.

◆ isCodecRegistered()

static bool Ogre::Codec::isCodecRegistered ( const String codecType)
staticinherited

Return whether a codec is registered already.

Definition at line 95 of file OgreCodec.h.

◆ magicNumberMatch()

virtual bool Ogre::Codec::magicNumberMatch ( const char magicNumberPtr,
size_t  maxbytes 
) const
virtualinherited

Returns whether a magic number header matches this codec.

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

Definition at line 161 of file OgreCodec.h.

◆ magicNumberToFileExt()

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

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.

◆ operator delete() [1/3]

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void ptr)
inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

◆ operator delete() [2/3]

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void ptr,
const char ,
int  ,
const char  
)
inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

◆ operator delete() [3/3]

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void ptr,
void  
)
inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

◆ operator delete[]() [1/2]

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void ptr)
inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

◆ operator delete[]() [2/2]

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void ptr,
const char ,
int  ,
const char  
)
inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

◆ operator new() [1/3]

template<class Alloc >
void * Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

◆ operator new() [2/3]

template<class Alloc >
void * Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char file,
int  line,
const char func 
)
inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

◆ operator new() [3/3]

template<class Alloc >
void * Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void ptr 
)
inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

◆ operator new[]() [1/2]

template<class Alloc >
void * Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

◆ operator new[]() [2/2]

template<class Alloc >
void * Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char file,
int  line,
const char func 
)
inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

◆ registerCodec()

static void Ogre::Codec::registerCodec ( Codec pCodec)
staticinherited

Registers a new codec in the database.

Definition at line 83 of file OgreCodec.h.

References OGRE_EXCEPT.

◆ shutdown()

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

Static method to shutdown and unregister the ETC codec.

◆ startup()

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

Static method to startup and register the ETC codec.

◆ unregisterCodec()

static void Ogre::Codec::unregisterCodec ( Codec pCodec)
staticinherited

Unregisters a codec from the database.

Definition at line 102 of file OgreCodec.h.

Member Data Documentation

◆ msKTXInstance

ETCCodec* Ogre::ETCCodec::msKTXInstance
staticprotected

Definition at line 56 of file OgreETCCodec.h.

◆ msMapCodecs

CodecList Ogre::Codec::msMapCodecs
staticprotectedinherited

A map that contains all the registered codecs.

Definition at line 62 of file OgreCodec.h.

◆ msPKMInstance

ETCCodec* Ogre::ETCCodec::msPKMInstance
staticprotected

Single registered codec instance.

Definition at line 55 of file OgreETCCodec.h.

◆ mType

String Ogre::ETCCodec::mType
protected

Definition at line 49 of file OgreETCCodec.h.


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