Kanzi Framework  3.9.0
Kanzi Engine API
kanzi::GlRenderValueBinding Struct Reference

GlRenderValueBinding is a binding from shaders/materials into values in GlRenderState. More...

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

Public Member Functions

void addPropertyListener (Node *node, GlRenderState &renderState, AbstractPropertyType propertyType, ShaderProgram::UniformTransformation transformation)
 Add a listener for given property. More...
 
void attach (Material &material, Node *node, GlRenderState &renderState)
 Attach to a combination of nodes. More...
 
void invalidate ()
 Invalidates the state of the notification handler. More...
 
void setAllPropertiesDirty ()
 Flag all properties as being dirty and needing an update. More...
 
void update (GlRenderState &renderState, Object *object, Material &material)
 Apply changes into render state. More...
 

Detailed Description

GlRenderValueBinding is a binding from shaders/materials into values in GlRenderState.

Member Function Documentation

◆ addPropertyListener()

void kanzi::GlRenderValueBinding::addPropertyListener ( Node node,
GlRenderState renderState,
AbstractPropertyType  propertyType,
ShaderProgram::UniformTransformation  transformation 
)

Add a listener for given property.

Parameters
nodeNode on which to listen for property changes.
renderStateRender state to update when the property changes.
propertyTypeProperty type to listen.
transformationShader transformation for uniform values.

◆ attach()

void kanzi::GlRenderValueBinding::attach ( Material material,
Node node,
GlRenderState renderState 
)

Attach to a combination of nodes.

Parameters
materialResource Material to use.
nodeNode to listen property changes on.
renderStateRender state that will be updated on changes.

◆ update()

void kanzi::GlRenderValueBinding::update ( GlRenderState renderState,
Object object,
Material material 
)

Apply changes into render state.

Parameters
renderStateRender state to write changes to.
objectFallback object for property value.
materialFallback material for property value.

◆ invalidate()

void kanzi::GlRenderValueBinding::invalidate ( )

Invalidates the state of the notification handler.

Use this function to invalidate a node that you destroyed before destroying the GlRenderValueBinding.

◆ setAllPropertiesDirty()

void kanzi::GlRenderValueBinding::setAllPropertiesDirty ( )

Flag all properties as being dirty and needing an update.


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