Base class for shader generators All third-party shader generators should derive from this class. More...

#include <ShaderGenerator.h>

Inheritance diagram for ShaderGenerator:

Public Member Functions
virtual	~ShaderGenerator ()
	Destructor.

virtual const string &	getTarget () const
	Return the name of the target this generator is for. More...

virtual ShaderPtr	generate (const string &, ElementPtr, GenContext &) const
	Generate a shader starting from the given element, translating the element and all dependencies upstream into shader code. More...

virtual void	emitScopeBegin (ShaderStage &stage, Syntax::Punctuation punc=Syntax::CURLY_BRACKETS) const
	Start a new scope using the given bracket type.

virtual void	emitScopeEnd (ShaderStage &stage, bool semicolon=false, bool newline=true) const
	End the current scope.

virtual void	emitLineBegin (ShaderStage &stage) const
	Start a new line.

virtual void	emitLineEnd (ShaderStage &stage, bool semicolon=true) const
	End the current line.

virtual void	emitLineBreak (ShaderStage &stage) const
	Add a line break.

virtual void	emitString (const string &str, ShaderStage &stage) const
	Add a string.

virtual void	emitLine (const string &str, ShaderStage &stage, bool semicolon=true) const
	Add a single line of code, optionally appending a semicolon.

virtual void	emitComment (const string &str, ShaderStage &stage) const
	Add a single line code comment.

virtual void	emitBlock (const string &str, const FilePath &sourceFilename, GenContext &context, ShaderStage &stage) const
	Add a block of code.

virtual void	emitLibraryInclude (const FilePath &filename, GenContext &context, ShaderStage &stage) const
	Add the contents of a standard library include file if not already present. More...

template<typename T >
void	emitValue (const T &value, ShaderStage &stage) const
	Add a value.

virtual void	emitFunctionDefinition (const ShaderNode &node, GenContext &context, ShaderStage &stage) const
	Add the function definition for a single node.

virtual void	emitFunctionDefinitions (const ShaderGraph &graph, GenContext &context, ShaderStage &stage) const
	Add all function definitions for a graph.

virtual void	emitFunctionCall (const ShaderNode &node, GenContext &context, ShaderStage &stage) const
	Add the function call for a single node. More...

virtual void	emitFunctionCall (const ShaderNode &node, GenContext &context, ShaderStage &stage, bool checkScope) const

virtual void	emitFunctionCalls (const ShaderGraph &graph, GenContext &context, ShaderStage &stage, uint32_t classification=0u) const
	Add all function calls for a graph. More...

virtual void	emitDependentFunctionCalls (const ShaderNode &node, GenContext &context, ShaderStage &stage, uint32_t classification=0u) const
	Add function calls for nodes connected directly upstream from the given node. More...

virtual void	emitFunctionBodyBegin (const ShaderNode &node, GenContext &context, ShaderStage &stage, Syntax::Punctuation punc=Syntax::CURLY_BRACKETS) const
	Emit code for starting a new function body. More...

virtual void	emitFunctionBodyEnd (const ShaderNode &node, GenContext &context, ShaderStage &stage) const
	Emit code for ending a function body.

virtual void	emitTypeDefinitions (GenContext &context, ShaderStage &stage) const
	Emit type definitions for all data types that needs it.

virtual void	emitInput (const ShaderInput *input, GenContext &context, ShaderStage &stage) const
	Emit the connected variable name for an input, or constant value if the port is not connected.

virtual void	emitOutput (const ShaderOutput *output, bool includeType, bool assignValue, GenContext &context, ShaderStage &stage) const
	Emit the output variable name for an output, optionally including it's type and default value assignment.

virtual void	emitVariableDeclarations (const VariableBlock &block, const string &qualifier, const string &separator, GenContext &context, ShaderStage &stage, bool assignValue=true) const
	Emit definitions for all shader variables in a block. More...

virtual void	emitVariableDeclaration (const ShaderPort *variable, const string &qualifier, GenContext &context, ShaderStage &stage, bool assignValue=true) const
	Emit definition of a single shader variable. More...

