GFXResource Class Reference

#include <gfxResource.h>

Inheritance diagram for GFXResource:

Inheritance graph

[legend]List of all members.

Detailed Description

Mixin for the purpose of tracking GFX resources owned by a GFXDevice.

There are many types of resource that are allocated from a GFXDevice that must be participatory in device resets. For instance, all default pool DirectX resources have to be involved when the device resets. Render targets in all APIs need to unbind themselves when resets happen.

This system is also handy for accounting purposes. For instance, we may want to traverse all registered VBs, IBs, Textures, or RTs in order to determine what, if any, items are still allocated. This can be used in leak reports, memory usage reports, etc.

Public Member Functions

GFXResource ()

virtual ~GFXResource ()

void registerResourceWithDevice (GFXDevice *device)

Registers this resource with the given device.

virtual void zombify ()=0

When called the resource should destroy all device sensitive information (e.g. D3D resources in D3DPOOL_DEFAULT.

virtual void resurrect ()=0

When called the resource should restore all device sensitive information destroyed by zombify().

virtual const String describeSelf () const =0

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

GFXResource * getNextResource () const

GFXResource * getPrevResource () const

GFXDevice * getOwningDevice () const

bool isFlagged ()

void setFlag ()

void clearFlag ()

Private Attributes

GFXResource * mPrevResource

GFXResource * mNextResource

GFXDevice * mOwningDevice

bool mFlagged

Helper flag to check new resource allocations.

Friends

class GFXDevice

Constructor & Destructor Documentation

GFXResource::GFXResource ( )

virtual GFXResource::~GFXResource ( ) [virtual]

Member Function Documentation

void GFXResource::registerResourceWithDevice ( GFXDevice * device )

Registers this resource with the given device.

virtual void GFXResource::zombify ( ) [pure virtual]

When called the resource should destroy all device sensitive information (e.g. D3D resources in D3DPOOL_DEFAULT.

Implemented in GFXD3D8Cubemap, GFXD3D8PrimitiveBuffer, GFXD3D8StateBlock, GFXD3D8TextureTarget, GFXD3D8WindowTarget, GFXD3D8TextureObject, GFXD3D8VertexBuffer, GFXD3D9Cubemap, GFXD3D9PrimitiveBuffer, GFXD3D9QueryFence, GFXD3D9ShaderConstBuffer, GFXD3D9Shader, GFXD3D9StateBlock, GFXD3D9TextureTarget, GFXD3D9WindowTarget, GFXD3D9TextureObject, GFXD3D9VertexBuffer, GFXGeneralFence, GFXGLAppleFence, GFXGLCubemap, GFXGLPrimitiveBuffer, GFXGLShader, GFXGLShaderConstBuffer, GFXGLStateBlock, GFXGLTextureObject, GFXGLTextureTarget, GFXGLVertexBuffer, GFXGLWindowTarget, and GFXNullWindowTarget.

virtual void GFXResource::resurrect ( ) [pure virtual]

When called the resource should restore all device sensitive information destroyed by zombify().

Implemented in GFXD3D8Cubemap, GFXD3D8PrimitiveBuffer, GFXD3D8StateBlock, GFXD3D8TextureTarget, GFXD3D8WindowTarget, GFXD3D8TextureObject, GFXD3D8VertexBuffer, GFXD3D9Cubemap, GFXD3D9PrimitiveBuffer, GFXD3D9QueryFence, GFXD3D9ShaderConstBuffer, GFXD3D9Shader, GFXD3D9StateBlock, GFXD3D9TextureTarget, GFXD3D9WindowTarget, GFXD3D9TextureObject, GFXD3D9VertexBuffer, GFXGeneralFence, GFXGLAppleFence, GFXGLCubemap, GFXGLPrimitiveBuffer, GFXGLShader, GFXGLShaderConstBuffer, GFXGLStateBlock, GFXGLTextureObject, GFXGLTextureTarget, GFXGLVertexBuffer, GFXGLWindowTarget, and GFXNullWindowTarget.

virtual const String GFXResource::describeSelf ( ) const [pure virtual]

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

Implemented in GFXD3D9QueryFence, GFXD3D9ShaderConstBuffer, GFXCubemap, GFXGeneralFence, GFXPrimitiveBuffer, GFXShaderConstBuffer, GFXShader, GFXStateBlock, GFXTarget, GFXTextureObject, GFXVertexBuffer, GFXGLAppleFence, GFXGLShader, GFXGLShaderConstBuffer, GFXGLTextureObject, and GFXGLTextureTarget.

GFXResource* GFXResource::getNextResource ( ) const [inline]

GFXResource* GFXResource::getPrevResource ( ) const [inline]

GFXDevice* GFXResource::getOwningDevice ( ) const [inline]

bool GFXResource::isFlagged ( ) [inline]

void GFXResource::setFlag ( ) [inline]

void GFXResource::clearFlag ( ) [inline]

Friends And Related Function Documentation

friend class GFXDevice [friend]

Reimplemented in GFXCubemap, GFXPrimitiveBuffer, GFXVertexBuffer, and GFXGLCubemap.

Member Data Documentation

GFXResource* GFXResource::mPrevResource [private]

GFXResource* GFXResource::mNextResource [private]

GFXDevice* GFXResource::mOwningDevice [private]

bool GFXResource::mFlagged [private]

Helper flag to check new resource allocations.