om::graphics::materials::TextureBinding Class Reference

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

#include <omGraphicsTextureBinding.h>

Inheritance diagram for om::graphics::materials::TextureBinding:

Public Member Functions
	TextureBinding ()
	Create a new texture binding object with no name, UNDEFINED usage, and no texture. More...
	TextureBinding (const ShaderSourceString &newName, const ShaderBindingFlags &newFlags, const TextureUsage &newUsage, const TextureType &newType, Size newArraySize, Index newOffset)
	Create a new texture binding with the specified name, flags, usage, type, array size, and offset in the texture storage. More...
const TextureUsage &	getUsage () const
	Return the semantic usage for this texture binding. More...
void	setUsage (const TextureUsage &newUsage)
	Set an enum value indicating the semantic usage of this texture binding. More...
const TextureType &	getType () const
	Return the type of texture stored by this texture binding. More...
void	setUsage (const TextureType &newType)
	Set the type of texture stored by this texture binding. More...
Index	getArraySize () const
	Return the number of textures that are part of this binding's texture array. More...
void	setArraySize (Size newArraySize)
	Set the number of textures that are part of this binding's texture array. More...
Index	getOffset () const
	Return the offset for this binding's array of textures in the shader pass's texture storage. More...
void	setOffset (Index newOffset)
	Set the offset for this binding's array of textures in the shader pass's texture 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 texture shader variable and its texture and usage.

Constructor & Destructor Documentation

om::graphics::materials::TextureBinding::TextureBinding ( )

inline

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

om::graphics::materials::TextureBinding::TextureBinding ( const ShaderSourceString &  newName, const ShaderBindingFlags &  newFlags, const TextureUsage &  newUsage, const TextureType &  newType, Size  newArraySize, Index  newOffset  )

inline

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

Member Function Documentation

const TextureUsage& om::graphics::materials::TextureBinding::getUsage ( ) const

inline

Return the semantic usage for this texture binding.

void om::graphics::materials::TextureBinding::setUsage ( const TextureUsage &  newUsage )

inline

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

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

inline

Return the type of texture stored by this texture binding.

void om::graphics::materials::TextureBinding::setUsage ( const TextureType &  newType )

inline

Set the type of texture stored by this texture binding.

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

inline

Return the number of textures that are part of this binding's texture array.

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

inline

Set the number of textures that are part of this binding's texture array.

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

inline

Return the offset for this binding's array of textures in the shader pass's texture storage.

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

inline

Set the offset for this binding's array of textures in the shader pass's texture storage.

---

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

• omGraphicsTextureBinding.h