ShaderFeature Class Reference

#include <shaderFeature.h>

Inheritance diagram for ShaderFeature:

Detailed Description

The ShaderFeature class is the base class for every procedurally generated feature. Each feature the engine recognizes is part of the enum in GFXMaterialFeatureData. That structure is used to indicate which features are present in a shader to be generated. This is useful as many ShaderFeatures will output different code depending on what other features are going to be in the shader.

Shaders are generated using the ShaderFeature interface, so all of the descendants interact pretty much the same way.

Public Member Functions

virtual ~ShaderFeature ()

LangElement * getOutput () const

returns output from a processed vertex or pixel shader

virtual Var * getVertBaseTex ()=0

Get the incoming base texture coords - useful for bumpmap and detail maps.

virtual LangElement * setupTexSpaceMat (Vector< ShaderComponent * > &componentList, Var **texSpaceMat)=0

Set up a texture space matrix - to pass into pixel shader.

virtual LangElement * expandNormalMap (LangElement *sampleNormalOp, LangElement *normalDecl, LangElement *normalVar, const GFXMaterialFeatureData &fd)=0

Expand and assign a normal map. This takes care of compressed normal maps as well.

virtual LangElement * assignColor (LangElement *elem, bool add=false)=0

Get the color assignment - helper function.

virtual void processVert (Vector< ShaderComponent * > &componentList, GFXMaterialFeatureData &fd)

virtual void processPix (Vector< ShaderComponent * > &componentList, GFXMaterialFeatureData &fd)

virtual Material::BlendOp getBlendOp ()

Identifies what type of blending a feature uses.

virtual Resources getResources (GFXMaterialFeatureData &fd)

Returns the resource requirements of this feature based on what other features are present.

virtual void setTexData (Material::StageData &stageDat, GFXMaterialFeatureData &fd, RenderPassData &passData, U32 &texIndex)

Fills texture related info in RenderPassData for this feature.

virtual String getName ()=0

Returns the name of this feature.

virtual void addDependency (const ShaderDependency *dependsOn)

Adds a dependency to this shader feature.

virtual const Vector< const
ShaderDependency * > & getDependencies () const

Gets the dependency list for this shader feature.

virtual void determineFeature (Material *material, U32 stageNum, GFXMaterialFeatureData &fd, const GFXMaterialFeatureData::FeatureListHandle &features)

Protected Attributes

LangElement * output

Vector< const ShaderDependency * > mDependencies

Classes

struct Resources

Constructor & Destructor Documentation

virtual ShaderFeature::~ShaderFeature ( ) [inline, virtual]

Member Function Documentation

LangElement* ShaderFeature::getOutput ( ) const [inline]

returns output from a processed vertex or pixel shader

virtual Var* ShaderFeature::getVertBaseTex ( ) [pure virtual]

Get the incoming base texture coords - useful for bumpmap and detail maps.

Implemented in ShaderFeatureGLSL, and ShaderFeatureHLSL.

virtual LangElement* ShaderFeature::setupTexSpaceMat	(	Vector< ShaderComponent * > &	componentList,
		Var **	texSpaceMat
	)			`[pure virtual]`

Set up a texture space matrix - to pass into pixel shader.

Implemented in ShaderFeatureGLSL, and ShaderFeatureHLSL.

virtual LangElement* ShaderFeature::expandNormalMap	(	LangElement *	sampleNormalOp,
		LangElement *	normalDecl,
		LangElement *	normalVar,
		const GFXMaterialFeatureData &	fd
	)			`[pure virtual]`

Expand and assign a normal map. This takes care of compressed normal maps as well.

Implemented in ShaderFeatureGLSL, and ShaderFeatureHLSL.

virtual LangElement* ShaderFeature::assignColor	(	LangElement *	elem,
		bool	add = `false`
	)			`[pure virtual]`

Get the color assignment - helper function.

Implemented in ShaderFeatureGLSL, and ShaderFeatureHLSL.

virtual void ShaderFeature::processVert	(	Vector< ShaderComponent * > &	componentList,
		GFXMaterialFeatureData &	fd
	)			`[inline, virtual]`

