RetroArch
Public Attributes | List of all members
DWRITE_GLYPH_METRICS Struct Reference

The DWRITE_GLYPH_METRICS structure specifies the metrics of an individual glyph. The units depend on how the metrics are obtained. More...

#include <dwrite.h>

Public Attributes

INT32 leftSideBearing
 Specifies the X offset from the glyph origin to the left edge of the black box. The glyph origin is the current horizontal writing position. A negative value means the black box extends to the left of the origin (often true for lowercase italic 'f'). More...
 
UINT32 advanceWidth
 Specifies the X offset from the origin of the current glyph to the origin of the next glyph when writing horizontally. More...
 
INT32 rightSideBearing
 Specifies the X offset from the right edge of the black box to the origin of the next glyph when writing horizontally. The value is negative when the right edge of the black box overhangs the layout box. More...
 
INT32 topSideBearing
 Specifies the vertical offset from the vertical origin to the top of the black box. Thus, a positive value adds whitespace whereas a negative value means the glyph overhangs the top of the layout box. More...
 
UINT32 advanceHeight
 Specifies the Y offset from the vertical origin of the current glyph to the vertical origin of the next glyph when writing vertically. (Note that the term "origin" by itself denotes the horizontal origin. The vertical origin is different. Its Y coordinate is specified by verticalOriginY value, and its X coordinate is half the advanceWidth to the right of the horizontal origin). More...
 
INT32 bottomSideBearing
 Specifies the vertical distance from the black box's bottom edge to the advance height. Positive when the bottom edge of the black box is within the layout box. Negative when the bottom edge of black box overhangs the layout box. More...
 
INT32 verticalOriginY
 Specifies the Y coordinate of a glyph's vertical origin, in the font's design coordinate system. The y coordinate of a glyph's vertical origin is the sum of the glyph's top side bearing and the top (i.e. yMax) of the glyph's bounding box. More...
 

Detailed Description

The DWRITE_GLYPH_METRICS structure specifies the metrics of an individual glyph. The units depend on how the metrics are obtained.

Member Data Documentation

◆ advanceHeight

UINT32 DWRITE_GLYPH_METRICS::advanceHeight

Specifies the Y offset from the vertical origin of the current glyph to the vertical origin of the next glyph when writing vertically. (Note that the term "origin" by itself denotes the horizontal origin. The vertical origin is different. Its Y coordinate is specified by verticalOriginY value, and its X coordinate is half the advanceWidth to the right of the horizontal origin).

◆ advanceWidth

UINT32 DWRITE_GLYPH_METRICS::advanceWidth

Specifies the X offset from the origin of the current glyph to the origin of the next glyph when writing horizontally.

◆ bottomSideBearing

INT32 DWRITE_GLYPH_METRICS::bottomSideBearing

Specifies the vertical distance from the black box's bottom edge to the advance height. Positive when the bottom edge of the black box is within the layout box. Negative when the bottom edge of black box overhangs the layout box.

◆ leftSideBearing

INT32 DWRITE_GLYPH_METRICS::leftSideBearing

Specifies the X offset from the glyph origin to the left edge of the black box. The glyph origin is the current horizontal writing position. A negative value means the black box extends to the left of the origin (often true for lowercase italic 'f').

◆ rightSideBearing

INT32 DWRITE_GLYPH_METRICS::rightSideBearing

Specifies the X offset from the right edge of the black box to the origin of the next glyph when writing horizontally. The value is negative when the right edge of the black box overhangs the layout box.

◆ topSideBearing

INT32 DWRITE_GLYPH_METRICS::topSideBearing

Specifies the vertical offset from the vertical origin to the top of the black box. Thus, a positive value adds whitespace whereas a negative value means the glyph overhangs the top of the layout box.

◆ verticalOriginY

INT32 DWRITE_GLYPH_METRICS::verticalOriginY

Specifies the Y coordinate of a glyph's vertical origin, in the font's design coordinate system. The y coordinate of a glyph's vertical origin is the sum of the glyph's top side bearing and the top (i.e. yMax) of the glyph's bounding box.


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