libHSPlasma
Public Member Functions | Protected Member Functions | List of all members
plLODMipmap Class Reference

#include <plMipmap.h>

Inheritance diagram for plLODMipmap:
plMipmap plBitmap hsKeyedObject plCreatable

Public Member Functions

virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
plKey getBase () const
void setBase (plKey base)
- Public Member Functions inherited from plMipmap
 plMipmap ()
 plMipmap (unsigned int width, unsigned int height, unsigned char numLevels, unsigned char compType, ColorFormat format, unsigned char dxtLevel=kDXTError)
virtual ~plMipmap ()
void Create (unsigned int width, unsigned int height, unsigned char numLevels, unsigned char compType, ColorFormat format, unsigned char dxtLevel=kDXTError)
void CopyFrom (plMipmap *src)
void readData (hsStream *S)
void writeData (hsStream *S)
unsigned int getWidth () const
unsigned int getHeight () const
const void * getImageData () const
size_t getTotalSize () const
size_t getNumLevels () const
unsigned int getLevelSize (size_t idx) const
unsigned int getLevelWidth (size_t idx) const
unsigned int getLevelHeight (size_t idx) const
const void * getLevelData (size_t idx) const
size_t getJpegSize () const
size_t getJpegAlphaSize () const
const void * getJpegImage () const
const void * getJpegAlpha () const
void setImageData (const void *data, size_t size)
void setLevelData (size_t idx, const void *data, size_t size)
void setImageJPEG (const void *data, size_t size)
void setAlphaJPEG (const void *data, size_t size)
void setColorData (const void *data, size_t size)
void setAlphaData (const void *alpha, size_t size)
void extractColorData (void *buffer, size_t size) const
void extractAlphaData (void *buffer, size_t size) const
bool isImageJPEG () const
bool isAlphaJPEG () const
size_t GetUncompressedSize (size_t level) const
void DecompressImage (size_t level, void *dest, size_t size)
void CompressImage (size_t level, void *src, size_t size)
- Public Member Functions inherited from plBitmap
 plBitmap ()
void setConfig (ColorFormat format)
unsigned char getBPP () const
unsigned char getSpace () const
unsigned short getFlags () const
unsigned char getCompressionType () const
unsigned char getDXCompression () const
unsigned char getDXBlockSize () const
unsigned char getARGBType () const
unsigned int getLowModTime () const
unsigned int getHighModTime () const
void setBPP (unsigned char bpp)
void setSpace (unsigned char space)
void setFlags (unsigned short flags)
void setCompressionType (unsigned char type)
void setDXCompression (unsigned char type)
void setDXBlockSize (unsigned char size)
void setARGBType (unsigned char type)
void setModTime (unsigned int low, unsigned int high)
- Public Member Functions inherited from hsKeyedObject
void init (const plString &name)
plKey getKey () const
void setKey (plKey key)
- Public Member Functions inherited from plCreatable
 plCreatable ()
virtual ~plCreatable ()
virtual short ClassIndex () const =0
short ClassIndex (PlasmaVer ver) const
virtual const char * ClassName () const
virtual bool ClassInstance (short) const
virtual bool isStub () const
virtual void prcWrite (pfPrcHelper *prc)
virtual void prcParse (const pfPrcTag *tag, plResManager *mgr)

Protected Member Functions

virtual void IPrcWrite (pfPrcHelper *prc)
virtual void IPrcParse (const pfPrcTag *tag, plResManager *mgr)
- Protected Member Functions inherited from plMipmap
void IRead (hsStream *S)
void IWrite (hsStream *S)
size_t IBuildLevelSizes ()
void IReadJPEGImage (hsStream *S)
void IReadRawImage (hsStream *S)
void IReadRLEImage (hsStream *S, bool alpha)
void IWriteJPEGImage (hsStream *S)
void IWriteRawImage (hsStream *S)
void IWriteRLEImage (hsStream *S, bool alpha)

Additional Inherited Members

- Public Types inherited from plMipmap
enum  { kColorDataRLE = 0x1, kAlphaDataRLE = 0x2 }
- Static Public Attributes inherited from plBitmap
static const char * kCompressionTypeNames []
static const char * kSpaceNames []
static const char * kUncompressedTypeNames []
static const char * kCompressedTypeNames []
- Protected Attributes inherited from plMipmap
unsigned char * fImageData
size_t fTotalSize
unsigned char * fJPEGData
size_t fJPEGSize
unsigned char * fJAlphaData
size_t fJAlphaSize
unsigned int fWidth
unsigned int fHeight
unsigned int fStride
std::vector< LevelDatafLevelData

Member Function Documentation

plKey plLODMipmap::getBase ( ) const
virtual void plLODMipmap::IPrcParse ( const pfPrcTag tag,
plResManager mgr 
)
protectedvirtual

This must be overloaded by subclasses to parse PRC data specific to the class from the PRC document. It is called once for each tag that is a child to the Creatable tag itself, so subclasses should check for each supported tag and handle it accordingly if it matches. If the tag is not recognized, it should be passed along to the parent class.

Reimplemented from plMipmap.

virtual void plLODMipmap::IPrcWrite ( pfPrcHelper prc)
protectedvirtual

This must be overloaded by subclasses to write PRC data specific to the class to the PRC document. Do not write the top-level creatable tag, that is handled by prcWrite().

Reimplemented from plMipmap.

virtual void plLODMipmap::read ( hsStream ,
plResManager  
)
virtual

Reads this creatable directly from the stream. If any keys are read, they will be added to the plResManager automatically.

Reimplemented from plMipmap.

void plLODMipmap::setBase ( plKey  base)
virtual void plLODMipmap::write ( hsStream ,
plResManager  
)
virtual

Writes this creatable directly to the stream. The plResManager is used to manage any key references written by this creatable.

Reimplemented from plMipmap.


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