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 >:

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

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

Detailed Description

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

Individual render value container.

Use this class to store render values in classes that do not want a complete render state.

Since

Kanzi 3.9.1 changed to use KANZI_COREUI_TEMPLATE_API.

Constructor & Destructor Documentation

GlRenderValue() [1/4]

template<typename T>

kanzi::GlRenderValue< T >::GlRenderValue ( )

explicitdefault

Empty constructor.

GlRenderValue() [2/4]

template<typename T>

kanzi::GlRenderValue< T >::GlRenderValue ( Material &  material, string_view  name  )

inlineexplicit

Constructor.

Parameters

material	Material to acquire uniform location from.
name	Name of the render value.

GlRenderValue() [3/4]

template<typename T>

kanzi::GlRenderValue< T >::GlRenderValue ( int  uniformLocation, string_view  name  )

inlineexplicit

Constructor.

Parameters

uniformLocation	Uniform location already acquired from shader.
name	Name of the render value.

GlRenderValue() [4/4]

template<typename T>

kanzi::GlRenderValue< T >::GlRenderValue ( GlRenderValue< T > &&  other )

default

Move constructor.

Parameters

other

Source object.

Member Function Documentation

get()

template<typename T>

T kanzi::GlRenderValue< T >::get ( ) const

inline

Get the value contained in this object.

Returns

Contained value.

set()

template<typename T>

void kanzi::GlRenderValue< T >::set ( T  value )

inline

Set value.

Parameters

value

New value.

operator=()

template<typename T>

GlRenderValue& kanzi::GlRenderValue< T >::operator= ( GlRenderValue< T > &&  other )

default

Move operator.

Parameters

other

Source object.

Returns

This.

---

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

• kanzi/core.ui/platform/graphics_backend/gl/gl_render_value.hpp