om::graphics::materials::ShaderParameterInfo Class Reference

A class that specifies information about a shader parameter. More...

#include <omGraphicsShaderParameterInfo.h>

Public Member Functions
	ShaderParameterInfo ()
	Create a new shader parameter info object with ShaderParameterUsage::UNDEFINED usage and default flags. More...
	ShaderParameterInfo (const ShaderSourceString &newName)
	Create a new shader parameter info object with ShaderParameterUsage::UNDEFINED usage and default flags. More...
	ShaderParameterInfo (const ShaderSourceString &newName, const ShaderParameterUsage &newUsage)
	Create a new shader parameter info object with the specified usage and default flags. More...
	ShaderParameterInfo (const ShaderSourceString &newName, const ShaderParameterUsage &newUsage, const ShaderParameterFlags &newFlags)
	Create a new shader parameter info object with the specified usage and flags. More...
const ShaderSourceString &	getName () const
	Return the name of this shader parameter. More...
void	setName (const ShaderSourceString &newName)
	Set the name of this shader parameter. More...
const ShaderParameterUsage &	getUsage () const
	Return an object describing the semantic usage of this shader parameter. More...
void	setUsage (const ShaderParameterUsage &newUsage)
	Set an object describing the semantic usage of this shader parameter. More...
const ShaderParameterFlags &	getFlags () const
	Return an object describing boolean information about this shader parameter. More...
void	setFlags (const ShaderParameterFlags &newFlags)
	Set an object describing boolean information about this shader parameter. More...

Detailed Description

A class that specifies information about a shader parameter.

This information includes a semantic usage for the parameter, as well as flags that specify boolean information about the parameter such as its read/write access status.

Constructor & Destructor Documentation

om::graphics::materials::ShaderParameterInfo::ShaderParameterInfo ( )

inline

Create a new shader parameter info object with ShaderParameterUsage::UNDEFINED usage and default flags.

The default shader parameter flags allow no read or write access.

om::graphics::materials::ShaderParameterInfo::ShaderParameterInfo ( const ShaderSourceString &  newName )

inline

Create a new shader parameter info object with ShaderParameterUsage::UNDEFINED usage and default flags.

The default shader parameter flags allow read and write access.

om::graphics::materials::ShaderParameterInfo::ShaderParameterInfo ( const ShaderSourceString &  newName, const ShaderParameterUsage &  newUsage  )

inline

Create a new shader parameter info object with the specified usage and default flags.

The default shader parameter flags allow read and write access.

om::graphics::materials::ShaderParameterInfo::ShaderParameterInfo ( const ShaderSourceString &  newName, const ShaderParameterUsage &  newUsage, const ShaderParameterFlags &  newFlags  )

inline

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

Member Function Documentation

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

inline

Return the name of this shader parameter.

void om::graphics::materials::ShaderParameterInfo::setName ( const ShaderSourceString &  newName )

inline

Set the name of this shader parameter.

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

inline

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

void om::graphics::materials::ShaderParameterInfo::setUsage ( const ShaderParameterUsage &  newUsage )

inline

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

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

inline

Return an object describing boolean information about this shader parameter.

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

inline

Set an object describing boolean information about this shader parameter.

---

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

• omGraphicsShaderParameterInfo.h