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

#include <OgreDDSCodec.h>

Inheritance diagram for Ogre::DDSCodec:

[legend]

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
	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 *)
void *	operator new (size_t sz)
void *	operator new (size_t sz, const char file, int line, const char func)
	operator new, with debug line info
void *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz)
void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info

Static Public Member Functions
static Codec *	getCodec (char *magicNumberPtr, size_t maxbytes)
	Gets the codec that can handle the given 'magic' identifier.
static Codec *	getCodec (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.

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

Static Protected Attributes
static CodecList	msMapCodecs
	A map that contains all the registered codecs.

Private Member Functions
PixelFormat	convertDXToOgreFormat (uint32 fourcc) const
PixelFormat	convertFourCCFormat (uint32 fourcc) const
PixelFormat	convertPixelFormat (uint32 rgbBits, uint32 rMask, uint32 gMask, uint32 bMask, uint32 aMask) const
void	flipEndian (void *pData, size_t size) const
void	flipEndian (void *pData, size_t size, size_t count) const
void	unpackDXTAlpha (const DXTExplicitAlphaBlock &block, ColourValue *pCol) const
	Unpack DXT alphas into array of 16 colour values.
void	unpackDXTAlpha (const DXTInterpolatedAlphaBlock &block, ColourValue *pCol) const
	Unpack DXT alphas into array of 16 colour values.
void	unpackDXTColour (PixelFormat pf, const DXTColourBlock &block, ColourValue *pCol) const
	Unpack DXT colours into array of 16 colour values.

Private Attributes
String	mType

Static Private Attributes
static DDSCodec *	msInstance
	Single registered codec instance.

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.

Definition at line 50 of file OgreDDSCodec.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

protectedinherited

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

◆ DDSCodec()

Ogre::DDSCodec::DDSCodec ( )

◆ ~DDSCodec()

virtual Ogre::DDSCodec::~DDSCodec ( )

virtual

Definition at line 74 of file OgreDDSCodec.h.

Member Function Documentation

◆ convertDXToOgreFormat()

PixelFormat Ogre::DDSCodec::convertDXToOgreFormat ( uint32 fourcc ) const

private

◆ convertFourCCFormat()

PixelFormat Ogre::DDSCodec::convertFourCCFormat ( uint32 fourcc ) const

private

◆ convertPixelFormat()

PixelFormat Ogre::DDSCodec::convertPixelFormat	(	uint32	rgbBits,
		uint32	rMask,
		uint32	gMask,
		uint32	bMask,
		uint32	aMask ) const

private

◆ decode()

DecodeResult Ogre::DDSCodec::decode ( DataStreamPtr & input ) const

virtual

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

Parameters

input Stream 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

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::DDSCodec::flipEndian	(	void *	pData,
		size_t	size ) const

private

◆ flipEndian() [2/2]

void Ogre::DDSCodec::flipEndian	(	void *	pData,
		size_t	size,
		size_t	count ) const

private

◆ getCodec() [1/2]

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

◆ getCodec() [2/2]

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

staticinherited

Gets the codec registered for the passed in file extension.

◆ getCodecIterator()

CodecIterator Ogre::Codec::getCodecIterator ( void )

staticinherited

Gets the iterator for the registered codecs.

Definition at line 108 of file OgreCodec.h.

References msMapCodecs.

◆ getDataType()

String Ogre::ImageCodec::getDataType ( ) const

virtualinherited

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

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

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

staticinherited

Return whether a codec is registered already.

Definition at line 95 of file OgreCodec.h.

References msMapCodecs.

◆ 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.

References magicNumberToFileExt().

◆ 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

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]

void Ogre::AllocatedObject< GeneralAllocPolicy >::operator delete ( void * ptr )

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

◆ operator delete() [2/3]

void Ogre::AllocatedObject< GeneralAllocPolicy >::operator delete	(	void *	ptr,
		const char *	,
		int	,
		const char *	)

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

◆ operator delete() [3/3]

