OGRE 2.1
Object-Oriented Graphics Rendering Engine
Loading...
Searching...
No Matches
Ogre::DDSCodec Class Reference

Codec specialized in loading DDS (Direct Draw Surface) images. More...

#include <OgreDDSCodec.h>

+ Inheritance diagram for Ogre::DDSCodec:

Public Types

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

Public Member Functions

 DDSCodec ()
 
virtual ~DDSCodec ()
 
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 DDS codec.
 
static void startup (void)
 Static method to startup and register the DDS codec.
 
static void unregisterCodec (Codec *pCodec)
 Unregisters a codec from the database.
 

Detailed Description

Codec specialized in loading DDS (Direct Draw Surface) images.

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

Member Typedef Documentation

◆ CodecDataPtr

◆ CodecIterator

◆ DecodeResult

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

Constructor & Destructor Documentation

◆ DDSCodec()

Ogre::DDSCodec::DDSCodec ( )

◆ ~DDSCodec()

virtual Ogre::DDSCodec::~DDSCodec ( )
inlinevirtual

Member Function Documentation

◆ decode()

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

◆ encode()

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

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

Gets the iterator for the registered codecs.

◆ getDataType()

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

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

Implements Ogre::Codec.

◆ getExtensions()

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

Gets the file extension list for the registered codecs.

◆ getType()

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

Returns the type of the codec as a String.

Implements Ogre::Codec.

◆ isCodecRegistered()

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

Return whether a codec is registered already.

◆ magicNumberMatch()

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

◆ magicNumberToFileExt()

String Ogre::DDSCodec::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)
inlineinherited

◆ operator delete() [2/3]

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

◆ operator delete() [3/3]

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

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

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

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

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

◆ operator new() [1/3]

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

◆ operator new() [2/3]

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

◆ operator new() [3/3]

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

placement operator new

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

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

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

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

◆ registerCodec()

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

Registers a new codec in the database.

References Ogre::Exception::ERR_DUPLICATE_ITEM, and OGRE_EXCEPT.

◆ shutdown()

static void Ogre::DDSCodec::shutdown ( void  )
static

Static method to shutdown and unregister the DDS codec.

◆ startup()

static void Ogre::DDSCodec::startup ( void  )
static

Static method to startup and register the DDS codec.

◆ unregisterCodec()

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

Unregisters a codec from the database.


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