roo_display
API Documentation for roo_display
Loading...
Searching...
No Matches
roo_display::GlyphMetrics Class Reference

Per-glyph metrics (bounding box and advance). More...

#include <font.h>

Public Member Functions

 GlyphMetrics (int16_t glyphXMin, int16_t glyphYMin, int16_t glyphXMax, int16_t glyphYMax, int advance)
 Construct metrics from FreeType coordinates (Y up).
 
 GlyphMetrics ()=default
 
 GlyphMetrics (const GlyphMetrics &)=default
 
 GlyphMetrics (GlyphMetrics &&)=default
 
GlyphMetricsoperator= (GlyphMetrics &&)=default
 
GlyphMetricsoperator= (const GlyphMetrics &)=default
 
const Boxscreen_extents () const
 Bounding box in screen coordinates (Y down).
 
int glyphXMin () const
 Bounding box in FreeType coordinates (Y up).
 
int glyphXMax () const
 
int glyphYMin () const
 
int glyphYMax () const
 
int bearingX () const
 Left side bearing.
 
int bearingY () const
 Top side bearing.
 
int rsb () const
 Right side bearing.
 
int lsb () const
 Left side bearing (alias).
 
int width () const
 Glyph width.
 
int height () const
 Glyph height.
 
int advance () const
 Advance in pixels.
 

Detailed Description

Per-glyph metrics (bounding box and advance).

Definition at line 139 of file font.h.

Constructor & Destructor Documentation

◆ GlyphMetrics() [1/4]

roo_display::GlyphMetrics::GlyphMetrics ( int16_t  glyphXMin,
int16_t  glyphYMin,
int16_t  glyphXMax,
int16_t  glyphYMax,
int  advance 
)
inline

Construct metrics from FreeType coordinates (Y up).

Definition at line 142 of file font.h.

◆ GlyphMetrics() [2/4]

roo_display::GlyphMetrics::GlyphMetrics ( )
default

◆ GlyphMetrics() [3/4]

roo_display::GlyphMetrics::GlyphMetrics ( const GlyphMetrics )
default

◆ GlyphMetrics() [4/4]

roo_display::GlyphMetrics::GlyphMetrics ( GlyphMetrics &&  )
default

Member Function Documentation

◆ advance()

int roo_display::GlyphMetrics::advance ( ) const
inline

Advance in pixels.

Definition at line 177 of file font.h.

Referenced by roo_display::TextLabel::anchorExtents(), roo_display::StringViewLabel::anchorExtents(), and rsb().

◆ bearingX()

int roo_display::GlyphMetrics::bearingX ( ) const
inline

Left side bearing.

Definition at line 164 of file font.h.

References roo_display::Box::xMin().

◆ bearingY()

int roo_display::GlyphMetrics::bearingY ( ) const
inline

Top side bearing.

Definition at line 166 of file font.h.

References roo_display::Box::yMin().

◆ glyphXMax()

int roo_display::GlyphMetrics::glyphXMax ( ) const
inline

Definition at line 159 of file font.h.

References roo_display::Box::xMax().

◆ glyphXMin()

int roo_display::GlyphMetrics::glyphXMin ( ) const
inline

Bounding box in FreeType coordinates (Y up).

Definition at line 158 of file font.h.

References roo_display::Box::xMin().

◆ glyphYMax()

int roo_display::GlyphMetrics::glyphYMax ( ) const
inline

Definition at line 161 of file font.h.

References roo_display::Box::yMin().

◆ glyphYMin()

int roo_display::GlyphMetrics::glyphYMin ( ) const
inline

Definition at line 160 of file font.h.

References roo_display::Box::yMax().

◆ height()

int roo_display::GlyphMetrics::height ( ) const
inline

Glyph height.

Definition at line 174 of file font.h.

References roo_display::Box::height().

◆ lsb()

int roo_display::GlyphMetrics::lsb ( ) const
inline

Left side bearing (alias).

Definition at line 170 of file font.h.

References roo_display::Box::xMin().

◆ operator=() [1/2]

GlyphMetrics & roo_display::GlyphMetrics::operator= ( const GlyphMetrics )
default

◆ operator=() [2/2]

GlyphMetrics & roo_display::GlyphMetrics::operator= ( GlyphMetrics &&  )
default

◆ rsb()

int roo_display::GlyphMetrics::rsb ( ) const
inline

Right side bearing.

Definition at line 168 of file font.h.

References advance(), and roo_display::Box::xMax().

◆ screen_extents()

const Box & roo_display::GlyphMetrics::screen_extents ( ) const
inline

◆ width()

int roo_display::GlyphMetrics::width ( ) const
inline

Glyph width.

Definition at line 172 of file font.h.

References roo_display::Box::width().


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