Torque3D Documentation / _generateds / GFXTextureObject

GFXTextureObject

Engine/source/gfx/gfxTextureObject.h

More...

Public Attributes

GBitmap we are backed by.

DDSFile we're backed by.

bool

The time at which all references to this texture were removed.

The device this texture belongs to.

The siblings in the cache hash table.

The next texture in the linked list.

The path to the texture file if the content was loaded from a resource.

The previous texture in the linked list.

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

Public Functions

bool

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

object destroy self call (from StrongRefPtr). Override if this class has specially allocated memory.

bool
dumpToDisk(const String & bmType, const String & path)

Debug helper function for writing the texture to disk.

Returns the estimated video memory usage in bytes including mipmaps.

Returns the file path to the texture if it was loaded from disk.

bool

Returns true if this texture is a render target.

lock(U32 mipLevel, RectI * inRect)

Acquire a lock on part of the texture.

unlock(U32 mipLevel)

Releases a lock previously acquired.

Detailed Description

Public Attributes

S32 mAntialiasLevel 
GBitmap * mBitmap 

GBitmap we are backed by.

Point3I mBitmapSize 
DDSFile * mDDS 

DDSFile we're backed by.

bool mDead 
U32 mDeleteTime 

The time at which all references to this texture were removed.

GFXDevice * mDevice 

The device this texture belongs to.

GFXFormat mFormat 
GFXTextureObject * mHashNext 

The siblings in the cache hash table.

bool mHasTransparency 
U32 mMipLevels 
GFXTextureObject * mNext 

The next texture in the linked list.

String mPath 

The path to the texture file if the content was loaded from a resource.

GFXTextureObject * mPrev 

The previous texture in the linked list.

GFXTextureProfile * mProfile 
String mTextureLookupName 

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

Point3I mTextureSize 

Public Functions

GFXTextureObject(GFXDevice * aDevice, GFXTextureProfile * profile)

~GFXTextureObject()

copyToBmp(GBitmap * bmp)

Reimplemented by: GFXGLTextureObject, GFXNullTextureObject, GFXD3D11TextureObject

describeSelf()

Reimplemented from: GFXResource

Reimplemented by: GFXGLTextureObject

destroySelf()

Reimplemented from: StrongRefBase

dumpToDisk(const String & bmType, const String & path)

Debug helper function for writing the texture to disk.

getBitmap()

getBitmapDepth()

getBitmapHeight()

getBitmapWidth()

getDDS()

getDepth()

getEstimatedSizeInBytes()

Returns the estimated video memory usage in bytes including mipmaps.

getFormat()

getFormatByteSize()

getHeight()

getMaxUCoord()

Reimplemented by: GFXGLTextureObject

getMaxVCoord()

Reimplemented by: GFXGLTextureObject

getMipLevels()

getPath()

Returns the file path to the texture if it was loaded from disk.

getSize()

getWidth()

isRenderTarget()

Returns true if this texture is a render target.

kill()

lock(U32 mipLevel, RectI * inRect)

Acquire a lock on part of the texture.

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

Reimplemented by: GFXD3D11TextureObject, GFXGLTextureObject, GFXNullTextureObject

unlock(U32 mipLevel)

Releases a lock previously acquired.

Note that the mipLevel parameter must match the corresponding lock!

Reimplemented by: GFXD3D11TextureObject, GFXGLTextureObject, GFXNullTextureObject