Codec specialized in loading ETC (Ericsson Texture Compression) images.
More...
#include <OgreETCCodec.h>
|
| ETCCodec (const String &type) |
|
virtual | ~ETCCodec () |
|
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) |
|
|
void | flipEndian (void *pData, size_t size, size_t count) const |
|
void | flipEndian (void *pData, size_t size) const |
|
Codec specialized in loading ETC (Ericsson Texture Compression) images.
Definition at line 46 of file OgreETCCodec.h.
§ CodecDataPtr
§ CodecIterator
§ CodecList
§ DecodeResult
Result of a decoding; both a decoded data stream and CodecData metadata.
Definition at line 141 of file OgreCodec.h.
§ ETCCodec()
Ogre::ETCCodec::ETCCodec |
( |
const String & |
type | ) |
|
§ ~ETCCodec()
virtual Ogre::ETCCodec::~ETCCodec |
( |
| ) |
|
|
virtual |
§ decode()
Codes the data from the input chunk into the output chunk.
- Parameters
-
input | Stream containing the encoded data |
Implements Ogre::Codec.
§ decodeKTX()
§ decodePKM()
§ encode()
Codes the data in the input stream and saves the result in the output stream.
Implements 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.
- Parameters
-
input | The input data |
outFileName | The filename to write to |
pData | Extra information to be passed to the codec (codec type specific) |
Implements Ogre::Codec.
§ flipEndian() [1/2]
void Ogre::ETCCodec::flipEndian |
( |
void * |
pData, |
|
|
size_t |
size, |
|
|
size_t |
count |
|
) |
| const |
|
protected |
§ flipEndian() [2/2]
void Ogre::ETCCodec::flipEndian |
( |
void * |
pData, |
|
|
size_t |
size |
|
) |
| const |
|
protected |
§ getCodec() [1/2]
static Codec* Ogre::Codec::getCodec |
( |
const String & |
extension | ) |
|
|
staticinherited |
Gets the codec registered for the passed in file extension.
§ getCodec() [2/2]
static Codec* Ogre::Codec::getCodec |
( |
char * |
magicNumberPtr, |
|
|
size_t |
maxbytes |
|
) |
| |
|
staticinherited |
Gets the codec that can handle the given 'magic' identifier.
- Parameters
-
magicNumberPtr | Pointer 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. |
maxbytes | The number of bytes passed |
§ getCodecIterator()
Gets the iterator for the registered codecs.
Definition at line 108 of file OgreCodec.h.
§ getDataType()
String Ogre::ImageCodec::getDataType |
( |
| ) |
const |
|
virtualinherited |
§ getExtensions()
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
-
magicNumberPtr | Pointer 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. |
maxbytes | The 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
-
magicNumberPtr | Pointer 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. |
maxbytes | The 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]
§ operator delete() [2/3]
§ operator delete() [3/3]
§ operator delete[]() [1/2]
§ operator delete[]() [2/2]
§ operator new() [1/3]
template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new |
( |
size_t |
sz, |
|
|
const char * |
file, |
|
|
int |
line, |
|
|
const char * |
func |
|
) |
| |
|
inherited |
§ operator new() [2/3]
§ operator new() [3/3]
§ operator new[]() [1/2]
template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] |
( |
size_t |
sz, |
|
|
const char * |
file, |
|
|
int |
line, |
|
|
const char * |
func |
|
) |
| |
|
inherited |
§ operator new[]() [2/2]
§ registerCodec()
static void Ogre::Codec::registerCodec |
( |
Codec * |
pCodec | ) |
|
|
staticinherited |
§ 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 |
§ msKTXInstance
§ msMapCodecs
A map that contains all the registered codecs.
Definition at line 62 of file OgreCodec.h.
§ msPKMInstance
§ mType
The documentation for this class was generated from the following file: