om::graphics::materials::VertexBinding Class Reference

A class used to represent the binding between a per-vertex shader variable and its buffer and usage. More...

#include <omGraphicsVertexBinding.h>

Inheritance diagram for om::graphics::materials::VertexBinding:

Public Member Functions
	VertexBinding ()
	Create a new vertex binding object with no name, UNDEFINED usage, and no buffer. More...
	VertexBinding (const ShaderSourceString &newName, const ShaderBindingFlags &newFlags, const VertexUsage &newUsage, Size newArraySize, Index newOffset)
	Create a new vertex binding with the specified name, flags, usage, type, array size, and offset in the buffer storage. More...
const VertexUsage &	getUsage () const
	Return the semantic usage for this shader attribute binding. More...
void	setUsage (const VertexUsage &newUsage)
	Set an enum value indicating the semantic usage of this vertex binding. More...
Index	getArraySize () const
	Return the number of buffers that are part of this binding's buffer array. More...
void	setArraySize (Size newArraySize)
	Set the number of buffers that are part of this binding's buffer array. More...
Index	getOffset () const
	Return the offset for this binding's array of buffers in the shader pass's buffer storage. More...
void	setOffset (Index newOffset)
	Set the offset for this binding's array of buffers in the shader pass's buffer storage. More...
Public Member Functions inherited from om::graphics::materials::ShaderBinding
	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...

Additional Inherited Members
Protected Attributes inherited from om::graphics::materials::ShaderBinding
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 per-vertex shader variable and its buffer and usage.

Constructor & Destructor Documentation

om::graphics::materials::VertexBinding::VertexBinding ( )

inline

Create a new vertex binding object with no name, UNDEFINED usage, and no buffer.

om::graphics::materials::VertexBinding::VertexBinding ( const ShaderSourceString &  newName, const ShaderBindingFlags &  newFlags, const VertexUsage &  newUsage, Size  newArraySize, Index  newOffset  )

inline

Create a new vertex binding with the specified name, flags, usage, type, array size, and offset in the buffer storage.

Member Function Documentation

const VertexUsage& om::graphics::materials::VertexBinding::getUsage ( ) const

inline

Return the semantic usage for this shader attribute binding.

void om::graphics::materials::VertexBinding::setUsage ( const VertexUsage &  newUsage )

inline

Set an enum value indicating the semantic usage of this vertex binding.

Index om::graphics::materials::VertexBinding::getArraySize ( ) const

inline

Return the number of buffers that are part of this binding's buffer array.

void om::graphics::materials::VertexBinding::setArraySize ( Size  newArraySize )

inline

Set the number of buffers that are part of this binding's buffer array.

Index om::graphics::materials::VertexBinding::getOffset ( ) const

inline

Return the offset for this binding's array of buffers in the shader pass's buffer storage.

void om::graphics::materials::VertexBinding::setOffset ( Index  newOffset )

inline

Set the offset for this binding's array of buffers in the shader pass's buffer storage.

---

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

• omGraphicsVertexBinding.h