MaterialX 1.39.1
Loading...
Searching...
No Matches
GlslShaderGenerator.h
Go to the documentation of this file.
1//
2// Copyright Contributors to the MaterialX Project
3// SPDX-License-Identifier: Apache-2.0
4//
5
6#ifndef MATERIALX_GLSLSHADERGENERATOR_H
7#define MATERIALX_GLSLSHADERGENERATOR_H
8
11
13
15
16MATERIALX_NAMESPACE_BEGIN
17
18using GlslShaderGeneratorPtr = shared_ptr<class GlslShaderGenerator>;
19
22class MX_GENGLSL_API GlslShaderGenerator : public HwShaderGenerator
23{
24 public:
26
27 static ShaderGeneratorPtr create() { return std::make_shared<GlslShaderGenerator>(); }
28
31 ShaderPtr generate(const string& name, ElementPtr element, GenContext& context) const override;
32
34 const string& getTarget() const override { return TARGET; }
35
37 virtual const string& getVersion() const { return VERSION; }
38
40 void emitVariableDeclaration(const ShaderPort* variable, const string& qualifier, GenContext& context, ShaderStage& stage,
41 bool assignValue = true) const override;
42
45 ShaderNodeImplPtr getImplementation(const NodeDef& nodedef, GenContext& context) const override;
46
48 string getVertexDataPrefix(const VariableBlock& vertexData) const override;
49
50 public:
52 static const string TARGET;
53
55 static const string VERSION;
56
57 protected:
58 virtual void emitVertexStage(const ShaderGraph& graph, GenContext& context, ShaderStage& stage) const;
59 virtual void emitPixelStage(const ShaderGraph& graph, GenContext& context, ShaderStage& stage) const;
60
61 virtual void emitDirectives(GenContext& context, ShaderStage& stage) const;
62 virtual void emitConstants(GenContext& context, ShaderStage& stage) const;
63 virtual void emitUniforms(GenContext& context, ShaderStage& stage) const;
64 virtual void emitLightData(GenContext& context, ShaderStage& stage) const;
65 virtual void emitInputs(GenContext& context, ShaderStage& stage) const;
66 virtual void emitOutputs(GenContext& context, ShaderStage& stage) const;
67
68 virtual HwResourceBindingContextPtr getResourceBindingContext(GenContext& context) const;
69
73 virtual bool requiresLighting(const ShaderGraph& graph) const;
74
76 virtual void emitSpecularEnvironment(GenContext& context, ShaderStage& stage) const;
77
79 virtual void emitTransmissionRender(GenContext& context, ShaderStage& stage) const;
80
82 virtual void emitLightFunctionDefinitions(const ShaderGraph& graph, GenContext& context, ShaderStage& stage) const;
83
84 static void toVec4(TypeDesc type, string& variable);
85 [[deprecated]] static void toVec4(const TypeDesc* type, string& variable) { toVec4(*type, variable); }
86
88 vector<ShaderNodePtr> _lightSamplingNodes;
89};
90
92class MX_GENGLSL_API GlslImplementation : public HwImplementation
93{
94 public:
95 const string& getTarget() const override;
96
97 protected:
99};
100
101MATERIALX_NAMESPACE_END
102
103#endif
shared_ptr< Element > ElementPtr
A shared pointer to an Element.
Definition: Element.h:31
Hardware shader generator base class.
shared_ptr< class HwResourceBindingContext > HwResourceBindingContextPtr
Shared pointer to a HwResourceBindingContext.
Definition: HwShaderGenerator.h:239
Macros for declaring imported and exported symbols.
shared_ptr< Shader > ShaderPtr
Shared pointer to a Shader.
Definition: Library.h:34
shared_ptr< ShaderNodeImpl > ShaderNodeImplPtr
Shared pointer to a ShaderNodeImpl.
Definition: Library.h:40
shared_ptr< ShaderGenerator > ShaderGeneratorPtr
Shared pointer to a ShaderGenerator.
Definition: Library.h:38
A context class for shader generation.
Definition: GenContext.h:31
Base class for common GLSL node implementations.
Definition: GlslShaderGenerator.h:93
const string & getTarget() const override
Return an identifier for the target used by this implementation.
Base class for GLSL (OpenGL Shading Language) code generation.
Definition: GlslShaderGenerator.h:23
const string & getTarget() const override
Return a unique identifier for the target this generator is for.
Definition: GlslShaderGenerator.h:34
virtual void emitLightFunctionDefinitions(const ShaderGraph &graph, GenContext &context, ShaderStage &stage) const
Emit function definitions for lighting code.
virtual const string & getVersion() const
Return the version string for the GLSL version this generator is for.
Definition: GlslShaderGenerator.h:37
vector< ShaderNodePtr > _lightSamplingNodes
Nodes used internally for light sampling.
Definition: GlslShaderGenerator.h:88
static const string TARGET
Unique identifier for this generator target.
Definition: GlslShaderGenerator.h:52
ShaderPtr generate(const string &name, ElementPtr element, GenContext &context) const override
Generate a shader starting from the given element, translating the element and all dependencies upstr...
virtual bool requiresLighting(const ShaderGraph &graph) const
Logic to indicate whether code to support direct lighting should be emitted.
void emitVariableDeclaration(const ShaderPort *variable, const string &qualifier, GenContext &context, ShaderStage &stage, bool assignValue=true) const override
Emit a shader variable.
virtual void emitSpecularEnvironment(GenContext &context, ShaderStage &stage) const
Emit specular environment lookup code.
string getVertexDataPrefix(const VariableBlock &vertexData) const override
Determine the prefix of vertex data variables.
virtual void emitTransmissionRender(GenContext &context, ShaderStage &stage) const
Emit transmission rendering code.
static const string VERSION
Version string for the generator target.
Definition: GlslShaderGenerator.h:55
ShaderNodeImplPtr getImplementation(const NodeDef &nodedef, GenContext &context) const override
Return a registered shader node implementation given an implementation element.
Definition: HwShaderGenerator.h:349
Base class for shader generators targeting HW rendering.
Definition: HwShaderGenerator.h:291
A node definition element within a Document.
Definition: Definition.h:82
Class representing a graph (DAG) for shader generation.
Definition: ShaderGraph.h:44
An input or output port on a ShaderNode.
Definition: ShaderNode.h:123
A shader stage, containing the state and resulting source code for the stage.
Definition: ShaderStage.h:139
A type descriptor for MaterialX data types.
Definition: TypeDesc.h:35
A block of variables in a shader stage.
Definition: ShaderStage.h:61