Process vertex shader - This function is used by each feature to generate a list of LangElements that can be traversed and "printed" to generate the actual shader code. The 'output' member is the head of that list.

The componentList is used mostly for access to the "Connector" structure which is used to pass data from the vertex to the pixel shader.

The GFXMaterialFeatureData parameter is used to determine what other features are present for the shader being generated.

Reimplemented in DynamicLightingFeatureGLSL, DynamicLightingFeatureHLSL, BumpFeatGLSL, PixelSpecularGLSL, VertPositionGLSL, VertLightColorGLSL, BaseTexFeatGLSL, LightmapFeatGLSL, DetailFeatGLSL, LightNormMapFeatGLSL, ReflectCubeFeatGLSL, FogFeatGLSL, BumpFeatHLSL, PixelSpecularHLSL, VertPositionHLSL, VertLightColorHLSL, BaseTexFeatHLSL, LightmapFeatHLSL, DetailFeatHLSL, LightNormMapFeatHLSL, ReflectCubeFeatHLSL, and FogFeatHLSL.

virtual void ShaderFeature::processPix	(	Vector< ShaderComponent * > &	componentList,
		GFXMaterialFeatureData &	fd
	)			`[inline, virtual]`

Process pixel shader - This function is used by each feature to generate a list of LangElements that can be traversed and "printed" to generate the actual shader code. The 'output' member is the head of that list.

The componentList is used mostly for access to the "Connector" structure which is used to pass data from the vertex to the pixel shader.

The GFXMaterialFeatureData parameter is used to determine what other features are present for the shader being generated.

Reimplemented in ExposureFeatureX2GLSL, DynamicLightingFeatureGLSL, SelfIlluminationFeatureGLSL, ExposureFeatureX2HLSL, DynamicLightingFeatureHLSL, SelfIlluminationFeatureHLSL, BumpFeatGLSL, PixelSpecularGLSL, VertLightColorGLSL, BaseTexFeatGLSL, DiffuseFeatureGLSL, LightmapFeatGLSL, DetailFeatGLSL, LightNormMapFeatGLSL, ReflectCubeFeatGLSL, FogFeatGLSL, VisibilityFeatGLSL, ColorMultiplyFeatGLSL, BumpFeatHLSL, PixelSpecularHLSL, VertLightColorHLSL, BaseTexFeatHLSL, DiffuseFeatureHLSL, LightmapFeatHLSL, DetailFeatHLSL, LightNormMapFeatHLSL, ReflectCubeFeatHLSL, FogFeatHLSL, VisibilityFeatHLSL, and ColorMultiplyFeatHLSL.

virtual Material::BlendOp ShaderFeature::getBlendOp ( ) [inline, virtual]

Identifies what type of blending a feature uses.

This is used to group features with the same blend operation together in a multipass situation.

Reimplemented in ExposureFeatureX2GLSL, DynamicLightingFeatureGLSL, DynamicLightingDummyFeatureGLSL, SelfIlluminationFeatureGLSL, ExposureFeatureX2HLSL, DynamicLightingFeatureHLSL, DynamicLightingDummyFeatureHLSL, SelfIlluminationFeatureHLSL, BumpFeatGLSL, VertLightColorGLSL, BaseTexFeatGLSL, DiffuseFeatureGLSL, LightmapFeatGLSL, DetailFeatGLSL, LightNormMapFeatGLSL, FogFeatGLSL, TexAnimGLSL, VisibilityFeatGLSL, ColorMultiplyFeatGLSL, BumpFeatHLSL, VertLightColorHLSL, BaseTexFeatHLSL, DiffuseFeatureHLSL, LightmapFeatHLSL, DetailFeatHLSL, LightNormMapFeatHLSL, FogFeatHLSL, TexAnimHLSL, VisibilityFeatHLSL, and ColorMultiplyFeatHLSL.

virtual Resources ShaderFeature::getResources ( GFXMaterialFeatureData & fd ) [inline, virtual]

