#include <OgreSTBICodec.h>
|
| STBIImageCodec (const String &type) |
|
virtual | ~STBIImageCodec () |
|
void | decode (const DataStreamPtr &input, const Any &output) const override |
| Codes the data from the input chunk into the output chunk.
|
|
DataStreamPtr | encode (const Any &input) const override |
| Codes the input and saves the result in the output stream.
|
|
void | encodeToFile (const Any &input, const String &outFileName) const override |
| Codes the data in the input chunk and saves the result in the output filename provided.
|
|
String | getType () const override |
| Returns the type of the codec as a String.
|
|
String | magicNumberToFileExt (const char *magicNumberPtr, size_t maxbytes) const override |
| Maps a magic number header to a file extension, if this codec recognises it.
|
|
virtual | ~Codec () |
|
virtual void | decode (const DataStreamPtr &input, const Any &output) const =0 |
| Codes the data from the input chunk into the output chunk.
|
|
virtual DataStreamPtr | encode (const Any &input) const |
| Codes the input and saves the result in the output stream.
|
|
virtual void | encodeToFile (const Any &input, const String &outFileName) const |
| Codes the data in the input chunk and saves the result in the output filename provided.
|
|
virtual String | getType () const =0 |
| Returns the type of the codec as a String.
|
|
bool | magicNumberMatch (const char *magicNumberPtr, size_t maxbytes) const |
| Returns whether a magic number header matches this codec.
|
|
virtual String | magicNumberToFileExt (const char *magicNumberPtr, size_t maxbytes) const =0 |
| Maps a magic number header to a file extension, if this codec recognises it.
|
|
|
static _OgreSTBICodecExport void | shutdown (void) |
| Static method to shutdown and unregister the codecs.
|
|
static _OgreSTBICodecExport void | startup (void) |
| Static method to startup and register the codecs.
|
|
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 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 | unregisterCodec (Codec *pCodec) |
| Unregisters a codec from the database.
|
|
◆ STBIImageCodec()
Ogre::STBIImageCodec::STBIImageCodec |
( |
const String & |
type | ) |
|
◆ ~STBIImageCodec()
virtual Ogre::STBIImageCodec::~STBIImageCodec |
( |
| ) |
|
|
inlinevirtual |
◆ encode()
Codes the input and saves the result in the output stream.
Reimplemented from Ogre::Codec.
◆ encodeToFile()
void Ogre::STBIImageCodec::encodeToFile |
( |
const Any & |
input, |
|
|
const String & |
outFileName |
|
) |
| 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
-
input | The input data (codec type specific) |
outFileName | The filename to write to |
Reimplemented from Ogre::Codec.
◆ decode()
void Ogre::STBIImageCodec::decode |
( |
const DataStreamPtr & |
input, |
|
|
const Any & |
output |
|
) |
| const |
|
overridevirtual |
Codes the data from the input chunk into the output chunk.
- Parameters
-
input | Stream containing the encoded data |
output | codec type specific result |
Implements Ogre::Codec.
◆ getType()
String Ogre::STBIImageCodec::getType |
( |
| ) |
const |
|
overridevirtual |
Returns the type of the codec as a String.
Implements Ogre::Codec.
◆ magicNumberToFileExt()
String Ogre::STBIImageCodec::magicNumberToFileExt |
( |
const char * |
magicNumberPtr, |
|
|
size_t |
maxbytes |
|
) |
| const |
|
overridevirtual |
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.
◆ startup()
static _OgreSTBICodecExport void Ogre::STBIImageCodec::startup |
( |
void |
| ) |
|
|
static |
Static method to startup and register the codecs.
◆ shutdown()
static _OgreSTBICodecExport void Ogre::STBIImageCodec::shutdown |
( |
void |
| ) |
|
|
static |
Static method to shutdown and unregister the codecs.
The documentation for this class was generated from the following file: