om::graphics::materials::ShaderBinding Class Reference

A class used to represent the binding between a shader variable name and information about its usage. More...

#include <omGraphicsShaderBinding.h>

Inheritance diagram for om::graphics::materials::ShaderBinding:

Public Member Functions
	ShaderBinding ()
	Create a shader binding with no name and the default flags. More...
	ShaderBinding (const ShaderSourceString &newName, const ShaderBindingFlags &newFlags)
	Create a shader binding with the given name and flags. More...
const ShaderSourceString &	getName () const
	Return a string representing the name of the shader binding's variable. More...
void	setName (const ShaderSourceString &newName)
	Set a string representing the name of the shader binding's variable. More...
ShaderBindingFlags &	getFlags ()
	Return a reference to an object that contains boolean parameters of the shader binding. More...
const ShaderBindingFlags &	getFlags () const
	Return an object that contains boolean parameters of the shader binding. More...
void	setFlags (const ShaderBindingFlags &newFlags)
	Set an object that contains boolean parameters of the shader binding. More...
Bool	flagIsSet (ShaderBindingFlags::Flag flag) const
	Return whether or not the specified boolan flag is set for this shader binding. More...
void	setFlag (ShaderBindingFlags::Flag flag, Bool newIsSet=true)
	Set whether or not the specified boolan flag is set for this shader binding. More...
Bool	getIsDynamicInput () const
	Return whether or not this shader binding is a dynamic input. More...
void	setIsDynamicInput (Bool newIsInput)
	Set whether or not this shader binding is a dynamic input. More...

Protected Attributes
ShaderSourceString	name
	A string representing the name of the shader binding. More...
ShaderBindingFlags	flags
	An object that contains boolean configuration information for the binding. More...

Detailed Description

A class used to represent the binding between a shader variable name and information about its usage.

Constructor & Destructor Documentation

om::graphics::materials::ShaderBinding::ShaderBinding ( )

inline

Create a shader binding with no name and the default flags.

om::graphics::materials::ShaderBinding::ShaderBinding ( const ShaderSourceString &  newName, const ShaderBindingFlags &  newFlags  )

inline

Create a shader binding with the given name and flags.

Member Function Documentation

const ShaderSourceString& om::graphics::materials::ShaderBinding::getName ( ) const

inline

Return a string representing the name of the shader binding's variable.

void om::graphics::materials::ShaderBinding::setName ( const ShaderSourceString &  newName )

inline

Set a string representing the name of the shader binding's variable.

ShaderBindingFlags& om::graphics::materials::ShaderBinding::getFlags ( )

inline

Return a reference to an object that contains boolean parameters of the shader binding.

const ShaderBindingFlags& om::graphics::materials::ShaderBinding::getFlags ( ) const

inline

Return an object that contains boolean parameters of the shader binding.

void om::graphics::materials::ShaderBinding::setFlags ( const ShaderBindingFlags &  newFlags )

inline

Set an object that contains boolean parameters of the shader binding.

Bool om::graphics::materials::ShaderBinding::flagIsSet ( ShaderBindingFlags::Flag  flag ) const

inline

Return whether or not the specified boolan flag is set for this shader binding.

void om::graphics::materials::ShaderBinding::setFlag ( ShaderBindingFlags::Flag  flag, Bool  newIsSet = true  )

inline

Set whether or not the specified boolan flag is set for this shader binding.

Bool om::graphics::materials::ShaderBinding::getIsDynamicInput ( ) const

inline

Return whether or not this shader binding is a dynamic input.

If so, the renderer can provide dynamic scene information for this binding (such as nearby lights, textures, etc) that aren't explicitly part of this binding. By default, all bindings are inputs.

void om::graphics::materials::ShaderBinding::setIsDynamicInput ( Bool  newIsInput )

inline

Set whether or not this shader binding is a dynamic input.

If so, the renderer can provide dynamic scene information for this binding (such as nearby lights, textures, etc) that aren't explicitly part of this binding.

Member Data Documentation

ShaderSourceString om::graphics::materials::ShaderBinding::name

protected

A string representing the name of the shader binding.

ShaderBindingFlags om::graphics::materials::ShaderBinding::flags

protected

An object that contains boolean configuration information for the binding.

---

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

• omGraphicsShaderBinding.h