Ogre::ImageCodec Class Referenceabstract
Core » Image

Codec specialized in images. More...

`#include <OgreImageCodec.h>`

Inheritance diagram for Ogre::ImageCodec:
[legend]

## Classes

class | ImageData
| Codec return class for images. More...

## Public Types

typedef SharedPtr< CodecData > | CodecDataPtr
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

virtual | ~ImageCodec ()
virtual DecodeResult | decode (DataStreamPtr &input) const =0
| Codes the data from the input chunk into the output chunk. More...
virtual DataStreamPtr | encode (MemoryDataStreamPtr &input, CodecDataPtr &pData) const =0
| Codes the data in the input stream and saves the result in the output stream. More...
virtual void | encodeToFile (MemoryDataStreamPtr &input, const String &outFileName, CodecDataPtr &pData) const =0
| 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 =0
| 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...
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...
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 Codec * | getCodec (const String &extension)
| Gets the codec registered for the passed in file extension. More...
static Codec * | getCodec (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 | unregisterCodec (Codec *pCodec)
| Unregisters a codec from the database. More...

## Protected Types

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

## Static Protected Attributes

static CodecList | msMapCodecs
| A map that contains all the registered codecs. More...

## Detailed Description

Codec specialized in images.

Remarks
  The users implementing subclasses of ImageCodec are required to return a valid pointer to a ImageData class from the decode(...) function.

Definition at line 47 of file OgreImageCodec.h.

## Member Typedef Documentation

## CodecDataPtr

typedef SharedPtr<CodecData> Ogre::Codec::CodecDataPtr

inherited

Definition at line 74 of file OgreCodec.h.

## CodecIterator

typedef ConstMapIterator<CodecList> Ogre::Codec::CodecIterator

inherited

Definition at line 76 of file OgreCodec.h.

## CodecList

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

protected inherited

Definition at line 59 of file OgreCodec.h.

## DecodeResult

typedef std::pair<MemoryDataStreamPtr, CodecDataPtr> Ogre::Codec::DecodeResult

inherited

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

Definition at line 141 of file OgreCodec.h.

## Constructor & Destructor Documentation

## ~ImageCodec()

virtual Ogre::ImageCodec::~ImageCodec | ( |  | ) |

virtual

## Member Function Documentation

## decode()

virtual DecodeResult Ogre::Codec::decode | ( | DataStreamPtr & | input | ) | const

pure virtual inherited

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

Parameters

  input | Stream containing the encoded data

Implemented in Ogre::DDSCodec, Ogre::FreeImageCodec, Ogre::ETCCodec, and Ogre::PVRTCCodec.

## encode()

virtual DataStreamPtr Ogre::Codec::encode | ( | MemoryDataStreamPtr & | input,
|  | CodecDataPtr & | pData
| ) |  | const

pure virtual inherited

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

Implemented in Ogre::DDSCodec, Ogre::FreeImageCodec, Ogre::ETCCodec, and Ogre::PVRTCCodec.

## encodeToFile()

virtual void Ogre::Codec::encodeToFile | ( | MemoryDataStreamPtr & | input,
|  | const String & | outFileName,
|  | CodecDataPtr & | pData
| ) |  | const

pure virtual inherited

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)

Implemented in Ogre::DDSCodec, Ogre::FreeImageCodec, Ogre::ETCCodec, and Ogre::PVRTCCodec.

## getCodec() [1/2]

static Codec* Ogre::Codec::getCodec | ( | const String & | extension | ) |

static inherited

Gets the codec registered for the passed in file extension.

## getCodec() [2/2]

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

static inherited

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()

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

static inherited

Gets the iterator for the registered codecs.

Definition at line 108 of file OgreCodec.h.

## getDataType()

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

virtual

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

static inherited

Gets the file extension list for the registered codecs.

## getType()

virtual String Ogre::Codec::getType | ( |  | ) | const

pure virtual inherited

Returns the type of the codec as a String.

Implemented in Ogre::DDSCodec, Ogre::FreeImageCodec, Ogre::ETCCodec, and Ogre::PVRTCCodec.

Referenced by Ogre::Codec::registerCodec(), and Ogre::Codec::unregisterCodec().

## isCodecRegistered()

static bool Ogre::Codec::isCodecRegistered | ( | const String & | codecType | ) |

static inherited

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

virtual inherited

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()

virtual String Ogre::Codec::magicNumberToFileExt | ( | const char * | magicNumberPtr,
|  | size_t | maxbytes
| ) |  | const

pure virtual inherited

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.

Implemented in Ogre::DDSCodec, Ogre::FreeImageCodec, Ogre::ETCCodec, and Ogre::PVRTCCodec.

## 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,
|  | void * |
| ) |  |

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

## operator delete() [3/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[]() [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,
|  | 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() [2/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) |

inherited

Definition at line 73 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,
|  | const char * | file,
|  | int | line,
|  | const char * | func
| ) |  |

inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

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

template<class Alloc >

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

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

## registerCodec()

static void Ogre::Codec::registerCodec | ( | Codec * | pCodec | ) |

static inherited

Registers a new codec in the database.

Definition at line 83 of file OgreCodec.h.

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

## unregisterCodec()

static void Ogre::Codec::unregisterCodec | ( | Codec * | pCodec | ) |

static inherited

Unregisters a codec from the database.

Definition at line 102 of file OgreCodec.h.

References Ogre::Codec::getType().

## Member Data Documentation

## msMapCodecs

CodecList Ogre::Codec::msMapCodecs

static protected inherited

A map that contains all the registered codecs.

Definition at line 62 of file OgreCodec.h.

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

- OgreImageCodec.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.