void Ogre::AllocatedObject< GeneralAllocPolicy >::operator delete	(	void *	ptr,
		void *	)

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

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

void Ogre::AllocatedObject< GeneralAllocPolicy >::operator delete[] ( void * ptr )

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

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

void Ogre::AllocatedObject< GeneralAllocPolicy >::operator delete[]	(	void *	ptr,
		const char *	,
		int	,
		const char *	)

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

◆ operator new() [1/3]

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

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

◆ operator new() [2/3]

void * Ogre::AllocatedObject< GeneralAllocPolicy >::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() [3/3]

void * Ogre::AllocatedObject< GeneralAllocPolicy >::operator new	(	size_t	sz,
		void *	ptr )

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

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

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

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

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

void * Ogre::AllocatedObject< GeneralAllocPolicy >::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.

◆ registerCodec()

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

staticinherited

Registers a new codec in the database.

Definition at line 83 of file OgreCodec.h.

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

◆ shutdown()

void Ogre::DDSCodec::shutdown ( void )

static

Static method to shutdown and unregister the DDS codec.

◆ startup()

void Ogre::DDSCodec::startup ( void )

static

Static method to startup and register the DDS codec.

◆ unpackDXTAlpha() [1/2]

void Ogre::DDSCodec::unpackDXTAlpha	(	const DXTExplicitAlphaBlock &	block,
		ColourValue *	pCol ) const

private

Unpack DXT alphas into array of 16 colour values.

◆ unpackDXTAlpha() [2/2]

void Ogre::DDSCodec::unpackDXTAlpha	(	const DXTInterpolatedAlphaBlock &	block,
		ColourValue *	pCol ) const

private

Unpack DXT alphas into array of 16 colour values.

◆ unpackDXTColour()

void Ogre::DDSCodec::unpackDXTColour	(	PixelFormat	pf,
		const DXTColourBlock &	block,
		ColourValue *	pCol ) const

private

Unpack DXT colours into array of 16 colour values.

◆ unregisterCodec()

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

staticinherited

Unregisters a codec from the database.

Definition at line 102 of file OgreCodec.h.

References getType(), and msMapCodecs.

Member Data Documentation

◆ msInstance

DDSCodec* Ogre::DDSCodec::msInstance

staticprivate

Single registered codec instance.

Definition at line 71 of file OgreDDSCodec.h.

◆ msMapCodecs

CodecList Ogre::Codec::msMapCodecs

staticprotectedinherited

A map that contains all the registered codecs.

Definition at line 62 of file OgreCodec.h.

Referenced by getCodecIterator(), isCodecRegistered(), registerCodec(), and unregisterCodec().

◆ mType

String Ogre::DDSCodec::mType

private

Definition at line 53 of file OgreDDSCodec.h.

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

OgreDDSCodec.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Static Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ CodecDataPtr

◆ CodecIterator

◆ CodecList

◆ DecodeResult

Constructor & Destructor Documentation

◆ DDSCodec()

◆ ~DDSCodec()

Member Function Documentation

◆ convertDXToOgreFormat()

◆ convertFourCCFormat()

◆ convertPixelFormat()

◆ decode()

◆ encode()

◆ encodeToFile()

◆ flipEndian() [1/2]

◆ flipEndian() [2/2]

◆ getCodec() [1/2]

◆ getCodec() [2/2]

◆ getCodecIterator()

◆ getDataType()

◆ getExtensions()

◆ getType()

◆ isCodecRegistered()

◆ magicNumberMatch()

◆ magicNumberToFileExt()

◆ operator delete() [1/3]

◆ operator delete() [2/3]

◆ operator delete() [3/3]

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

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

◆ operator new() [1/3]

◆ operator new() [2/3]

◆ operator new() [3/3]

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

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

◆ registerCodec()

◆ shutdown()

◆ startup()

◆ unpackDXTAlpha() [1/2]

◆ unpackDXTAlpha() [2/2]

◆ unpackDXTColour()

◆ unregisterCodec()

Member Data Documentation

◆ msInstance

◆ msMapCodecs

◆ mType