om::graphics::materials::VertexVariable Class Reference

A class that provides a desciption of a per-vertex shader input variable. More...

#include <omGraphicsVertexVariable.h>

Public Member Functions
	VertexVariable (const ShaderSourceString &newName, const AttributeType &newType, ShaderVariableLocation newLocation, Size newArraySize=Size(1))
	Create a vertex variable with the specified name, type, and identifier. More...
const ShaderSourceString &	getName () const
	Return the name of the vertex variable in the shader source code. More...
const AttributeType &	getType () const
	Return the type of the vertex variable. More...
ShaderVariableLocation	getLocation () const
	Return the implementation-defined location for the vertex variable within the shader. More...
Size	getArraySize () const
	Return the number of elements that are in the array starting at this variable. More...
Bool	isArray () const
	Return whether or not this shader variable denotes the start of its array. More...

Detailed Description

A class that provides a desciption of a per-vertex shader input variable.

A VertexVariable object contains a description of a per-vertex input variable from a shader's source code. These are variables that are specified for each vertex. The description consists of the variable's name, the type of the variable, and an integral location for the variable within the shader.

Constructor & Destructor Documentation

om::graphics::materials::VertexVariable::VertexVariable ( const ShaderSourceString &  newName, const AttributeType &  newType, ShaderVariableLocation  newLocation, Size  newArraySize = Size(1)  )

inline

Create a vertex variable with the specified name, type, and identifier.

Member Function Documentation

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

inline

Return the name of the vertex variable in the shader source code.

const AttributeType& om::graphics::materials::VertexVariable::getType ( ) const

inline

Return the type of the vertex variable.

ShaderVariableLocation om::graphics::materials::VertexVariable::getLocation ( ) const

inline

Return the implementation-defined location for the vertex variable within the shader.

Size om::graphics::materials::VertexVariable::getArraySize ( ) const

inline

Return the number of elements that are in the array starting at this variable.

For shader variables that are declared as arrays, this function will return the size of the static variable array. For shader variables that are not arrays, this function returns 1.

Bool om::graphics::materials::VertexVariable::isArray ( ) const

inline

Return whether or not this shader variable denotes the start of its array.

---

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

• omGraphicsVertexVariable.h