Castor3D 0.16.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, Size const &size, Position const &bearing, int32_t advance, ByteArray const &bitmap)
 Constructor.
 
char32_t getCharacter () const
 Retrieves the glyph character.
 
Size const & getSize () const
 Retrieves the glyph dimensions.
 
Position const & getBearing () const
 
int32_t getAdvance () const
 Retrieves the number of pixels to go before drawing next glyph.
 
ByteArray const & getBitmap () const
 Retrieves the glyph image.
 

Constructor & Destructor Documentation

◆ Glyph()

castor::Glyph::Glyph ( char32_t c,
Size const & size,
Position const & bearing,
int32_t advance,
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]bitmapThe glyph image

Member Function Documentation

◆ getAdvance()

int32_t castor::Glyph::getAdvance ( ) const
inline

Retrieves the number of pixels to go before drawing next glyph.

Returns
The value

◆ getBearing()

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

◆ getBitmap()

ByteArray const & castor::Glyph::getBitmap ( ) const
inline

Retrieves the glyph image.

Returns
A constant reference to the image of the glyph

◆ getCharacter()

char32_t castor::Glyph::getCharacter ( ) const
inline

Retrieves the glyph character.

Returns
The value

◆ getSize()

Size const & castor::Glyph::getSize ( ) const
inline

Retrieves the glyph dimensions.

Returns
The glyph dimensions

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