All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
kanzi::GlRenderStateValueContainer< T > Class Template Reference

OpenGL render state value container. More...

#include <kanzi/rendering/gl_render_state_value_container.hpp>

Public Member Functions

 GlRenderStateValueContainer ()
 Empty constructor. More...
 
void clear ()
 Clear all contents. More...
 
void clearDirtyFlag (size_t handle)
 Clear dirty flag. More...
 
void setDirtyFlag (size_t handle)
 Set dirty flag. More...
 
bool isValid (size_t handle)
 Tell if an uniform for a handle is valid. More...
 
size_t getHandle (string_view name, int location)
 Add a new value slot, get handle. More...
 
string_view getName (size_t handle)
 Get name (for handle). More...
 
int getUniformLocation (size_t handle) const
 Get uniform location (for handle). More...
 
void setUniformLocation (size_t handle, int uniformLocation)
 Set uniform locaton (for handle). More...
 
getValue (size_t handle) const
 Get value (from a handle). More...
 
getValueAndClearDirtyFlag (size_t handle)
 Get value (from a handle). More...
 
void setValue (size_t handle, T value)
 Set value on handle. More...
 
bool isDirty (size_t handle) const
 Tell if given handle is dirty. More...
 
size_t size () const
 Get current size. More...
 

Detailed Description

template<typename T>
class kanzi::GlRenderStateValueContainer< T >

OpenGL render state value container.

Constructor & Destructor Documentation

template<typename T>
kanzi::GlRenderStateValueContainer< T >::GlRenderStateValueContainer ( )
inlineexplicit

Empty constructor.

Member Function Documentation

template<typename T>
void kanzi::GlRenderStateValueContainer< T >::clear ( )
inline

Clear all contents.

template<typename T>
void kanzi::GlRenderStateValueContainer< T >::clearDirtyFlag ( size_t  handle)
inline

Clear dirty flag.

Parameters
handleHandle to clear.
template<typename T>
void kanzi::GlRenderStateValueContainer< T >::setDirtyFlag ( size_t  handle)
inline

Set dirty flag.

Parameters
handleHandle to set.
template<typename T>
bool kanzi::GlRenderStateValueContainer< T >::isValid ( size_t  handle)
inline

Tell if an uniform for a handle is valid.

Not all handles link to valid uniform locations, the uniform ID may be invalid.

Parameters
handleHandle to check.
Returns
True if valid, false if not.
template<typename T>
size_t kanzi::GlRenderStateValueContainer< T >::getHandle ( string_view  name,
int  location 
)
inline

Add a new value slot, get handle.

If handle already exists for given name, it will be returned instead.

Parameters
nameName of value.
locationUniform location.
Returns
Handle.
template<typename T>
string_view kanzi::GlRenderStateValueContainer< T >::getName ( size_t  handle)
inline

Get name (for handle).

Parameters
handleHandle.
Returns
Name.
template<typename T>
int kanzi::GlRenderStateValueContainer< T >::getUniformLocation ( size_t  handle) const
inline

Get uniform location (for handle).

Parameters
handleHandle.
Returns
Uniform location.
template<typename T>
void kanzi::GlRenderStateValueContainer< T >::setUniformLocation ( size_t  handle,
int  uniformLocation 
)
inline

Set uniform locaton (for handle).

Parameters
handleHandle.
uniformLocationNew uniform location.
template<typename T>
T kanzi::GlRenderStateValueContainer< T >::getValue ( size_t  handle) const
inline

Get value (from a handle).

Parameters
handleHandle.
Returns
value.
template<typename T>
T kanzi::GlRenderStateValueContainer< T >::getValueAndClearDirtyFlag ( size_t  handle)
inline

Get value (from a handle).

Implicitly clears dirty flag.

Parameters
handleHandle.
Returns
value.
template<typename T>
void kanzi::GlRenderStateValueContainer< T >::setValue ( size_t  handle,
value 
)
inline

Set value on handle.

Parameters
handleHandle.
valueValue to set.
template<typename T>
bool kanzi::GlRenderStateValueContainer< T >::isDirty ( size_t  handle) const
inline

Tell if given handle is dirty.

Parameters
handleHandle to check.
Returns
True if yes, false if no.
template<typename T>
size_t kanzi::GlRenderStateValueContainer< T >::size ( ) const
inline

Get current size.

Returns
Size.

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