#include <SkFontMetrics.h>

Public Types
enum	FontMetricsFlags { kUnderlineThicknessIsValid_Flag = 1 << 0 , kUnderlinePositionIsValid_Flag = 1 << 1 , kStrikeoutThicknessIsValid_Flag = 1 << 2 , kStrikeoutPositionIsValid_Flag = 1 << 3 , kBoundsInvalid_Flag = 1 << 4 }

Public Member Functions
bool	operator== (const SkFontMetrics &that) const

bool	hasUnderlineThickness (SkScalar *thickness) const

bool	hasUnderlinePosition (SkScalar *position) const

bool	hasStrikeoutThickness (SkScalar *thickness) const

bool	hasStrikeoutPosition (SkScalar *position) const

bool	hasBounds () const

Public Attributes
uint32_t	fFlags
	FontMetricsFlags indicating which metrics are valid.

SkScalar	fTop
	greatest extent above origin of any glyph bounding box, typically negative; deprecated with variable fonts

SkScalar	fAscent
	distance to reserve above baseline, typically negative

SkScalar	fDescent
	distance to reserve below baseline, typically positive

SkScalar	fBottom
	greatest extent below origin of any glyph bounding box, typically positive; deprecated with variable fonts

SkScalar	fLeading
	distance to add between lines, typically positive or zero

SkScalar	fAvgCharWidth
	average character width, zero if unknown

SkScalar	fMaxCharWidth
	maximum character width, zero if unknown

SkScalar	fXMin
	greatest extent to left of origin of any glyph bounding box, typically negative; deprecated with variable fonts

SkScalar	fXMax
	greatest extent to right of origin of any glyph bounding box, typically positive; deprecated with variable fonts

SkScalar	fXHeight
	height of lower-case 'x', zero if unknown, typically negative

SkScalar	fCapHeight
	height of an upper-case letter, zero if unknown, typically negative

SkScalar	fUnderlineThickness
	underline thickness

SkScalar	fUnderlinePosition
	distance from baseline to top of stroke, typically positive

SkScalar	fStrikeoutThickness
	strikeout thickness

SkScalar	fStrikeoutPosition
	distance from baseline to bottom of stroke, typically negative

Detailed Description

The metrics of an SkFont. The metric values are consistent with the Skia y-down coordinate system.

Definition at line 18 of file SkFontMetrics.h.

Member Enumeration Documentation

◆ FontMetricsFlags

enum SkFontMetrics::FontMetricsFlags

FontMetricsFlags indicate when certain metrics are valid; the underline or strikeout metrics may be valid and zero. Fonts with embedded bitmaps may not have valid underline or strikeout metrics.

Enumerator
kUnderlineThicknessIsValid_Flag	set if fUnderlineThickness is valid
kUnderlinePositionIsValid_Flag	set if fUnderlinePosition is valid
kStrikeoutThicknessIsValid_Flag	set if fStrikeoutThickness is valid
kStrikeoutPositionIsValid_Flag	set if fStrikeoutPosition is valid
kBoundsInvalid_Flag	set if fTop, fBottom, fXMin, fXMax invalid

Definition at line 44 of file SkFontMetrics.h.

                          {
        kUnderlineThicknessIsValid_Flag = 1 << 0, //!< set if fUnderlineThickness is valid
        kUnderlinePositionIsValid_Flag  = 1 << 1, //!< set if fUnderlinePosition is valid
        kStrikeoutThicknessIsValid_Flag = 1 << 2, //!< set if fStrikeoutThickness is valid
        kStrikeoutPositionIsValid_Flag  = 1 << 3, //!< set if fStrikeoutPosition is valid
        kBoundsInvalid_Flag             = 1 << 4, //!< set if fTop, fBottom, fXMin, fXMax invalid
    };

Member Function Documentation

◆ hasBounds()

bool SkFontMetrics::hasBounds ( ) const

inline

Returns true if SkFontMetrics has a valid fTop, fBottom, fXMin, and fXMax. If the bounds are not valid, return false.

Returns: true if font specifies maximum glyph bounds

Definition at line 134 of file SkFontMetrics.h.

                           {
        return !SkToBool(fFlags & kBoundsInvalid_Flag);
    }

◆ hasStrikeoutPosition()

bool SkFontMetrics::hasStrikeoutPosition ( SkScalar * position ) const

inline

Returns true if SkFontMetrics has a valid strikeout position, and sets position to that value. If the underline position is not valid, return false, and ignore position.

Parameters

position storage for strikeout position

Returns: true if font specifies strikeout position

Definition at line 121 of file SkFontMetrics.h.

                                                        {
        if (SkToBool(fFlags & kStrikeoutPositionIsValid_Flag)) {
            *position = fStrikeoutPosition;
            return true;
        }
        return false;
    }

◆ hasStrikeoutThickness()

bool SkFontMetrics::hasStrikeoutThickness ( SkScalar * thickness ) const

inline

Returns true if SkFontMetrics has a valid strikeout thickness, and sets thickness to that value. If the underline thickness is not valid, return false, and ignore thickness.

Parameters

thickness storage for strikeout width

Returns: true if font specifies strikeout width

Definition at line 106 of file SkFontMetrics.h.

                                                          {
        if (SkToBool(fFlags & kStrikeoutThicknessIsValid_Flag)) {
            *thickness = fStrikeoutThickness;
            return true;
        }
        return false;
    }

◆ hasUnderlinePosition()

bool SkFontMetrics::hasUnderlinePosition ( SkScalar * position ) const

inline

Returns true if SkFontMetrics has a valid underline position, and sets position to that value. If the underline position is not valid, return false, and ignore position.

Parameters

position storage for underline position

