Kanzi  3.9.9
Kanzi Engine C++ API
kanzi::QuadDescription Class Reference

Use QuadDescription to create renderable quad geometry. More...

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

Public Member Functions

unsigned int clipBottom (float border)
 Clips from the bottom side. More...
 
unsigned int clipLeft (float border)
 Clips from the left side. More...
 
unsigned int clipRight (float border)
 Clips from the right side. More...
 
unsigned int clipTop (float border)
 Clips from the top side. More...
 
Vector2 getOffset () const
 Gets the quad offset. More...
 
Vector2 getSize () const
 Gets the size of the quad. More...
 
Vector2 getTextureOffset () const
 Gets the offset of the texture. More...
 
Vector2 getTextureSize () const
 Gets the size of the texture. More...
 
bool operator!= (const QuadDescription &other) const
 Checks whether two quads are not equal. More...
 
bool operator== (const QuadDescription &other) const
 Checks whether two quads are equal. More...
 
 QuadDescription ()=default
 Empty constructor. More...
 
 QuadDescription (Vector2 offset, Vector2 size)
 Constructor. More...
 
 QuadDescription (Vector2 offset, Vector2 size, Vector2 texcoordOffset, Vector2 texcoordSize)
 Constructor with full info. More...
 

Static Public Attributes

static const unsigned int ClippingResultBottom
 Clipping mask - bottom part. More...
 
static const unsigned int ClippingResultCenter
 Clipping mask - center area. More...
 
static const unsigned int ClippingResultLeft
 Clipping mask - left part. More...
 
static const unsigned int ClippingResultOutside
 Layer clipping result - any outside area. More...
 
static const unsigned int ClippingResultRight
 Clipping mask - right part. More...
 
static const unsigned int ClippingResultSingleOutsideRectangle
 Single rectangular outside area, do not care which one. More...
 
static const unsigned int ClippingResultTop
 Clipping mask - top part. More...
 

Detailed Description

Use QuadDescription to create renderable quad geometry.

Constructor & Destructor Documentation

kanzi::QuadDescription::QuadDescription ( )
explicitdefault

Empty constructor.

kanzi::QuadDescription::QuadDescription ( Vector2  offset,
Vector2  size 
)
inlineexplicit

Constructor.

Parameters
offsetOffset.
sizeSize.
kanzi::QuadDescription::QuadDescription ( Vector2  offset,
Vector2  size,
Vector2  texcoordOffset,
Vector2  texcoordSize 
)
inlineexplicit

Constructor with full info.

Parameters
offsetOffset.
sizeSize.
texcoordOffsetTexcoord offset.
texcoordSizeTexcoord size.

Member Function Documentation

unsigned int kanzi::QuadDescription::clipBottom ( float  border)

Clips from the bottom side.

Parameters
borderThe border to which to clip.
Returns
Clip mask of remaining areas.
unsigned int kanzi::QuadDescription::clipLeft ( float  border)

Clips from the left side.

Parameters
borderThe border to which to clip.
Returns
Clip mask of remaining areas.
unsigned int kanzi::QuadDescription::clipRight ( float  border)

Clips from the right side.

Parameters
borderThe border to which to clip.
Returns
Clip mask of remaining areas.
unsigned int kanzi::QuadDescription::clipTop ( float  border)

Clips from the top side.

Parameters
borderThe border to which to clip.
Returns
Clip mask of remaining areas.
Vector2 kanzi::QuadDescription::getOffset ( ) const
inline

Gets the quad offset.

Returns
Quad offset vector.
Vector2 kanzi::QuadDescription::getSize ( ) const
inline

Gets the size of the quad.

Returns
Quad size vector.
Vector2 kanzi::QuadDescription::getTextureOffset ( ) const
inline

Gets the offset of the texture.

Returns
Texture offset vector.
Vector2 kanzi::QuadDescription::getTextureSize ( ) const
inline

Gets the size of the texture.

Returns
Texture size vector.
bool kanzi::QuadDescription::operator== ( const QuadDescription other) const
inline

Checks whether two quads are equal.

Parameters
otherThe other quad.
Returns
If the quads are equal, true, otherwise false.
bool kanzi::QuadDescription::operator!= ( const QuadDescription other) const
inline

Checks whether two quads are not equal.

Parameters
otherThe other quad.
Returns
If the quads are not equal, true, otherwise false.

Member Data Documentation

const unsigned int kanzi::QuadDescription::ClippingResultCenter
static

Clipping mask - center area.

const unsigned int kanzi::QuadDescription::ClippingResultBottom
static

Clipping mask - bottom part.

const unsigned int kanzi::QuadDescription::ClippingResultLeft
static

Clipping mask - left part.

const unsigned int kanzi::QuadDescription::ClippingResultRight
static

Clipping mask - right part.

const unsigned int kanzi::QuadDescription::ClippingResultTop
static

Clipping mask - top part.

const unsigned int kanzi::QuadDescription::ClippingResultSingleOutsideRectangle
static

Single rectangular outside area, do not care which one.

const unsigned int kanzi::QuadDescription::ClippingResultOutside
static

Layer clipping result - any outside area.


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