kanzi::FrameDescription Class Reference

Description of a frame, the remaining area of a quad with another quad cut out. More...

#include <kanzi/core.ui/graphics2d/frame_description.hpp>

Public Member Functions
	FrameDescription (const QuadDescription &bg, const QuadDescription &fg, unsigned int clippingMask)
	Constructor. More...
const optional< QuadDescription > &	getQuad (size_t idx) const
	Access frame component. More...

Detailed Description

Description of a frame, the remaining area of a quad with another quad cut out.

Constructor & Destructor Documentation

FrameDescription()

kanzi::FrameDescription::FrameDescription ( const QuadDescription &  bg, const QuadDescription &  fg, unsigned int  clippingMask  )

explicit

Constructor.

Parameters

bg	Background quad.
fg	Foreground quad.
clippingMask	The clipping mask. See QuadDescription.

Member Function Documentation

getQuad()

const optional<QuadDescription>& kanzi::FrameDescription::getQuad ( size_t  idx ) const

inline

Access frame component.

Parameters

idx	Index of component.

---

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

• kanzi/core.ui/graphics2d/frame_description.hpp