Castor3D 0.17.0
Multiplatform 3D engine
Public Member Functions | List of all members
castor::Glyph Class Reference

#include <Glyph.hpp>

Public Member Functions

 Glyph (char32_t c, Point2f const &size, Point2f const &bearing, float advance, Size const &bitmapSize, ByteArray const &bitmap)
 Constructor.
 
char32_t getCharacter () const
 
Point2f const & getSize () const
 
Point2f const & getBearing () const
 
float getAdvance () const
 
ByteArray const & getBitmap () const
 
Size const & getBitmapSize () const
 

Constructor & Destructor Documentation

◆ Glyph()

castor::Glyph::Glyph ( char32_t c,
Point2f const & size,
Point2f const & bearing,
float advance,
Size const & bitmapSize,
ByteArray const & bitmap )
inline

Constructor.

Parameters
[in]cThe glyph character.
[in]sizeThe glyph dimensions.
[in]bearingThe glyph position relative to cursor.
[in]advancePixels to advance in order to go next character.
[in]bitmapSizeThe bitmap dimensions.
[in]bitmapThe glyph image.

Member Function Documentation

◆ getAdvance()

float castor::Glyph::getAdvance ( ) const
inline
Returns
The number of pixels to go before drawing next glyph.

◆ getBearing()

Point2f const & castor::Glyph::getBearing ( ) const
inline
Returns
The glyph position relative to cursor.

◆ getBitmap()

ByteArray const & castor::Glyph::getBitmap ( ) const
inline
Returns
The image of the glyph.

◆ getBitmapSize()

Size const & castor::Glyph::getBitmapSize ( ) const
inline
Returns
The glyph image dimensions.

◆ getCharacter()

char32_t castor::Glyph::getCharacter ( ) const
inline
Returns
The glyph character.

◆ getSize()

Point2f const & castor::Glyph::getSize ( ) const
inline
Returns
The glyph dimensions.

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