OGRE-Next  3.0.0unstable
Object-Oriented Graphics Rendering Engine
Ogre::ASTCCodec Class Reference

Codec specialized in loading ASTC (ARM Adaptive Scalable Texture Compression) images. More...

#include <OgreASTCCodec.h>

+ Inheritance diagram for Ogre::ASTCCodec:

Public Member Functions

 ASTCCodec ()
 
 ~ASTCCodec () override
 
DecodeResult decode (DataStreamPtr &input) const override
 Codes the data from the input chunk into the output chunk. More...
 
DataStreamPtr encode (MemoryDataStreamPtr &input, CodecDataPtr &pData) const override
 Codes the data in the input stream and saves the result in the output stream. More...
 
void encodeToFile (MemoryDataStreamPtr &input, const String &outFileName, CodecDataPtr &pData) const override
 Codes the data in the input chunk and saves the result in the output filename provided. More...
 
String getType () const override
 Returns the type of the codec as a String. More...
 
String magicNumberToFileExt (const char *magicNumberPtr, size_t maxbytes) const override
 Maps a magic number header to a file extension, if this codec recognises it. More...
 
ValidationStatus validateMagicNumber (const char *magicNumberPtr, size_t maxbytes) const override
 validateMagicNumber Returns whether a magic number header matches this codec. More...
 
- Public Member Functions inherited from Ogre::ImageCodec2
 ~ImageCodec2 () override
 
String getDataType () const override
 Returns the type of the data that supported by this codec as a String. More...
 
- Public Member Functions inherited from Ogre::Codec
virtual ~Codec ()
 
virtual 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 ()
 Static method to shutdown and unregister the ASTC codec. More...
 
static void startup ()
 Static method to startup and register the ASTC 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 ()
 Gets the iterator for the registered codecs. More...
 
static StringVector getExtensions ()
 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...
 
enum  ValidationStatus { CodecValid , CodecInvalid , CodecUnknown }
 

Detailed Description

Codec specialized in loading ASTC (ARM Adaptive Scalable Texture Compression) images.

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

Constructor & Destructor Documentation

◆ ASTCCodec()

Ogre::ASTCCodec::ASTCCodec ( )

◆ ~ASTCCodec()

Ogre::ASTCCodec::~ASTCCodec ( )
inlineoverride

Member Function Documentation

◆ decode()

DecodeResult Ogre::ASTCCodec::decode ( DataStreamPtr input) const
overridevirtual

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

Parameters
inputStream containing the encoded data

Implements Ogre::Codec.

◆ encode()

DataStreamPtr Ogre::ASTCCodec::encode ( MemoryDataStreamPtr input,
CodecDataPtr pData 
) const
overridevirtual

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

Implements Ogre::Codec.

◆ encodeToFile()

void Ogre::ASTCCodec::encodeToFile ( MemoryDataStreamPtr input,
const String outFileName,
CodecDataPtr pData 
) const
overridevirtual

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.

◆ getType()

String Ogre::ASTCCodec::getType ( ) const
overridevirtual

Returns the type of the codec as a String.

Implements Ogre::Codec.

◆ magicNumberToFileExt()

String Ogre::ASTCCodec::magicNumberToFileExt ( const char *  magicNumberPtr,
size_t  maxbytes 
) const
overridevirtual

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.

◆ shutdown()

static void Ogre::ASTCCodec::shutdown ( )
static

Static method to shutdown and unregister the ASTC codec.

◆ startup()

static void Ogre::ASTCCodec::startup ( )
static

Static method to startup and register the ASTC codec.

◆ validateMagicNumber()

ValidationStatus Ogre::ASTCCodec::validateMagicNumber ( const char *  magicNumberPtr,
size_t  maxbytes 
) const
overridevirtual

validateMagicNumber Returns whether a magic number header matches this codec.

At least 4 bytes must be supplied.

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
Validation status.

Implements Ogre::Codec.


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