usg::MaterialSource Class Reference

Interface to define material source code such as the surface shader method. More...

#include <ShaderSource.h>

Public Member Functions
	MaterialSource (const SourceCodeGenerator &generator, const ShaderDescGroup &shaderGroup)
const SourceCodeGenerator &	sourceTypeGenerator () const
	Returns the SourceCodeGenerator that created this MaterialSource.
const usg::Token &	sourceType () const
	Returns the source target type of the generator.
const ShaderDescGroup &	shaderGroup () const
	Returns the ShaderDescGroup being converted into source code.
bool	modulatesOpacity () const
virtual std::string	buildUniqueShaderName (const ShaderDesc *shaderDesc) const
virtual std::string	buildUniqueInputName (const ShaderDesc *shaderDesc, const std::string &inputName) const
virtual TokenValueMapSorted	getShaderPropertyValues (const ShaderDesc *shaderDesc) const =0
virtual MaterialConnectionsMap	getShaderConnections (const ShaderDesc *shaderDesc) const =0
	Retrieve the list of valid input connections for this ShaderDesc in this material.
virtual ShaderSource *	createShaderSourceGenerator (const ShaderSchema *schema, std::stringstream &sourceOut) const =0
const ShaderDescConstPtrList &	shadersInTopologicalOrder () const
const ShaderDescNameMap &	outputShaderNames () const
	Map of ShaderDescGroup shaders and their constructed(unique-ified) output shader names.
const std::string &	getOutputShaderName (const ShaderDesc *shaderDesc) const
	Retrieve the constructed(unique-ified) shader name for source code output.
virtual void	emitSourceCode (std::stringstream &source) const =0

Protected Attributes
const SourceCodeGenerator &	_generator
const ShaderDescGroup &	_shaderGroup
bool	_modulatesOpacity {false}
	Material has varying opacity values across its surface.
ShaderDescConstPtrList	_topologicalOrder
	List of shaders sorted in topological dependency order.
ShaderDescNameMap	_outputShaders
	Map of ShaderDescs and their output shader names.

Detailed Description

Interface to define material source code such as the surface shader method.

Member Function Documentation

modulatesOpacity()

bool usg::MaterialSource::modulatesOpacity ( ) const

inline

This material has varying opacity values across its surface. Used if shaders need to declare this as a renderer hint.

buildUniqueShaderName()

virtual std::string usg::MaterialSource::buildUniqueShaderName ( const ShaderDesc *  shaderDesc ) const

virtual

Build a unique name for this shader. Default implementation combines the name of the ShaderDesc's schema name with the current size of _outputShaders, thereby numbering them uniquely.

buildUniqueInputName()

virtual std::string usg::MaterialSource::buildUniqueInputName ( const ShaderDesc *  shaderDesc, const std::string &  inputName  ) const

virtual

Build a unique name for this input name. Default implementation combines the name of the ShaderDesc's unique output name with the input name.

getShaderPropertyValues()

virtual TokenValueMapSorted usg::MaterialSource::getShaderPropertyValues ( const ShaderDesc *  shaderDesc ) const

pure virtual

Retrieve the unique input property values to set in the output source. The names of the properties are usually created via buildUniqueInputName().

createShaderSourceGenerator()

virtual ShaderSource * usg::MaterialSource::createShaderSourceGenerator ( const ShaderSchema *  schema, std::stringstream &  sourceOut  ) const

pure virtual

Create (allocate) and return the ShaderSource generator to call when the given ShaderSchema needs to create custom shader code for this MaterialSource. The created ShaderSource is used for a single ShaderSchema instance and can store any temporary data it needs to prepare for the ShaderSchema::sourceCode() method to be called. Calling code takes ownership of returned allocation and typically will destroy it after the ShaderSchema's sourceCode() method has been run.

shadersInTopologicalOrder()

const ShaderDescConstPtrList & usg::MaterialSource::shadersInTopologicalOrder ( ) const

inline

List of ShaderDesc pointers sorted into topological dependency order so shaders that depend on other shaders come after their dependencies.

emitSourceCode()

virtual void usg::MaterialSource::emitSourceCode ( std::stringstream &  source ) const

pure virtual

Generate source code text defining everything that the material will need to compile. This method will typically take the ShaderDescGroup and walk through all its ShaderSchemas converting them to source by calling createShaderSourceGenerator() for each.