Returns: true if font specifies underline position

Definition at line 91 of file SkFontMetrics.h.

                                                        {
        if (SkToBool(fFlags & kUnderlinePositionIsValid_Flag)) {
            *position = fUnderlinePosition;
            return true;
        }
        return false;
    }

◆ hasUnderlineThickness()

bool SkFontMetrics::hasUnderlineThickness ( SkScalar * thickness ) const

inline

Returns true if SkFontMetrics has a valid underline thickness, and sets thickness to that value. If the underline thickness is not valid, return false, and ignore thickness.

Parameters

thickness storage for underline width

Returns: true if font specifies underline width

Definition at line 76 of file SkFontMetrics.h.

                                                          {
        if (SkToBool(fFlags & kUnderlineThicknessIsValid_Flag)) {
            *thickness = fUnderlineThickness;
            return true;
        }
        return false;
    }

◆ operator==()

bool SkFontMetrics::operator== ( const SkFontMetrics & that ) const

inline

Definition at line 19 of file SkFontMetrics.h.

                                                     {
        return
        this->fFlags == that.fFlags &&
        this->fTop == that.fTop &&
        this->fAscent == that.fAscent &&
        this->fDescent == that.fDescent &&
        this->fBottom == that.fBottom &&
        this->fLeading == that.fLeading &&
        this->fAvgCharWidth == that.fAvgCharWidth &&
        this->fMaxCharWidth == that.fMaxCharWidth &&
        this->fXMin == that.fXMin &&
        this->fXMax == that.fXMax &&
        this->fXHeight == that.fXHeight &&
        this->fCapHeight == that.fCapHeight &&
        this->fUnderlineThickness == that.fUnderlineThickness &&
        this->fUnderlinePosition == that.fUnderlinePosition &&
        this->fStrikeoutThickness == that.fStrikeoutThickness &&
        this->fStrikeoutPosition == that.fStrikeoutPosition;
    }

Member Data Documentation

◆ fAscent

SkScalar SkFontMetrics::fAscent

distance to reserve above baseline, typically negative

Definition at line 54 of file SkFontMetrics.h.

◆ fAvgCharWidth

SkScalar SkFontMetrics::fAvgCharWidth

average character width, zero if unknown

Definition at line 58 of file SkFontMetrics.h.

◆ fBottom

SkScalar SkFontMetrics::fBottom

greatest extent below origin of any glyph bounding box, typically positive; deprecated with variable fonts

Definition at line 56 of file SkFontMetrics.h.

◆ fCapHeight

SkScalar SkFontMetrics::fCapHeight

height of an upper-case letter, zero if unknown, typically negative

Definition at line 63 of file SkFontMetrics.h.

◆ fDescent

SkScalar SkFontMetrics::fDescent

distance to reserve below baseline, typically positive

Definition at line 55 of file SkFontMetrics.h.

◆ fFlags

uint32_t SkFontMetrics::fFlags

FontMetricsFlags indicating which metrics are valid.

Definition at line 52 of file SkFontMetrics.h.

◆ fLeading

SkScalar SkFontMetrics::fLeading

distance to add between lines, typically positive or zero

Definition at line 57 of file SkFontMetrics.h.

◆ fMaxCharWidth

SkScalar SkFontMetrics::fMaxCharWidth

maximum character width, zero if unknown

Definition at line 59 of file SkFontMetrics.h.

◆ fStrikeoutPosition

SkScalar SkFontMetrics::fStrikeoutPosition

distance from baseline to bottom of stroke, typically negative

Definition at line 67 of file SkFontMetrics.h.

◆ fStrikeoutThickness

SkScalar SkFontMetrics::fStrikeoutThickness

strikeout thickness

Definition at line 66 of file SkFontMetrics.h.

◆ fTop

SkScalar SkFontMetrics::fTop

greatest extent above origin of any glyph bounding box, typically negative; deprecated with variable fonts

Definition at line 53 of file SkFontMetrics.h.

◆ fUnderlinePosition

SkScalar SkFontMetrics::fUnderlinePosition

distance from baseline to top of stroke, typically positive

Definition at line 65 of file SkFontMetrics.h.

◆ fUnderlineThickness

SkScalar SkFontMetrics::fUnderlineThickness

underline thickness

Definition at line 64 of file SkFontMetrics.h.

◆ fXHeight

SkScalar SkFontMetrics::fXHeight

height of lower-case 'x', zero if unknown, typically negative

Definition at line 62 of file SkFontMetrics.h.

◆ fXMax

SkScalar SkFontMetrics::fXMax

greatest extent to right of origin of any glyph bounding box, typically positive; deprecated with variable fonts

Definition at line 61 of file SkFontMetrics.h.

◆ fXMin

SkScalar SkFontMetrics::fXMin

greatest extent to left of origin of any glyph bounding box, typically negative; deprecated with variable fonts

Definition at line 60 of file SkFontMetrics.h.

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

third_party/skia/include/core/SkFontMetrics.h

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Enumeration Documentation

◆ FontMetricsFlags

Member Function Documentation

◆ hasBounds()

◆ hasStrikeoutPosition()

◆ hasStrikeoutThickness()

◆ hasUnderlinePosition()

◆ hasUnderlineThickness()

◆ operator==()

Member Data Documentation

◆ fAscent

◆ fAvgCharWidth

◆ fBottom

◆ fCapHeight

◆ fDescent

◆ fFlags

◆ fLeading

◆ fMaxCharWidth

◆ fStrikeoutPosition

◆ fStrikeoutThickness

◆ fTop

◆ fUnderlinePosition

◆ fUnderlineThickness

◆ fXHeight

◆ fXMax

◆ fXMin