om::graphics::materials::TextureVariable Class Reference

A class that represents a shader texture input variable. More...

#include <omGraphicsTextureVariable.h>

Public Member Functions
	TextureVariable (const ShaderSourceString &newName, const TextureType &newType, ShaderVariableLocation newLocation, Size newArraySize=Size(1))
	Create a texture variable with the specified name, type, and identifier. More...
const ShaderSourceString &	getName () const
	Get the name of the texture variable in the shader source code. More...
const TextureType &	getType () const
	Get the type of this texture variable within the shader. More...
ShaderVariableLocation	getLocation () const
	Return the implementation-defined location for the texture 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 represents a shader texture input variable.

A TextureVariable object contains a description of a texture input variable in a shader's source code. The description consists of the variable's name, the type of the texture variable, and an integral identifier for the texture variable within the shader.

Constructor & Destructor Documentation

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

inline

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

Member Function Documentation

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

inline

Get the name of the texture variable in the shader source code.

const TextureType& om::graphics::materials::TextureVariable::getType ( ) const

inline

Get the type of this texture variable within the shader.

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

inline

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

Size om::graphics::materials::TextureVariable::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::TextureVariable::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:

• omGraphicsTextureVariable.h