OGRE  1.12.8
Object-Oriented Graphics Rendering Engine
Ogre::DDSCodec Class Reference

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

#include <OgreDDSCodec.h>

+ Inheritance diagram for Ogre::DDSCodec:

Public Member Functions

 DDSCodec ()
 
virtual ~DDSCodec ()
 
DecodeResult decode (const DataStreamPtr &input) const
 Codes the data from the input chunk into the output chunk. More...
 
void encodeToFile (const MemoryDataStreamPtr &input, const String &outFileName, const CodecDataPtr &pData) const
 Codes the data in the input chunk and saves the result in the output filename provided. More...
 
virtual String getType () const
 Returns the type of the codec as a String. 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...
 
- Public Member Functions inherited from Ogre::ImageCodec
virtual ~ImageCodec ()
 
String getDataType () const
 
- Public Member Functions inherited from Ogre::Codec
virtual ~Codec ()
 
virtual DataStreamPtr encode (const MemoryDataStreamPtr &input, const CodecDataPtr &pData) const
 Codes the data in the input stream and saves the result in the output stream. More...
 
bool magicNumberMatch (const char *magicNumberPtr, size_t maxbytes) const
 Returns whether a magic number header matches this codec. More...
 

Static Public Member Functions

static void shutdown (void)
 Static method to shutdown and unregister the DDS codec. More...
 
static void startup (void)
 Static method to startup and register the DDS codec. More...
 
- Static Public Member Functions inherited from Ogre::Codec
static CodecgetCodec (char *magicNumberPtr, size_t maxbytes)
 Gets the codec that can handle the given 'magic' identifier. More...
 
static CodecgetCodec (const String &extension)
 Gets the codec registered for the passed in file extension. More...
 
static CodecIterator getCodecIterator (void)
 
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...
 

Additional Inherited Members

- Public Types inherited from Ogre::Codec
typedef SharedPtr< CodecDataCodecDataPtr
 
typedef ConstMapIterator< CodecList > CodecIterator
 
typedef std::pair< MemoryDataStreamPtr, CodecDataPtrDecodeResult
 Result of a decoding; both a decoded data stream and CodecData metadata. More...
 

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.

Constructor & Destructor Documentation

◆ DDSCodec()

Ogre::DDSCodec::DDSCodec ( )

◆ ~DDSCodec()

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

Member Function Documentation

◆ encodeToFile()

void Ogre::DDSCodec::encodeToFile ( const MemoryDataStreamPtr input,
const String outFileName,
const 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)

Reimplemented from Ogre::Codec.

◆ decode()

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

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

Parameters
inputStream containing the encoded data

Implements Ogre::Codec.

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

◆ getType()

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

Returns the type of the codec as a String.

Implements Ogre::Codec.

◆ startup()

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

Static method to startup and register the DDS codec.

◆ shutdown()

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

Static method to shutdown and unregister the DDS codec.


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