virtual void	getClosureContexts (const ShaderNode &node, vector< ClosureContext * > &cct) const
	Return the closure contexts defined for the given node. More...

virtual string	getUpstreamResult (const ShaderInput *input, GenContext &context) const
	Return the result of an upstream connection or value for an input. More...

const Syntax &	getSyntax () const
	Return the syntax object for the language used by the code generator.

void	registerImplementation (const string &name, CreatorFunction< ShaderNodeImpl > creator)
	Register a shader node implementation for a given implementation element name.

void	registerImplementation (const StringVec &nameVec, CreatorFunction< ShaderNodeImpl > creator)
	Register a shader node implementation for a given set of implementation element names.

bool	implementationRegistered (const string &name) const
	Determine if a shader node implementation has been registered for a given implementation element name.

virtual ShaderNodeImplPtr	getImplementation (const NodeDef &nodedef, GenContext &context) const
	Return a registered shader node implementation for the given nodedef. More...

void	setColorManagementSystem (ColorManagementSystemPtr colorManagementSystem)
	Sets the color management system.

ColorManagementSystemPtr	getColorManagementSystem () const
	Returns the color management system.

void	setUnitSystem (UnitSystemPtr unitSystem)
	Sets the unit system.

UnitSystemPtr	getUnitSystem () const
	Returns the unit system.

const StringMap &	getTokenSubstitutions () const
	Return the map of token substitutions used by the generator.

virtual void	registerShaderMetadata (const DocumentPtr &doc, GenContext &context) const
	Register metadata that should be exported to the generated shaders. More...

Protected Member Functions
	ShaderGenerator (SyntaxPtr syntax)
	Protected constructor.

virtual ShaderStagePtr	createStage (const string &name, Shader &shader) const
	Create a new stage in a shader.

void	setFunctionName (const string &functionName, ShaderStage &stage) const
	Set function name for a stage.

void	replaceTokens (const StringMap &substitutions, ShaderStage &stage) const
	Replace tokens with identifiers according to the given substitutions map.

