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

#include <plRenderTarget.h>

Inheritance diagram for plRenderTarget:
plBitmap hsKeyedObject plCreatable plCubicRenderTarget plDynamicCamMap plDynamicEnvMap

Public Member Functions

 plRenderTarget ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
void readData (hsStream *S)
void writeData (hsStream *S)
- 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

void IRead (hsStream *S)
void IWrite (hsStream *S)
virtual void IPrcWrite (pfPrcHelper *prc)
virtual void IPrcParse (const pfPrcTag *tag, plResManager *mgr)

Protected Attributes

unsigned short fWidth
unsigned short fHeight
union {
   struct {
      unsigned short   fLeft
      unsigned short   fTop
      unsigned short   fRight
      unsigned short   fBottom
   }   fAbsolute
   struct {
      float   fLeft
      float   fTop
      float   fRight
      float   fBottom
   }   fProportional
fViewport
bool fProportionalViewport
unsigned char fZDepth
unsigned char fStencilDepth
- Protected Attributes inherited from plBitmap
unsigned char fPixelSize
unsigned char fSpace
unsigned short fFlags
unsigned char fCompressionType
union {
   DirectXInfo   fDXInfo
   UncompressedInfo   fUncompressedInfo
}; 
unsigned int fLowModTime
unsigned int fHighModTime

Additional Inherited Members

- Public Types inherited from plBitmap
enum  Flags {
  kAlphaChannelFlag = 0x1, kAlphaBitFlag = 0x2, kBumpEnvMap = 0x4, kForce32Bit = 0x8,
  kDontThrowAwayImage = 0x10, kForceOneMipLevel = 0x20, kNoMaxSize = 0x40, kIntensityMap = 0x80,
  kHalfSize = 0x100, kUserOwnsBitmap = 0x200, kForceRewrite = 0x400, kForceNonCompressed = 0x800,
  kIsTexture = 0x1000, kIsOffscreen = 0x2000, kIsProjected = 0x4000, kIsOrtho = 0x8000
}
enum  CompressionType { kUncompressed, kDirectXCompression, kJPEGCompression }
enum  ColorSpace { kNoSpace, kDirectSpace, kGraySpace, kIndexSpace }
enum  DxtType {
  kDXTError, kDXT1, kDXT2_UNUSED, kDXT3,
  kDXT4_UNUSED, kDXT5
}
enum  ColorFormat {
  kRGB8888, kRGB4444, kRGB1555, kInten8,
  kAInten88
}
- Static Public Attributes inherited from plBitmap
static const char * kCompressionTypeNames []
static const char * kSpaceNames []
static const char * kUncompressedTypeNames []
static const char * kCompressedTypeNames []

Constructor & Destructor Documentation

plRenderTarget::plRenderTarget ( )

Member Function Documentation

virtual void plRenderTarget::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 plBitmap.

Reimplemented in plDynamicCamMap, plCubicRenderTarget, and plDynamicEnvMap.

virtual void plRenderTarget::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 plBitmap.

Reimplemented in plDynamicCamMap, plCubicRenderTarget, and plDynamicEnvMap.

void plRenderTarget::IRead ( hsStream S)
protected

Performs internal plBitmap header read

Reimplemented from plBitmap.

void plRenderTarget::IWrite ( hsStream S)
protected

Performs internal plBitmap header write

Reimplemented from plBitmap.

virtual void plRenderTarget::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 plBitmap.

Reimplemented in plDynamicCamMap, plCubicRenderTarget, and plDynamicEnvMap.

void plRenderTarget::readData ( hsStream S)
virtual void plRenderTarget::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 plBitmap.

Reimplemented in plDynamicCamMap, plCubicRenderTarget, and plDynamicEnvMap.

void plRenderTarget::writeData ( hsStream S)

Member Data Documentation

struct { ... } plRenderTarget::fAbsolute
unsigned short plRenderTarget::fBottom
float plRenderTarget::fBottom
unsigned short plRenderTarget::fHeight
protected
unsigned short plRenderTarget::fLeft
float plRenderTarget::fLeft
struct { ... } plRenderTarget::fProportional
bool plRenderTarget::fProportionalViewport
protected
unsigned short plRenderTarget::fRight
float plRenderTarget::fRight
unsigned char plRenderTarget::fStencilDepth
protected
unsigned short plRenderTarget::fTop
float plRenderTarget::fTop
union { ... } plRenderTarget::fViewport
unsigned short plRenderTarget::fWidth
protected
unsigned char plRenderTarget::fZDepth
protected

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