MaterialX 1.39.2
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
HwShaderGenerator Class Referenceabstract

Base class for shader generators targeting HW rendering. More...

#include <HwShaderGenerator.h>

Inheritance diagram for HwShaderGenerator:
ShaderGenerator GlslShaderGenerator EsslShaderGenerator VkShaderGenerator

Public Types

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

Public Member Functions

void emitFunctionCall (const ShaderNode &node, GenContext &context, ShaderStage &stage) const override
 Add the function call for a single node.
 
virtual void addStageLightingUniforms (GenContext &context, ShaderStage &stage) const
 Emit code for active light count definitions and uniforms.
 
void getClosureContexts (const ShaderNode &node, vector< ClosureContext * > &cct) const override
 Return the closure contexts defined for the given node.
 
virtual string getVertexDataPrefix (const VariableBlock &vertexData) const =0
 Determine the prefix of vertex data variables.
 
- Public Member Functions inherited from ShaderGenerator
virtual ~ShaderGenerator ()
 Destructor.
 
virtual const string & getTarget () const
 Return the name of the target this generator is for.
 
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.
 
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.
 
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, 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.
 
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.
 
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.
 
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.
 
virtual void emitVariableDeclaration (const ShaderPort *variable, const string &qualifier, GenContext &context, ShaderStage &stage, bool assignValue=true) const
 Emit definition of a single shader variable.
 
virtual string getUpstreamResult (const ShaderInput *input, GenContext &context) const
 Return the result of an upstream connection or value for an input.
 
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.
 
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.
 
void loadStructTypeDefs (const DocumentPtr &doc)
 Load any struct type definitions from the document in to the type cache.
 
void clearStructTypeDefs ()
 Clear any struct type definitions loaded.
 
virtual void registerShaderMetadata (const DocumentPtr &doc, GenContext &context) const
 Register metadata that should be exported to the generated shaders.
 

Static Public Member Functions

static void bindLightShader (const NodeDef &nodeDef, unsigned int lightTypeId, GenContext &context)
 Bind a light shader to a light type id, for usage in surface shaders created by the generator.
 
static void unbindLightShader (unsigned int lightTypeId, GenContext &context)
 Unbind a light shader previously bound to the given light type id.
 
static void unbindLightShaders (GenContext &context)
 Unbind all light shaders previously bound.
 

Static Public Attributes

static const string CLOSURE_CONTEXT_SUFFIX_REFLECTION
 String constants for closure context suffixes.
 
static const string CLOSURE_CONTEXT_SUFFIX_TRANSMISSION
 
static const string CLOSURE_CONTEXT_SUFFIX_INDIRECT
 

Protected Member Functions

 HwShaderGenerator (SyntaxPtr syntax)
 
virtual ShaderPtr createShader (const string &name, ElementPtr element, GenContext &context) const
 Create and initialize a new HW shader for shader generation.
 
- Protected Member Functions inherited from ShaderGenerator
 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.
 

Protected Attributes

ClosureContext _defDefault
 Closure contexts for defining closure functions.
 
ClosureContext _defReflection
 
ClosureContext _defTransmission
 
ClosureContext _defIndirect
 
ClosureContext _defEmission
 
- Protected Attributes inherited from ShaderGenerator
SyntaxPtr _syntax
 
Factory< ShaderNodeImpl > _implFactory
 
ColorManagementSystemPtr _colorManagementSystem
 
UnitSystemPtr _unitSystem
 
StringMap _tokenSubstitutions
 
friend ShaderGraph
 

Additional Inherited Members

- Static Protected Attributes inherited from ShaderGenerator
static const string T_FILE_TRANSFORM_UV
 

Detailed Description

Base class for shader generators targeting HW rendering.

Member Function Documentation

◆ bindLightShader()

static void 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.

◆ emitFunctionCall()

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

Add the function call for a single node.

Reimplemented from ShaderGenerator.

◆ getClosureContexts()

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

Return the closure contexts defined for the given node.

Reimplemented from ShaderGenerator.

◆ getVertexDataPrefix()

virtual string getVertexDataPrefix ( const VariableBlock & vertexData) const
pure virtual

Determine the prefix of vertex data variables.

Implemented in EsslShaderGenerator, GlslShaderGenerator, and VkShaderGenerator.

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