VariableBlock Class Reference

A block of variables in a shader stage. More...

#include <ShaderStage.h>

Public Member Functions
	VariableBlock (const string &name, const string &instance)
const string &	getName () const
	Get the name of this block.
void	setName (const string &name)
	Set the name of this block.
const string &	getInstance () const
	Get the instance name of this block.
void	setInstance (const string &instance)
	Set the instance name of this block.
bool	empty () const
	Return true if the block has no variables.
size_t	size () const
	Return the number of variables in this block.
ShaderPort *	operator[] (size_t index)
	Return a variable by index.
const ShaderPort *	operator[] (size_t index) const
	Return a variable by index.
const vector< ShaderPort * > &	getVariableOrder () const
	Return a const reference to our variable order vector.
ShaderPort *	operator[] (const string &name)
	Return a variable by name.
const ShaderPort *	operator[] (const string &name) const
	Return a variable by name.
ShaderPort *	find (const string &name)
	Return a variable by name.
const ShaderPort *	find (const string &name) const
	Return a variable by name.
ShaderPort *	find (const ShaderPortPredicate &predicate)
	Find a port based on a predicate.
ShaderPort *	add (TypeDesc type, const string &name, ValuePtr value=nullptr, bool shouldWiden=false)
	Add a new shader port to this block.
void	add (ShaderPortPtr port)
	Add an existing shader port to this block.

Detailed Description

A block of variables in a shader stage.

Member Function Documentation

add()

ShaderPort * add	(	TypeDesc	type,
		const string &	name,
		ValuePtr	value = nullptr,
		bool	shouldWiden = false )

Add a new shader port to this block.

Parameters

type	The desired shader port type
name	The shader port name
value	The value to attach to the shader port
shouldWiden	When false, an exception is thrown if the type of the existing port with the same name does not match the requested type. When true, the types can mismatch, and the type of any existing port is widened to match the requested type when necessary.

Returns

A new shader port, or a pre-existing shader port with the same name.

find() [1/2]

ShaderPort * find

(

const string &

name

)

Return a variable by name.

Returns nullptr if no variable is found by the given name.

find() [2/2]

const ShaderPort * find

(

const string &

name

)

const

Return a variable by name.

Returns nullptr if no variable is found by the given name.

operator[]() [1/2]

ShaderPort * operator[]

(

const string &

name

)

Return a variable by name.

Throws exception if no variable is found by the given name.

operator[]() [2/2]

const ShaderPort * operator[]

(

const string &

name

)

const

Return a variable by name.

Throws exception if no variable is found by the given name.

---

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

• source/MaterialXGenShader/ShaderStage.h