Kanzi  3.9.7
Kanzi Engine API
kanzi::GlRenderState::TextureRenderValue Struct Reference

Container for texture render value and the width/height uniforms. More...

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

Inheritance diagram for kanzi::GlRenderState::TextureRenderValue:
[legend]

Public Member Functions

HandleType getHeightHandle () const
 Gets the height uniform handle. More...
 
HandleType getSizeHandle () const
 Gets the size uniform handle. More...
 
HandleType getWidthHandle () const
 Gets the width uniform handle. More...
 
TextureRenderValueoperator= (TextureRenderValue &&other)=default
 Move operator. More...
 
 TextureRenderValue (int uniformLocation, string_view name, HandleType widthHandle, HandleType heightHandle, HandleType sizeHandle)
 Constructor. More...
 
 TextureRenderValue (TextureRenderValue &&other)=default
 Move constructor. More...
 
- Public Member Functions inherited from kanzi::GlRenderValue< TextureSharedPtr >
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

Container for texture render value and the width/height uniforms.

Texture render values require also the handles for width and

Constructor & Destructor Documentation

kanzi::GlRenderState::TextureRenderValue::TextureRenderValue ( int  uniformLocation,
string_view  name,
HandleType  widthHandle,
HandleType  heightHandle,
HandleType  sizeHandle 
)
inlineexplicit

Constructor.

Parameters
uniformLocationUniform location already acquired from shader.
nameName of the render value.
widthHandleTexture width uniform handle.
heightHandleTexture height uniform handle.
sizeHandleTexture size uniform handle.
kanzi::GlRenderState::TextureRenderValue::TextureRenderValue ( TextureRenderValue &&  other)
default

Move constructor.

Parameters
otherSource object.

Member Function Documentation

TextureRenderValue& kanzi::GlRenderState::TextureRenderValue::operator= ( TextureRenderValue &&  other)
default

Move operator.

Parameters
otherSource object.
Returns
This.
HandleType kanzi::GlRenderState::TextureRenderValue::getWidthHandle ( ) const
inline

Gets the width uniform handle.

Returns
Handle to width value.
HandleType kanzi::GlRenderState::TextureRenderValue::getHeightHandle ( ) const
inline

Gets the height uniform handle.

Returns
Handle to height value.
HandleType kanzi::GlRenderState::TextureRenderValue::getSizeHandle ( ) const
inline

Gets the size uniform handle.

Returns
Handle to size value.

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