void	createVariables (ShaderGraphPtr graph, GenContext &context, Shader &shader) const
	Create shader variables (e.g. More...

Protected Attributes
SyntaxPtr	_syntax

Factory< ShaderNodeImpl >	_implFactory

ColorManagementSystemPtr	_colorManagementSystem

UnitSystemPtr	_unitSystem

StringMap	_tokenSubstitutions

friend	ShaderGraph

Static Protected Attributes
static const string	T_FILE_TRANSFORM_UV = "$fileTransformUv"

Detailed Description

Base class for shader generators All third-party shader generators should derive from this class.

Derived classes should use DECLARE_SHADER_GENERATOR / DEFINE_SHADER_GENERATOR in their declaration / definition, and register with the Registry class.

Member Function Documentation

◆ createVariables()

void createVariables	(	ShaderGraphPtr	graph,
		GenContext &	context,
		Shader &	shader
	)		const

protected

Create shader variables (e.g.

uniforms, inputs and outputs) for nodes that require input data from the application.

◆ emitDependentFunctionCalls()

void emitDependentFunctionCalls	(	const ShaderNode &	node,
		GenContext &	context,
		ShaderStage &	stage,
		uint32_t	classification = `0u`
	)		const

virtual

Add function calls for nodes connected directly upstream from the given node.

If a classification mask is given only functions for nodes matching this classification will be emitted.

◆ emitFunctionBodyBegin()

void emitFunctionBodyBegin	(	const ShaderNode &	node,
		GenContext &	context,
		ShaderStage &	stage,
		Syntax::Punctuation	punc = `Syntax::CURLY_BRACKETS`
	)		const

virtual

Emit code for starting a new function body.

Reimplemented in OslShaderGenerator.

◆ emitFunctionCall()

void emitFunctionCall	(	const ShaderNode &	node,
		GenContext &	context,
		ShaderStage &	stage
	)		const

virtual

Add the function call for a single node.

Reimplemented in HwShaderGenerator.

◆ emitFunctionCalls()

void emitFunctionCalls	(	const ShaderGraph &	graph,
		GenContext &	context,
		ShaderStage &	stage,
		uint32_t	classification = `0u`
	)		const

virtual

Add all function calls for a graph.

If a classification mask is given only functions for nodes matching this classification will be emitted.

Reimplemented in OslShaderGenerator.

◆ emitLibraryInclude()

void emitLibraryInclude	(	const FilePath &	filename,
		GenContext &	context,
		ShaderStage &	stage
	)		const

virtual

Add the contents of a standard library include file if not already present.

The library file prefix of the given context, if any, will be prepended to the given filename.

◆ emitVariableDeclaration()

void emitVariableDeclaration	(	const ShaderPort *	variable,
		const string &	qualifier,
		GenContext &	context,
		ShaderStage &	stage,
		bool	assignValue = `true`
	)		const

virtual

Emit definition of a single shader variable.

Parameters

variable	Shader port representing the variable.
qualifier	Optional qualifier to add before the variable declaration.
context	Context for generation.
stage	The stage to emit code into.
assignValue	If true the variable is initialized with its value.

Reimplemented in GlslShaderGenerator.

◆ emitVariableDeclarations()

void emitVariableDeclarations	(	const VariableBlock &	block,
		const string &	qualifier,
		const string &	separator,
		GenContext &	context,
		ShaderStage &	stage,
		bool	assignValue = `true`
	)		const

virtual

Emit definitions for all shader variables in a block.

Parameters

block	Block to emit.
qualifier	Optional qualifier to add before the variable declaration.
separator	Separator to use between the declarations.
context	Context for generation.
stage	The stage to emit code into.
assignValue	If true the variables are initialized with their value.

◆ generate()

virtual ShaderPtr generate	(	const string &	,
		ElementPtr	,
		GenContext &
	)		const

inlinevirtual

Generate a shader starting from the given element, translating the element and all dependencies upstream into shader code.

Reimplemented in GlslShaderGenerator, MdlShaderGenerator, and OslShaderGenerator.

◆ getClosureContexts()

void getClosureContexts	(	const ShaderNode &	node,
		vector< ClosureContext * > &	cct
	)		const

virtual

Return the closure contexts defined for the given node.

Reimplemented in HwShaderGenerator.

◆ getImplementation()

ShaderNodeImplPtr getImplementation	(	const NodeDef &	nodedef,
		GenContext &	context
	)		const

virtual

Return a registered shader node implementation for the given nodedef.

Reimplemented in GlslShaderGenerator, and MdlShaderGenerator.

◆ getTarget()

virtual const string & getTarget ( ) const

inlinevirtual

Return the name of the target this generator is for.

Reimplemented in EsslShaderGenerator, GlslShaderGenerator, VkShaderGenerator, MdlShaderGenerator, and OslShaderGenerator.

◆ getUpstreamResult()

string getUpstreamResult	(	const ShaderInput *	input,
		GenContext &	context
	)		const

virtual

Return the result of an upstream connection or value for an input.

Reimplemented in MdlShaderGenerator.

◆ registerShaderMetadata()

void registerShaderMetadata	(	const DocumentPtr &	doc,
		GenContext &	context
	)		const

virtual

Register metadata that should be exported to the generated shaders.

Supported metadata includes standard UI attributes like "uiname", "uifolder", "uimin", "uimax", etc. But it is also extendable by defining custom attributes using AttributeDefs. Any AttributeDef in the given document with exportable="true" will be exported as shader metadata when found on nodes during shader generation. Derived shader generators may override this method to change the registration. Applications must explicitly call this method before shader generation to enable export of metadata.

Reimplemented in OslShaderGenerator.

The documentation for this class was generated from the following files:

source/MaterialXGenShader/ShaderGenerator.h
source/MaterialXGenShader/ShaderGenerator.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ createVariables()

◆ emitDependentFunctionCalls()

◆ emitFunctionBodyBegin()

◆ emitFunctionCall()

◆ emitFunctionCalls()

◆ emitLibraryInclude()

◆ emitVariableDeclaration()

◆ emitVariableDeclarations()

◆ generate()

◆ getClosureContexts()

◆ getImplementation()

◆ getTarget()

◆ getUpstreamResult()

◆ registerShaderMetadata()