Shader deletion for TSE GFX

This resource is now in TSE HEAD.


This enhancement adds the ability to destroy custom shaders to the GFX layer. I couldn't find any current method of deleting or reloading a GFXShader, so I tossed this stuff together. If you're wondering why this is usefull, don't bother reading any further.

gfxDevice.h

Locate:

virtual GFXShader * createShader( GFXShaderFeatureData &featureData, GFXVertexFlags vertFlags ) = 0;

Add:

//*****
	// Added - JM
	virtual void destroyShader(GFXShader* shader) {}
	//*****

gfxD3DDevice.h

Locate:

virtual GFXShader * createShader( GFXShaderFeatureData &featureData, GFXVertexFlags vertFlags );

Add:

//*****
	// Added - JM
	virtual void destroyShader(GFXShader* shader);
	//*****

gfxD3DDevice.cpp

Locate:

GFXShader * GFXD3DDevice::createShader(.......
........
........
}

Add:

//-----------------------------------------------------------------------------
//*****
// Added - JM
void GFXD3DDevice::destroyShader(GFXShader* shader)
{
	mShaderMgr.destroyShader(shader);
}
//*****

gfxShaderMgr.h

Locate:

virtual GFXShader * getShader( GFXShaderFeatureData &dat,
                                  GFXVertexFlags ) = 0;

Add:

//*****
	// Added - JM
	virtual void destroyShader(GFXShader* shader);
	//*****

gfxShaderMgr.cpp

Add to the end of file:

//----------------------------------------------------------------------------
// Destroy shader - JM
//----------------------------------------------------------------------------

void GFXShaderMgr::destroyShader(GFXShader* shader)
{
	if(!shader || mCustShaders.empty()) return;

	for(U32 i = 0; i < mCustShaders.size(); i++) {
		if(mCustShaders[ i ] == shader) {
			mCustShaders.erase(i);
			break;
		}
	}

	delete shader;
}

So what is the use for this functionality with the current state of TSE?
I wanted it for in-game shader (re)loading, which I'm also going to share:


shaderData.h

Locate:

bool initShader();

Add:

//*****
	// Added - JM
	bool reloadShader();
	void destroyShader();
	//*****

shaderData.cpp

Add this include:

#include "gfx/gfxShaderMgr.h"

Add all this to the end of the file:

//--------------------------------------------------------------------------
// Reload shader - JM
//--------------------------------------------------------------------------

bool ShaderData::reloadShader()
{
	if(!shader) return false;

	GFX->destroyShader(shader);
	shader = NULL;

	// get shader type from GFX layer
	switch(GFX->getAdapterType()) {
      case Direct3D9: {
			shader = GFX->createShader((char*)DXVertexShaderName, 
												(char*)DXPixelShaderName, 
												pixVersion);
			break;
		}
		default:
			return false;
	}

	return true;
}

//--------------------------------------------------------------------------
// Destroy shader - JM
//--------------------------------------------------------------------------

void ShaderData::destroyShader()
{
	if(!shader) return;

	GFX->destroyShader(shader);
	shader = NULL;

	return;
}

//*****
// Added - JM
ConsoleMethod(ShaderData, reload, bool, 2, 2, "Rebuilds both the vertex and pixel shaders.")
{
	return object->reloadShader();
}
//*****

Now you can compile a ShaderData object while in-game by simply typing MyShaderData.reload(); into the console.