Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

Ogre::EXRCodec Class Reference

Codec specialized in loading OpenEXR high dynamic range images. More...

#include <OgreEXRCodec.h>

Inheritance diagram for Ogre::EXRCodec:

Ogre::ImageCodec Ogre::Codec List of all members.

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.

Public Member Functions

 EXRCodec ()
virtual ~EXRCodec ()
DataStreamPtr code (MemoryDataStreamPtr &input, CodecDataPtr &pData) const
 
void codeToFile (MemoryDataStreamPtr &input, const String &outFileName, CodecDataPtr &pData) const
 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)

DecodeResult decode (DataStreamPtr &input) const
 
Parameters:
input Stream containing the encoded data
Note:
Has a variable number of arguments, which depend on the codec type.

String getType () const
 Returns the type of the codec as a String.
String getDataType () const
 Returns the type of the data that supported by this codec as a String.

Static Public Member Functions

static void registerCodec (Codec *pCodec)
 Registers a new codec in the database.
static void unRegisterCodec (Codec *pCodec)
 Unregisters a codec from the database.
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 CodecgetCodec (const String &extension)
 Gets the codec registered for the passed in file extension.

Protected Types

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

Static Protected Attributes

static CodecList ms_mapCodecs
 A map that contains all the registered codecs.

Detailed Description

Codec specialized in loading OpenEXR high dynamic range images.

Definition at line 35 of file OgreEXRCodec.h.


Member Typedef Documentation

typedef SharedPtr<CodecData> Ogre::Codec::CodecDataPtr [inherited]
 

Definition at line 63 of file OgreCodec.h.

typedef ConstMapIterator<CodecList> Ogre::Codec::CodecIterator [inherited]
 

Definition at line 65 of file OgreCodec.h.

typedef std::map< String, Codec* > Ogre::Codec::CodecList [protected, inherited]
 

Definition at line 48 of file OgreCodec.h.

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

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

Definition at line 110 of file OgreCodec.h.


Constructor & Destructor Documentation

Ogre::EXRCodec::EXRCodec  ) 
 

virtual Ogre::EXRCodec::~EXRCodec  )  [virtual]
 


Member Function Documentation

DataStreamPtr Ogre::EXRCodec::code MemoryDataStreamPtr input,
CodecDataPtr pData
const [virtual]
 

Implements Ogre::Codec.

void Ogre::EXRCodec::codeToFile MemoryDataStreamPtr input,
const String outFileName,
CodecDataPtr pData
const [virtual]
 

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.

DecodeResult Ogre::EXRCodec::decode DataStreamPtr input  )  const [virtual]
 

Parameters:
input Stream containing the encoded data
Note:
Has a variable number of arguments, which depend on the codec type.

Implements Ogre::Codec.

static Codec* Ogre::Codec::getCodec const String extension  )  [static, inherited]
 

Gets the codec registered for the passed in file extension.

static CodecIterator Ogre::Codec::getCodecIterator void   )  [static, inherited]
 

Gets the iterator for the registered codecs.

Definition at line 85 of file OgreCodec.h.

String Ogre::ImageCodec::getDataType  )  const [virtual, inherited]
 

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

Implements Ogre::Codec.

Definition at line 70 of file OgreImageCodec.h.

static StringVector Ogre::Codec::getExtensions void   )  [static, inherited]
 

Gets the file extension list for the registered codecs.

String Ogre::EXRCodec::getType  )  const [virtual]
 

Returns the type of the codec as a String.

Implements Ogre::Codec.

static void Ogre::Codec::registerCodec Codec pCodec  )  [static, inherited]
 

Registers a new codec in the database.

Definition at line 72 of file OgreCodec.h.

References Ogre::Codec::getType().

static void Ogre::Codec::unRegisterCodec Codec pCodec  )  [static, inherited]
 

Unregisters a codec from the database.

Definition at line 79 of file OgreCodec.h.

References Ogre::Codec::getType().


Member Data Documentation

CodecList Ogre::Codec::ms_mapCodecs [static, protected, inherited]
 

A map that contains all the registered codecs.

Definition at line 51 of file OgreCodec.h.


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

Copyright © 2000-2005 by The OGRE Team
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Jul 23 10:11:31 2006