Ignition Rendering

API Reference

5.0.0
ShaderParams Class Reference

a map that holds params to be passed to a shader More...

#include <ShaderParams.hh>

Public Member Functions

 ShaderParams ()
 constructor More...
 
 ~ShaderParams ()
 destructor More...
 
Iterator begin () const
 Iterator to first parameter. More...
 
void ClearDirty ()
 Resets the dirty flag. More...
 
Iterator end () const
 Iterator to one past last param. More...
 
bool IsDirty () const
 Have the params changed? More...
 
ShaderParamoperator[] (const std::string &_name)
 Access a param with a given name. More...
 
const ShaderParamoperator[] (const std::string &_name) const
 Access a param with a given name. More...
 

Detailed Description

a map that holds params to be passed to a shader

Constructor & Destructor Documentation

◆ ShaderParams()

constructor

◆ ~ShaderParams()

destructor

Member Function Documentation

◆ begin()

Iterator begin ( ) const

Iterator to first parameter.

Remarks
Necessary for range-base for loop support
Returns
Iterator pointing to first parameter.

◆ ClearDirty()

void ClearDirty ( )

Resets the dirty flag.

◆ end()

Iterator end ( ) const

Iterator to one past last param.

Remarks
Necessary for range-base for loop support
Returns
Iterator pointing to one past last parameter.

◆ IsDirty()

bool IsDirty ( ) const

Have the params changed?

◆ operator[]() [1/2]

ShaderParam& operator[] ( const std::string _name)

Access a param with a given name.

Parameters
[in]_nameIdentifier for the parameter
Returns
parameter reference

◆ operator[]() [2/2]

const ShaderParam& operator[] ( const std::string _name) const

Access a param with a given name.

Parameters
[in]_nameIdentifier for the parameter
Returns
const parameter reference

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