Kanzi  3.9.5
Kanzi Engine API
kanzi::GlRenderValue< TextureSharedPtr > Class Template Reference

Specialization of GlRenderValue. More...

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

Inheritance diagram for kanzi::GlRenderValue< TextureSharedPtr >:
[legend]

Public Member Functions

TextureSharedPtr get () const
 Get a shared pointer to the texture 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...
 
GlRenderValueoperator= (GlRenderValue &&other)=default
 Move operator. More...
 
void set (TextureSharedPtr value)
 Set the weak pointer to the texture resource. 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...
 
GlRenderValueBaseoperator= (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<>
class kanzi::GlRenderValue< TextureSharedPtr >

Specialization of GlRenderValue.

Since
Kanzi 3.9.1 changed to use KANZI_COREUI_TEMPLATE_API.

Constructor & Destructor Documentation

◆ GlRenderValue() [1/4]

Empty constructor.

◆ GlRenderValue() [2/4]

kanzi::GlRenderValue< TextureSharedPtr >::GlRenderValue ( Material material,
string_view  name 
)
inlineexplicit

Constructor.

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

◆ GlRenderValue() [3/4]

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

Constructor.

Parameters
uniformLocationUniform location already acquired from shader.
nameName of the render value.

◆ GlRenderValue() [4/4]

Move constructor.

Parameters
otherSource object.

Member Function Documentation

◆ get()

Get a shared pointer to the texture contained in this object.

Returns
Texture shared pointer.

◆ set()

void kanzi::GlRenderValue< TextureSharedPtr >::set ( TextureSharedPtr  value)
inline

Set the weak pointer to the texture resource.

Parameters
valueShared pointer to the texture resource.

◆ operator=()

Move operator.

Parameters
otherSource object.
Returns
This.

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