#include <OslShaderGenerator.h>

Inheritance diagram for OslShaderGenerator:

Public Member Functions
	OslShaderGenerator ()

const string &	getTarget () const override
	Return a unique identifier for the target this generator is for. More...

ShaderPtr	generate (const string &name, ElementPtr element, GenContext &context) const override

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

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

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

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

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	emitDependentFunctionCalls (const ShaderNode &node, GenContext &context, ShaderStage &stage, uint32_t classification=0u) const

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

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

Static Public Member Functions
static ShaderGeneratorPtr	create ()

Static Public Attributes
static const string	TARGET
	Unique identifier for this generator target. More...

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

virtual void	emitLibraryIncludes (ShaderStage &stage, GenContext &context) const
	Emit include headers needed by the generated shader code. More...

virtual void	emitShaderInputs (const VariableBlock &inputs, ShaderStage &stage) const
	Emit a block of shader inputs. More...

virtual void	emitShaderOutputs (const VariableBlock &inputs, ShaderStage &stage) const
	Emit a block of shader outputs. More...

Protected Member Functions inherited from ShaderGenerator
	ShaderGenerator (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

Static Protected Attributes
static const string	T_FILE_EXTRA_ARGUMENTS

Static Protected Attributes inherited from ShaderGenerator
static const string	T_FILE_TRANSFORM_UV

Additional Inherited Members
Protected Attributes inherited from ShaderGenerator
SyntaxPtr	_syntax

Factory< ShaderNodeImpl >	_implFactory

ColorManagementSystemPtr	_colorManagementSystem

UnitSystemPtr	_unitSystem

StringMap	_tokenSubstitutions

friend	ShaderGraph

Detailed Description

Base class for OSL (Open Shading Language) shader generators. A generator for a specific OSL target should be derived from this class.

Definition at line 23 of file OslShaderGenerator.h.

Constructor & Destructor Documentation

OslShaderGenerator::OslShaderGenerator ( )

Member Function Documentation

static ShaderGeneratorPtr OslShaderGenerator::create ( )

inlinestatic

Definition at line 28 of file OslShaderGenerator.h.

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

protectedvirtual

Create and initialize a new OSL shader for shader generation.

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

overridevirtual

Emit code for starting a new function body.

Reimplemented from ShaderGenerator.

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

overridevirtual

Add all function calls for a graph. If a classification mask is given only functions for nodes matching this classification will be emitted.

Reimplemented from ShaderGenerator.

virtual void OslShaderGenerator::emitLibraryIncludes	(	ShaderStage &	stage,
		GenContext &	context
	)		const

protectedvirtual

Emit include headers needed by the generated shader code.

virtual void OslShaderGenerator::emitShaderInputs	(	const VariableBlock &	inputs,
		ShaderStage &	stage
	)		const

protectedvirtual

Emit a block of shader inputs.

virtual void OslShaderGenerator::emitShaderOutputs	(	const VariableBlock &	inputs,
		ShaderStage &	stage
	)		const

protectedvirtual

Emit a block of shader outputs.

ShaderPtr OslShaderGenerator::generate	(	const string &	name,
		ElementPtr	element,
		GenContext &	context
	)		const

overridevirtual

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

Reimplemented from ShaderGenerator.

const string& OslShaderGenerator::getTarget ( ) const

inlineoverridevirtual

Return a unique identifier for the target this generator is for.

Reimplemented from ShaderGenerator.

Definition at line 31 of file OslShaderGenerator.h.

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

overridevirtual

Register metadata that should be exported to the generated shaders.

Reimplemented from ShaderGenerator.

Member Data Documentation

const string OslShaderGenerator::T_FILE_EXTRA_ARGUMENTS

staticprotected

Definition at line 52 of file OslShaderGenerator.h.

const string OslShaderGenerator::TARGET

static

Unique identifier for this generator target.

Definition at line 45 of file OslShaderGenerator.h.

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

MaterialXGenOsl/OslShaderGenerator.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation