Atom
Public Attributes | List of all members
DWRITE_UNDERLINE Struct Reference

The DWRITE_UNDERLINE structure contains about the size and placement of underlines. More...

#include <DWrite.h>

Public Attributes

FLOAT width
 Width of the underline, measured parallel to the baseline. More...
 
FLOAT thickness
 Thickness of the underline, measured perpendicular to the baseline. More...
 
FLOAT offset
 Offset of the underline from the baseline. More...
 
FLOAT runHeight
 Height of the tallest run where the underline applies. More...
 
DWRITE_READING_DIRECTION readingDirection
 Reading direction of the text associated with the underline. More...
 
DWRITE_FLOW_DIRECTION flowDirection
 Flow direction of the text associated with the underline. More...
 
__nullterminated WCHAR const * localeName
 Locale of the text the underline is being drawn under. More...
 
DWRITE_MEASURING_MODE measuringMode
 The measuring mode can be useful to the renderer to determine how underlines are rendered, e.g. More...
 

Detailed Description

The DWRITE_UNDERLINE structure contains about the size and placement of underlines.

All coordinates are in device independent pixels (DIPs).

Member Data Documentation

§ flowDirection

DWRITE_FLOW_DIRECTION DWRITE_UNDERLINE::flowDirection

Flow direction of the text associated with the underline.

This value is used to interpret whether the thickness value advances top to bottom, left to right, or right to left.

§ localeName

__nullterminated WCHAR const* DWRITE_UNDERLINE::localeName

Locale of the text the underline is being drawn under.

Can be pertinent where the locale affects how the underline is drawn. For example, in vertical text, the underline belongs on the left for Chinese but on the right for Japanese. This choice is completely left up to higher levels.

§ measuringMode

DWRITE_MEASURING_MODE DWRITE_UNDERLINE::measuringMode

The measuring mode can be useful to the renderer to determine how underlines are rendered, e.g.

rounding the thickness to a whole pixel in GDI-compatible modes.

§ offset

FLOAT DWRITE_UNDERLINE::offset

Offset of the underline from the baseline.

A positive offset represents a position below the baseline and a negative offset is above.

§ readingDirection

DWRITE_READING_DIRECTION DWRITE_UNDERLINE::readingDirection

Reading direction of the text associated with the underline.

This value is used to interpret whether the width value runs horizontally or vertically.

§ runHeight

FLOAT DWRITE_UNDERLINE::runHeight

Height of the tallest run where the underline applies.

§ thickness

FLOAT DWRITE_UNDERLINE::thickness

Thickness of the underline, measured perpendicular to the baseline.

§ width

FLOAT DWRITE_UNDERLINE::width

Width of the underline, measured parallel to the baseline.


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