Kanzi  3.9.5
Kanzi Engine API
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:
[legend]

Public Member Functions

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...
 
GlRenderValueBaseoperator= (GlRenderValueBase &&other)=default
 Move operator. More...
 
void setDirty (bool enabled)
 Sets dirty status. More...
 
void setUniformLocation (int uniformLocation)
 Sets uniform location. More...
 

Protected Attributes

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

Base class for render value information.

Inherited by individual render value containers

Constructor & Destructor Documentation

◆ GlRenderValueBase() [1/4]

kanzi::GlRenderValueBase::GlRenderValueBase ( )
explicitdefault

Constructor.

◆ GlRenderValueBase() [2/4]

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

Constructor.

Parameters
materialMaterial to acquire uniform location from.
nameName of the render value.

◆ GlRenderValueBase() [3/4]

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

Constructor.

Parameters
uniformLocationUniform location for given name.
nameName of the render value.

◆ GlRenderValueBase() [4/4]

kanzi::GlRenderValueBase::GlRenderValueBase ( GlRenderValueBase &&  other)
default

Move constructor.

Parameters
otherSource object.

Member Function Documentation

◆ isDirty()

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

Tells if this value is dirty.

◆ setDirty()

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

Sets dirty status.

Parameters
enabledNew dirty flag state.

◆ isValid()

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

Tells if this value information is valid.

◆ getName()

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

Access name.

Returns
Name as C string.

◆ isNamed()

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

Tells if the render value has given name.

Parameters
nameName to compare against.
Returns
True if name matches, false otherwise.

◆ getUniformLocation()

int kanzi::GlRenderValueBase::getUniformLocation ( ) const
inline

Gets uniform location.

◆ setUniformLocation()

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

Sets uniform location.

Parameters
uniformLocationNew uniform location.

◆ operator=()

GlRenderValueBase& kanzi::GlRenderValueBase::operator= ( GlRenderValueBase &&  other)
default

Move operator.

Parameters
otherSource object.
Returns
This.

Member Data Documentation

◆ m_uniformLocation

int kanzi::GlRenderValueBase::m_uniformLocation
protected

Uniform location.

◆ m_dirty

bool kanzi::GlRenderValueBase::m_dirty
protected

Is this value dirty and needs updating?

◆ m_name

ImmutableString kanzi::GlRenderValueBase::m_name
protected

Name of the render value.


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