kanzi::GlRenderValue< T > Class Template Reference

Individual render value container. More...

#include <kanzi/core.ui/platform/graphics_backend/gl/gl_render_value.hpp>

Inheritance diagram for kanzi::GlRenderValue< T >:
kanzi::GlRenderValueBase

Public Member Functions

 GlRenderValue ()
 Empty constructor. More...
 
 GlRenderValue (Material &material, string_view name)
 Constructor. More...
 
 GlRenderValue (int uniformLocation, string_view name)
 Constructor. More...
 
 GlRenderValue (KZ_RV_REF(GlRenderValue) other)
 Move constructor. More...
 
T & get ()
 Get reference to the value contained in this object. More...
 
const T & get () const
 Get const reference to the value contained in this object. More...
 
void set (T value)
 Set value. More...
 
GlRenderValueoperator= (KZ_RV_REF(GlRenderValue) other)
 Move operator. More...
 
- Public Member Functions inherited from kanzi::GlRenderValueBase
 GlRenderValueBase (Material &material, string_view name)
 Constructor. More...
 
 GlRenderValueBase (int uniformLocation, string_view name)
 Constructor. More...
 
 GlRenderValueBase (KZ_RV_REF(GlRenderValueBase) other)
 Move constructor. More...
 
bool isNamed (string_view name) const
 Tells if this render value info matches given parameters. More...
 
bool isDirty () const
 Tells if this value is dirty. More...
 
void setDirty (bool enabled)
 Sets dirty status. More...
 
bool isValid () const
 Tells if this value information is valid. More...
 
const char * getName () const
 Access name. More...
 
int getUniformLocation () const
 Gets uniform location. More...
 
void setUniformLocation (int uniformLocation)
 Sets uniform location. More...
 
GlRenderValueBaseoperator= (KZ_RV_REF(GlRenderValueBase) other)
 Move operator. More...
 

Additional Inherited Members

- Protected Attributes inherited from kanzi::GlRenderValueBase
int m_uniformLocation
 Uniform location. More...
 
bool m_dirty
 Is this value dirty and needs updating? More...
 
ImmutableString m_name
 Name of the render value. More...
 

Detailed Description

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

Individual render value container.

Unlike the render value information struct within RenderState, this class stoles the render value itself. This class is used to store texture values within render state, and individual render states in classes that do not want a complete render state.

Constructor & Destructor Documentation

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

Empty constructor.

template<typename T>
kanzi::GlRenderValue< T >::GlRenderValue ( Material material,
string_view  name 
)
inlineexplicit

Constructor.

Parameters
materialMaterial to acquire uniform location from.
nameName of the render value.
template<typename T>
kanzi::GlRenderValue< T >::GlRenderValue ( int  uniformLocation,
string_view  name 
)
inlineexplicit

Constructor.

Parameters
uniformLocationUniform location already acquired from shader.
nameName of the render value.
template<typename T>
kanzi::GlRenderValue< T >::GlRenderValue ( KZ_RV_REF(GlRenderValue< T >)  other)
inline

Move constructor.

Parameters
otherSource object.

Member Function Documentation

template<typename T>
T& kanzi::GlRenderValue< T >::get ( )
inline

Get reference to the value contained in this object.

Returns
Reference to contained value.
template<typename T>
const T& kanzi::GlRenderValue< T >::get ( ) const
inline

Get const reference to the value contained in this object.

Returns
Const reference to contained value.
template<typename T>
void kanzi::GlRenderValue< T >::set ( value)
inline

Set value.

Parameters
valueNew value.
template<typename T>
GlRenderValue& kanzi::GlRenderValue< T >::operator= ( KZ_RV_REF(GlRenderValue< T >)  other)
inline

Move operator.

Parameters
otherSource object.
Returns
This.

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