#include <HwShaderGenerator.h>

Inheritance diagram for HwShaderGenerator:

Public Types
enum	ClosureContextType { DEFAULT, REFLECTION, TRANSMISSION, INDIRECT, EMISSION, LIGHTING, CLOSURE }
	Types of closure contexts for HW. More...

Public Member Functions
virtual void	addStageLightingUniforms (GenContext &context, ShaderStage &stage) const
	Emit code for active light count definitions and uniforms. More...

bool	nodeNeedsClosureData (const ShaderNode &node) const override
	Return true if the node needs the ClosureData struct added. More...

virtual string	getVertexDataPrefix (const VariableBlock &vertexData) const =0
	Determine the prefix of vertex data variables. More...

Public Member Functions inherited from ShaderGenerator
virtual	~ShaderGenerator ()
	Destructor. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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. More...

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

virtual void	emitInput (const ShaderInput *input, GenContext &context, ShaderStage &stage) const

virtual void	emitOutput (const ShaderOutput *output, bool includeType, bool assignValue, GenContext &context, ShaderStage &stage) const

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

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

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. More...

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

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

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

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. More...

ColorManagementSystemPtr	getColorManagementSystem () const
	Returns the color management system. More...

void	setUnitSystem (UnitSystemPtr unitSystem)
	Sets the unit system. More...

UnitSystemPtr	getUnitSystem () const
	Returns the unit system. More...

TypeSystemPtr	getTypeSystem () const
	Returns the type system. More...

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

virtual void	registerTypeDefs (const DocumentPtr &doc)
	Register type definitions from the document. More...

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

Static Public Member Functions
static void	bindLightShader (const NodeDef &nodeDef, unsigned int lightTypeId, GenContext &context)

static void	unbindLightShader (unsigned int lightTypeId, GenContext &context)
	Unbind a light shader previously bound to the given light type id. More...

static void	unbindLightShaders (GenContext &context)
	Unbind all light shaders previously bound. More...

Protected Member Functions
	HwShaderGenerator (TypeSystemPtr typeSystem, SyntaxPtr syntax)

virtual ShaderPtr	createShader (const string &name, ElementPtr element, GenContext &context) const
	Create and initialize a new HW shader for shader generation. More...

Protected Member Functions inherited from ShaderGenerator
	ShaderGenerator (TypeSystemPtr typeSystem, SyntaxPtr syntax)
	Protected constructor. More...

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

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

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

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

Additional Inherited Members
Protected Attributes inherited from ShaderGenerator
TypeSystemPtr	_typeSystem

SyntaxPtr	_syntax

Factory< ShaderNodeImpl >	_implFactory

ColorManagementSystemPtr	_colorManagementSystem

UnitSystemPtr	_unitSystem

StringMap	_tokenSubstitutions

friend	ShaderGraph

Static Protected Attributes inherited from ShaderGenerator
static const string	T_FILE_TRANSFORM_UV

Detailed Description

Base class for shader generators targeting HW rendering.

Definition at line 295 of file HwShaderGenerator.h.

Member Enumeration Documentation

enum HwShaderGenerator::ClosureContextType

Types of closure contexts for HW.

Enumerator
DEFAULT
REFLECTION
TRANSMISSION
INDIRECT
EMISSION
LIGHTING
CLOSURE

Definition at line 323 of file HwShaderGenerator.h.

Constructor & Destructor Documentation

HwShaderGenerator::HwShaderGenerator	(	TypeSystemPtr	typeSystem,
		SyntaxPtr	syntax
	)

protected

Member Function Documentation

virtual void HwShaderGenerator::addStageLightingUniforms	(	GenContext &	context,
		ShaderStage &	stage
	)		const

virtual

Emit code for active light count definitions and uniforms.

static void HwShaderGenerator::bindLightShader	(	const NodeDef &	nodeDef,
		unsigned int	lightTypeId,
		GenContext &	context
	)

static

Bind a light shader to a light type id, for usage in surface shaders created by the generator. The lightTypeId should be a unique identifier for the light type (node definition) and the same id should be used when setting light parameters on a generated surface shader.

virtual ShaderPtr HwShaderGenerator::createShader	(	const string &	name,
		ElementPtr	element,
		GenContext &	context
	)		const

protectedvirtual

Create and initialize a new HW shader for shader generation.

virtual string HwShaderGenerator::getVertexDataPrefix ( const VariableBlock & vertexData ) const

pure virtual

Determine the prefix of vertex data variables.

Implemented in MslShaderGenerator, GlslShaderGenerator, VkShaderGenerator, and EsslShaderGenerator.

bool HwShaderGenerator::nodeNeedsClosureData ( const ShaderNode & node ) const

overridevirtual

Return true if the node needs the ClosureData struct added.

Reimplemented from ShaderGenerator.

static void HwShaderGenerator::unbindLightShader	(	unsigned int	lightTypeId,
		GenContext &	context
	)

static

Unbind a light shader previously bound to the given light type id.

static void HwShaderGenerator::unbindLightShaders ( GenContext & context )

static

Unbind all light shaders previously bound.

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

MaterialXGenShader/HwShaderGenerator.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation