Kanzi  3.9.5
Kanzi Engine API
kanzi::BindingToken Class Reference

Helper class that manages the lifetime of the runtime binding owned by a Node or a RenderPass, by removing the owned binding on the destruction of that Node or the RenderPass. More...

#include <kanzi/ui/node/concept/activity/binding_token.hpp>

Public Member Functions

 BindingToken (BindingHostConceptSharedPtr host, AbstractBindingRuntimeSharedPtr binding)
 Constructor. More...
 
 BindingToken ()=default
 Default constructor. More...
 
void removeBinding ()
 Removes the stored runtime binding. More...
 
void setHostAndBinding (BindingHostConceptSharedPtr host, AbstractBindingRuntimeSharedPtr binding)
 Sets the runtime binding. More...
 
 ~BindingToken ()
 Destructor. More...
 

Detailed Description

Helper class that manages the lifetime of the runtime binding owned by a Node or a RenderPass, by removing the owned binding on the destruction of that Node or the RenderPass.

Since
Kanzi 3.9.0

Constructor & Destructor Documentation

◆ BindingToken() [1/2]

kanzi::BindingToken::BindingToken ( BindingHostConceptSharedPtr  host,
AbstractBindingRuntimeSharedPtr  binding 
)
inlineexplicit

Constructor.

Parameters
hostThe Node or the RenderPass that owns the runtime binding.
bindingThe runtime binding that this function removes on destruction of the Node or the RenderPass, that owns the runtime binding.

◆ BindingToken() [2/2]

kanzi::BindingToken::BindingToken ( )
explicitdefault

Default constructor.

◆ ~BindingToken()

kanzi::BindingToken::~BindingToken ( )
inline

Destructor.

Member Function Documentation

◆ setHostAndBinding()

void kanzi::BindingToken::setHostAndBinding ( BindingHostConceptSharedPtr  host,
AbstractBindingRuntimeSharedPtr  binding 
)
inline

Sets the runtime binding.

Parameters
hostThe Node or the RenderPass that owns the runtime binding.
bindingThe runtime binding that this function removes on destruction of the Node or the RenderPass, that owns the runtime binding.

◆ removeBinding()

void kanzi::BindingToken::removeBinding ( )
inline

Removes the stored runtime binding.


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