Returns the resource requirements of this feature based on what other features are present.

The "resources" are things such as texture units, and texture registers of which there can be very limited numbers. The resources can vary depending on hardware and what other features are present.

Reimplemented in DynamicLightingFeatureGLSL, DynamicLightingFeatureHLSL, BumpFeatGLSL, PixelSpecularGLSL, BaseTexFeatGLSL, LightmapFeatGLSL, DetailFeatGLSL, LightNormMapFeatGLSL, ReflectCubeFeatGLSL, FogFeatGLSL, BumpFeatHLSL, PixelSpecularHLSL, BaseTexFeatHLSL, LightmapFeatHLSL, DetailFeatHLSL, LightNormMapFeatHLSL, ReflectCubeFeatHLSL, and FogFeatHLSL.

virtual void ShaderFeature::setTexData	(	Material::StageData &	stageDat,
		GFXMaterialFeatureData &	fd,
		RenderPassData &	passData,
		U32 &	texIndex
	)			`[inline, virtual]`

Fills texture related info in RenderPassData for this feature.

It takes into account the current pass (passData) as well as what other data is available to the material stage (stageDat).

For instance, ReflectCubeFeatHLSL would like to modulate its output by the alpha channel of another texture. If the current pass does not contain a diffuse or bump texture, but the Material does, then this function allows it to use one of those textures in the current pass.

Reimplemented in DynamicLightingFeatureGLSL, DynamicLightingFeatureHLSL, BumpFeatGLSL, BaseTexFeatGLSL, LightmapFeatGLSL, DetailFeatGLSL, LightNormMapFeatGLSL, ReflectCubeFeatGLSL, FogFeatGLSL, BumpFeatHLSL, BaseTexFeatHLSL, LightmapFeatHLSL, DetailFeatHLSL, LightNormMapFeatHLSL, ReflectCubeFeatHLSL, and FogFeatHLSL.

virtual String ShaderFeature::getName ( ) [pure virtual]

Returns the name of this feature.

Implemented in ExposureFeatureX2GLSL, ExposureFeatureX4GLSL, DynamicLightingFeatureGLSL, DynamicLightingDummyFeatureGLSL, SelfIlluminationFeatureGLSL, ExposureFeatureX2HLSL, ExposureFeatureX4HLSL, DynamicLightingFeatureHLSL, DynamicLightingDummyFeatureHLSL, SelfIlluminationFeatureHLSL, BumpFeatGLSL, PixelSpecularGLSL, ShaderFeatureGLSL, VertPositionGLSL, VertLightColorGLSL, BaseTexFeatGLSL, DiffuseFeatureGLSL, LightmapFeatGLSL, DetailFeatGLSL, LightNormMapFeatGLSL, ReflectCubeFeatGLSL, FogFeatGLSL, TexAnimGLSL, VisibilityFeatGLSL, ColorMultiplyFeatGLSL, BumpFeatHLSL, PixelSpecularHLSL, ShaderFeatureHLSL, VertPositionHLSL, VertLightColorHLSL, BaseTexFeatHLSL, DiffuseFeatureHLSL, LightmapFeatHLSL, DetailFeatHLSL, LightNormMapFeatHLSL, ReflectCubeFeatHLSL, FogFeatHLSL, TexAnimHLSL, VisibilityFeatHLSL, and ColorMultiplyFeatHLSL.

virtual void ShaderFeature::addDependency ( const ShaderDependency * dependsOn ) [inline, virtual]

Adds a dependency to this shader feature.

virtual const Vector<const ShaderDependency *>& ShaderFeature::getDependencies ( ) const [inline, virtual]

Gets the dependency list for this shader feature.

virtual void ShaderFeature::determineFeature	(	Material *	material,
		U32	stageNum,
		GFXMaterialFeatureData &	fd,
		const GFXMaterialFeatureData::FeatureListHandle &	features
	)			`[inline, virtual]`

Member Data Documentation

LangElement* ShaderFeature::output [protected]

Vector<const ShaderDependency *> ShaderFeature::mDependencies [protected]