om::graphics::materials::ShaderParameter Class Reference

A class that contains the entire state for a shader parameter. More...

#include <omGraphicsShaderParameter.h>

Public Member Functions
	ShaderParameter ()
	Create a new UNDEFINED shader parameter object with the value 0. More...
	ShaderParameter (const ShaderParameterInfo &newInfo, const ShaderParameterValue &newValue)
	Create a new shader parameter object with the specified info and value. More...
const ShaderParameterInfo &	getInfo () const
	Return an object describing information about this shader parameter. More...
void	setInfo (const ShaderParameterInfo &newInfo)
	Set an object describing information about this shader parameter. More...
const UTF8String &	getName () const
	Return a string representing the name for this shader parameter. More...
void	setName (const UTF8String &newName)
	Set a string representing the name for this shader parameter. More...
const ShaderParameterUsage &	getUsage () const
	Return an object describing the semantic usage of this shader parameter. More...
void	setUsage (const ShaderParameterUsage &newInfo)
	Set an object describing the semantic usage of this shader parameter. More...
const ShaderParameterFlags &	getFlags () const
	Return an object describing boolean flags of this shader parameter. More...
void	setFlags (const ShaderParameterFlags &newFlags)
	Set an object describing boolean flags of this shader parameter. More...
const ShaderParameterValue &	getValue () const
	Return an object that contains the value for this shader parameter. More...
void	setValue (const ShaderParameterValue &newValue)
	Set an object containing a new value for this shader parameter. More...

Detailed Description

A class that contains the entire state for a shader parameter.

This state includes information about the shader parameter as well as its value.

Constructor & Destructor Documentation

om::graphics::materials::ShaderParameter::ShaderParameter ( )

inline

Create a new UNDEFINED shader parameter object with the value 0.

om::graphics::materials::ShaderParameter::ShaderParameter ( const ShaderParameterInfo &  newInfo, const ShaderParameterValue &  newValue  )

inline

Create a new shader parameter object with the specified info and value.

Member Function Documentation

const ShaderParameterInfo& om::graphics::materials::ShaderParameter::getInfo ( ) const

inline

Return an object describing information about this shader parameter.

void om::graphics::materials::ShaderParameter::setInfo ( const ShaderParameterInfo &  newInfo )

inline

Set an object describing information about this shader parameter.

const UTF8String& om::graphics::materials::ShaderParameter::getName ( ) const

inline

Return a string representing the name for this shader parameter.

void om::graphics::materials::ShaderParameter::setName ( const UTF8String &  newName )

inline

Set a string representing the name for this shader parameter.

const ShaderParameterUsage& om::graphics::materials::ShaderParameter::getUsage ( ) const

inline

Return an object describing the semantic usage of this shader parameter.

void om::graphics::materials::ShaderParameter::setUsage ( const ShaderParameterUsage &  newInfo )

inline

Set an object describing the semantic usage of this shader parameter.

const ShaderParameterFlags& om::graphics::materials::ShaderParameter::getFlags ( ) const

inline

Return an object describing boolean flags of this shader parameter.

void om::graphics::materials::ShaderParameter::setFlags ( const ShaderParameterFlags &  newFlags )

inline

Set an object describing boolean flags of this shader parameter.

const ShaderParameterValue& om::graphics::materials::ShaderParameter::getValue ( ) const

inline

Return an object that contains the value for this shader parameter.

void om::graphics::materials::ShaderParameter::setValue ( const ShaderParameterValue &  newValue )

inline

Set an object containing a new value for this shader parameter.

---

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

• omGraphicsShaderParameter.h