OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::PVRTCCodec Class Reference

Codec specialized in loading PVRTC (PowerVR) images. More...

#include <OgrePVRTCCodec.h>

+ Inheritance diagram for Ogre::PVRTCCodec:
+ Collaboration diagram for Ogre::PVRTCCodec:

Public Types

typedef SharedPtr< CodecDataCodecDataPtr
 
typedef ConstMapIterator
< CodecList
CodecIterator
 
typedef std::pair
< MemoryDataStreamPtr,
CodecDataPtr
DecodeResult
 Result of a decoding; both a decoded data stream and CodecData metadata. More...
 

Public Member Functions

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

Static Public Member Functions

static CodecgetCodec (const String &extension)
 Gets the codec registered for the passed in file extension. More...
 
static CodecgetCodec (char *magicNumberPtr, size_t maxbytes)
 Gets the codec that can handle the given 'magic' identifier. More...
 
static CodecIterator getCodecIterator (void)
 Gets the iterator for the registered codecs. 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 shutdown (void)
 Static method to shutdown and unregister the PVRTC codec. More...
 
static void startup (void)
 Static method to startup and register the PVRTC codec. More...
 
static void unregisterCodec (Codec *pCodec)
 Unregisters a codec from the database. More...
 

Protected Types

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

Protected Member Functions

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

Protected Attributes

String mType
 

Static Protected Attributes

static PVRTCCodecmsInstance
 Single registered codec instance. More...
 
static CodecList msMapCodecs
 A map that contains all the registered codecs. More...
 

Private Member Functions

DecodeResult decodeV2 (DataStreamPtr &stream) const
 Decode PVRTCV2 image format. More...
 
DecodeResult decodeV3 (DataStreamPtr &stream) const
 Decode PVRTCV3 image format. More...
 

Detailed Description

Codec specialized in loading PVRTC (PowerVR) images.

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

Definition at line 46 of file OgrePVRTCCodec.h.

Member Typedef Documentation

Definition at line 72 of file OgreCodec.h.

Definition at line 74 of file OgreCodec.h.

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

Definition at line 57 of file OgreCodec.h.

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

Definition at line 139 of file OgreCodec.h.

Constructor & Destructor Documentation

Ogre::PVRTCCodec::PVRTCCodec ( )
virtual Ogre::PVRTCCodec::~PVRTCCodec ( )
inlinevirtual

Definition at line 59 of file OgrePVRTCCodec.h.

Member Function Documentation

DecodeResult Ogre::PVRTCCodec::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.

DecodeResult Ogre::PVRTCCodec::decodeV2 ( DataStreamPtr stream) const
private

Decode PVRTCV2 image format.

DecodeResult Ogre::PVRTCCodec::decodeV3 ( DataStreamPtr stream) const
private

Decode PVRTCV3 image format.

DataStreamPtr Ogre::PVRTCCodec::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.

void Ogre::PVRTCCodec::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.

void Ogre::PVRTCCodec::flipEndian ( void *  pData,
size_t  size,
size_t  count 
) const
protected
void Ogre::PVRTCCodec::flipEndian ( void *  pData,
size_t  size 
) const
protected
static Codec* Ogre::Codec::getCodec ( const String extension)
staticinherited

Gets the codec registered for the passed in file extension.

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
static CodecIterator Ogre::Codec::getCodecIterator ( void  )
inlinestaticinherited

Gets the iterator for the registered codecs.

Definition at line 106 of file OgreCodec.h.

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

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.

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

Gets the file extension list for the registered codecs.

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

Returns the type of the codec as a String.

Implements Ogre::Codec.

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

Return whether a codec is registered already.

Definition at line 93 of file OgreCodec.h.

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

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 159 of file OgreCodec.h.

String Ogre::PVRTCCodec::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.

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

Definition at line 96 of file OgreMemoryAllocatedObject.h.

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

Definition at line 102 of file OgreMemoryAllocatedObject.h.

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

Definition at line 108 of file OgreMemoryAllocatedObject.h.

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

Definition at line 113 of file OgreMemoryAllocatedObject.h.

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

Definition at line 119 of file OgreMemoryAllocatedObject.h.

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

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

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

Definition at line 73 of file OgreMemoryAllocatedObject.h.

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

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

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

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

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

Definition at line 91 of file OgreMemoryAllocatedObject.h.

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

Registers a new codec in the database.

Definition at line 81 of file OgreCodec.h.

References Ogre::Exception::ERR_DUPLICATE_ITEM, Ogre::Codec::getType(), and OGRE_EXCEPT.

static void Ogre::PVRTCCodec::shutdown ( void  )
static

Static method to shutdown and unregister the PVRTC codec.

static void Ogre::PVRTCCodec::startup ( void  )
static

Static method to startup and register the PVRTC codec.

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

Unregisters a codec from the database.

Definition at line 100 of file OgreCodec.h.

References Ogre::Codec::getType().

Member Data Documentation

PVRTCCodec* Ogre::PVRTCCodec::msInstance
staticprotected

Single registered codec instance.

Definition at line 55 of file OgrePVRTCCodec.h.

CodecList Ogre::Codec::msMapCodecs
staticprotectedinherited

A map that contains all the registered codecs.

Definition at line 60 of file OgreCodec.h.

String Ogre::PVRTCCodec::mType
protected

Definition at line 49 of file OgrePVRTCCodec.h.


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