roo_display::FontMetrics Class Reference

Basic font metrics (ascent, descent, bounding box, and line spacing). More...

#include <font.h>

Public Member Functions
	FontMetrics (int ascent, int descent, int linegap, int16_t xMin, int16_t yMin, int16_t xMax, int16_t yMax, int max_right_overhang)
	Construct font metrics.
	FontMetrics ()=default
	FontMetrics (FontMetrics &&)=default
FontMetrics &	operator= (FontMetrics &&)=default
int16_t	ascent () const
	Font ascent (positive).
int16_t	descent () const
	Font descent (usually negative).
int16_t	linegap () const
	Additional gap between lines.
int16_t	linespace () const
	Line advance in pixels.
int16_t	glyphXMin () const
	Return maximum glyph extents in FreeType coordinates (Y up).
int16_t	glyphYMin () const
int16_t	glyphXMax () const
int16_t	glyphYMax () const
int	maxWidth () const
	Maximum glyph width.
int	maxHeight () const
	Maximum glyph height.
int	minLsb () const
	Minimum left side bearing across glyphs.
int	minRsb () const
	Minimum right side bearing across glyphs.

Detailed Description

Basic font metrics (ascent, descent, bounding box, and line spacing).

Definition at line 24 of file font.h.

Constructor & Destructor Documentation

FontMetrics() [1/3]

roo_display::FontMetrics::FontMetrics ( int  ascent, int  descent, int  linegap, int16_t  xMin, int16_t  yMin, int16_t  xMax, int16_t  yMax, int  max_right_overhang  )

inline

Construct font metrics.

Definition at line 27 of file font.h.

FontMetrics() [2/3]

roo_display::FontMetrics::FontMetrics ( )

default

FontMetrics() [3/3]

roo_display::FontMetrics::FontMetrics ( FontMetrics &&  )

default

Member Function Documentation

ascent()

int16_t roo_display::FontMetrics::ascent ( ) const

inline

Font ascent (positive).

Definition at line 40 of file font.h.

Referenced by linespace().

descent()

int16_t roo_display::FontMetrics::descent ( ) const

inline

Font descent (usually negative).

Definition at line 42 of file font.h.

Referenced by linespace().

glyphXMax()

int16_t roo_display::FontMetrics::glyphXMax ( ) const

inline

Definition at line 51 of file font.h.

References roo_display::Box::xMax().

glyphXMin()

int16_t roo_display::FontMetrics::glyphXMin ( ) const

inline

Return maximum glyph extents in FreeType coordinates (Y up).

Definition at line 49 of file font.h.

References roo_display::Box::xMin().

glyphYMax()

int16_t roo_display::FontMetrics::glyphYMax ( ) const

inline

Definition at line 52 of file font.h.

References roo_display::Box::yMax().

Referenced by roo_display::SmoothFont::getHorizontalStringMetrics(), and roo_display::SmoothFontV2::getHorizontalStringMetrics().

glyphYMin()

int16_t roo_display::FontMetrics::glyphYMin ( ) const

inline

Definition at line 50 of file font.h.

References roo_display::Box::yMin().

Referenced by roo_display::SmoothFont::getHorizontalStringMetrics(), and roo_display::SmoothFontV2::getHorizontalStringMetrics().

linegap()

int16_t roo_display::FontMetrics::linegap ( ) const

inline

Additional gap between lines.

Definition at line 44 of file font.h.

Referenced by roo_display::SmoothFont::getGlyphMetrics(), roo_display::SmoothFontV2::getGlyphMetrics(), linespace(), roo_display::SmoothFont::GlyphMetadataReader::readMetrics(), and roo_display::SmoothFontV2::GlyphMetadataReader::readMetrics().

linespace()

int16_t roo_display::FontMetrics::linespace ( ) const

inline

Line advance in pixels.

Definition at line 46 of file font.h.

References ascent(), descent(), and linegap().

maxHeight()

int roo_display::FontMetrics::maxHeight ( ) const

inline

Maximum glyph height.

Definition at line 57 of file font.h.

References roo_display::Box::height().

maxWidth()

int roo_display::FontMetrics::maxWidth ( ) const

inline

Maximum glyph width.

Definition at line 55 of file font.h.

References roo_display::Box::width().

minLsb()

int roo_display::FontMetrics::minLsb ( ) const

inline

Minimum left side bearing across glyphs.

Definition at line 60 of file font.h.

References roo_display::Box::xMin().

minRsb()

int roo_display::FontMetrics::minRsb ( ) const

inline

Minimum right side bearing across glyphs.

Definition at line 62 of file font.h.

operator=()

FontMetrics & roo_display::FontMetrics::operator= ( FontMetrics &&  )

default

---

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

• temp_repos/roo_display/src/roo_display/font/font.h