kanzi::NodeCompositor2D::ManagedCompositionTarget Struct Reference

Managed composition target container. More...

#include <kanzi/core.ui/node/node_compositor2d.hpp>

Public Member Functions

 ManagedCompositionTarget ()
 Constructor. More...
 
TextureSharedPtr getCompositionTarget () const
 Access composition target. More...
 
bool hasCompositionTarget () const
 Tell if a managed composition target has been allocated. More...
 
void setCompositionTarget (TextureSharedPtr framebuffer)
 Update composition target. More...
 
bool isCacheValid () const
 Tell if cache is valid. More...
 
void setCacheValid (bool valid)
 Set cache as valid. More...
 
void reset ()
 Reset current composition target allocation. More...
 

Detailed Description

Managed composition target container.

Constructor & Destructor Documentation

kanzi::NodeCompositor2D::ManagedCompositionTarget::ManagedCompositionTarget ( )
inline

Constructor.

Member Function Documentation

TextureSharedPtr kanzi::NodeCompositor2D::ManagedCompositionTarget::getCompositionTarget ( ) const
inline

Access composition target.

Returns
Current composition target.
bool kanzi::NodeCompositor2D::ManagedCompositionTarget::hasCompositionTarget ( ) const
inline

Tell if a managed composition target has been allocated.

Returns
True if yes, false if no.
void kanzi::NodeCompositor2D::ManagedCompositionTarget::setCompositionTarget ( TextureSharedPtr  framebuffer)
inline

Update composition target.

Will implicitly invalidate cache status.

Parameters
framebufferNew framebuffer.
bool kanzi::NodeCompositor2D::ManagedCompositionTarget::isCacheValid ( ) const
inline

Tell if cache is valid.

Returns
True if yes, false if no.
void kanzi::NodeCompositor2D::ManagedCompositionTarget::setCacheValid ( bool  valid)
inline

Set cache as valid.

void kanzi::NodeCompositor2D::ManagedCompositionTarget::reset ( )
inline

Reset current composition target allocation.


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