kanzi::GlRenderValueBase Class Reference

Base class for render value information. More...

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

Inheritance diagram for kanzi::GlRenderValueBase:
kanzi::GlRenderValue< float > kanzi::GlRenderValue< GraphicsBlendMode > kanzi::GlRenderValue< kanzi::ColorRGBA > kanzi::GlRenderValue< T > kanzi::GlRenderValue< TextureSharedPtr >

Public Member Functions

 GlRenderValueBase (Material &material, string_view name)
 Constructor. More...
 
 GlRenderValueBase ()
 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...
 

Protected Attributes

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

Base class for render value information.

Inherited by individual render value containers

Constructor & Destructor Documentation

kanzi::GlRenderValueBase::GlRenderValueBase ( Material material,
string_view  name 
)
explicit

Constructor.

Parameters
materialMaterial to acquire uniform location from.
nameName of the render value.
kanzi::GlRenderValueBase::GlRenderValueBase ( )
inlineexplicit

Constructor.

kanzi::GlRenderValueBase::GlRenderValueBase ( int  uniformLocation,
string_view  name 
)
inlineexplicit

Constructor.

kanzi::GlRenderValueBase::GlRenderValueBase ( KZ_RV_REF(GlRenderValueBase other)
inline

Move constructor.

Parameters
otherSource object.

Member Function Documentation

bool kanzi::GlRenderValueBase::isNamed ( string_view  name) const
inline

Tells if this render value info matches given parameters.

bool kanzi::GlRenderValueBase::isDirty ( ) const
inline

Tells if this value is dirty.

void kanzi::GlRenderValueBase::setDirty ( bool  enabled)
inline

Sets dirty status.

Parameters
enabledNew dirty flag state.
bool kanzi::GlRenderValueBase::isValid ( ) const
inline

Tells if this value information is valid.

const char* kanzi::GlRenderValueBase::getName ( ) const
inline

Access name.

Returns
Name as C string.
int kanzi::GlRenderValueBase::getUniformLocation ( ) const
inline

Gets uniform location.

void kanzi::GlRenderValueBase::setUniformLocation ( int  uniformLocation)
inline

Sets uniform location.

Parameters
uniformLocationNew uniform location.
GlRenderValueBase& kanzi::GlRenderValueBase::operator= ( KZ_RV_REF(GlRenderValueBase other)
inline

Move operator.

Parameters
otherSource object.
Returns
This.

Member Data Documentation

int kanzi::GlRenderValueBase::m_uniformLocation
protected

Uniform location.

bool kanzi::GlRenderValueBase::m_dirty
protected

Is this value dirty and needs updating?

ImmutableString kanzi::GlRenderValueBase::m_name
protected

Name of the render value.


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