GFXTextureObject Class Reference

#include <gfxTextureObject.h>

Inheritance diagram for GFXTextureObject:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 GFXTextureObject (GFXDevice *aDevice, GFXTextureProfile *profile)
virtual ~GFXTextureObject ()
GBitmapgetBitmap ()
DDSFilegetDDS ()
const U32 getWidth () const
const U32 getHeight () const
const U32 getDepth () const
const U32 getBitmapWidth () const
const U32 getBitmapHeight () const
const U32 getBitmapDepth () const
GFXFormat getFormat () const
virtual F32 getMaxUCoord () const
virtual F32 getMaxVCoord () const
virtual GFXLockedRectlock (U32 mipLevel=0, RectI *inRect=NULL)=0
 Acquire a lock on part of the texture.
virtual void unlock (U32 mipLevel=0)=0
 Releases a lock previously acquired.
virtual bool copyToBmp (GBitmap *bmp)=0
virtual bool readBackBuffer (Point2I &upperLeft)=0
 Copy the back buffer into this texture.
virtual void pureVirtualCrash ()=0
virtual void kill ()
virtual const String describeSelf () const
 The resource should put a description of itself (number of vertices, size/width of texture, etc.) in buffer.

Static Public Member Functions

static void dumpActiveTOs ()

Public Attributes

String mDebugCreationPath
String mDebugDescription
GFXTextureObjectmDebugNext
GFXTextureObjectmDebugPrev
bool mDead
U32 cacheId
U32 cacheTime
GFXDevicemDevice
 Device this texture belongs to.
GFXTextureObjectmNext
 Next texture in the linked list.
GFXTextureObjectmPrev
 Previous texture in the linked list.
GFXTextureObjectmHashNext
 Used for hash table lookups.
String mTextureLookupName
 This is the file name or other unique string used to hash this texture object.
Point3I mBitmapSize
Point3I mTextureSize
U32 mMipLevels
S32 mAntialiasLevel
bool mHasTransparency
GBitmapmBitmap
 GBitmap we are backed by.
DDSFilemDDS
 DDSFile we're backed by.
GFXTextureProfilemProfile
GFXFormat mFormat

Static Public Attributes

static U32 smActiveTOCount
static GFXTextureObjectsmHead

Constructor & Destructor Documentation

GFXTextureObject::GFXTextureObject ( GFXDevice aDevice,
GFXTextureProfile profile 
)

virtual GFXTextureObject::~GFXTextureObject (  )  [virtual]


Member Function Documentation

static void GFXTextureObject::dumpActiveTOs (  )  [static]

GBitmap * GFXTextureObject::getBitmap (  )  [inline]

DDSFile * GFXTextureObject::getDDS (  )  [inline]

const U32 GFXTextureObject::getWidth (  )  const [inline]

const U32 GFXTextureObject::getHeight (  )  const [inline]

const U32 GFXTextureObject::getDepth (  )  const [inline]

const U32 GFXTextureObject::getBitmapWidth (  )  const [inline]

const U32 GFXTextureObject::getBitmapHeight (  )  const [inline]

const U32 GFXTextureObject::getBitmapDepth (  )  const [inline]

GFXFormat GFXTextureObject::getFormat (  )  const [inline]

virtual F32 GFXTextureObject::getMaxUCoord (  )  const [virtual]

Reimplemented in GFXGLTextureObject.

virtual F32 GFXTextureObject::getMaxVCoord (  )  const [virtual]

Reimplemented in GFXGLTextureObject.

virtual GFXLockedRect* GFXTextureObject::lock ( U32  mipLevel = 0,
RectI inRect = NULL 
) [pure virtual]

Acquire a lock on part of the texture.

The GFXLockedRect returned is managed by the GFXTextureObject and does not need to be freed.

Implemented in GFXD3D8TextureObject, GFXD3D9TextureObject, and GFXGLTextureObject.

virtual void GFXTextureObject::unlock ( U32  mipLevel = 0  )  [pure virtual]

Releases a lock previously acquired.

Note that the mipLevel parameter must match the corresponding lock!

Implemented in GFXD3D8TextureObject, GFXD3D9TextureObject, and GFXGLTextureObject.

virtual bool GFXTextureObject::copyToBmp ( GBitmap bmp  )  [pure virtual]

virtual bool GFXTextureObject::readBackBuffer ( Point2I upperLeft  )  [pure virtual]

Copy the back buffer into this texture.

This texture will contain back buffer data from the rectangle: RectI( upperLeft, Point2I( getWidth(), getHeight() ) )

Note:
This texture must use a render target profile
Parameters:
upperLeft Coordinates on the screen to start the capture

Implemented in GFXD3D8TextureObject, GFXD3D9TextureObject, and GFXGLTextureObject.

virtual void GFXTextureObject::pureVirtualCrash (  )  [pure virtual]

virtual void GFXTextureObject::kill (  )  [virtual]

virtual const String GFXTextureObject::describeSelf (  )  const [virtual]

The resource should put a description of itself (number of vertices, size/width of texture, etc.) in buffer.

Implements GFXResource.

Reimplemented in GFXGLTextureObject.


Member Data Documentation

Device this texture belongs to.

Next texture in the linked list.

Previous texture in the linked list.

Used for hash table lookups.

This is the file name or other unique string used to hash this texture object.