Edit

Share via

DWRITE_UNDERLINE structure (dwrite.h)

  • Article

Contains information about the width, thickness, offset, run height, reading direction, and flow direction of an underline.

Syntax

struct DWRITE_UNDERLINE {
  FLOAT                    width;
  FLOAT                    thickness;
  FLOAT                    offset;
  FLOAT                    runHeight;
  DWRITE_READING_DIRECTION readingDirection;
  DWRITE_FLOW_DIRECTION    flowDirection;
  WCHAR const              *localeName;
  DWRITE_MEASURING_MODE    measuringMode;
};

Members

width

Type: FLOAT

A value that indicates the width of the underline, measured parallel to the baseline.

thickness

Type: FLOAT

A value that indicates the thickness of the underline, measured perpendicular to the baseline.

offset

Type: FLOAT

A value that indicates the offset of the underline from the baseline. A positive offset represents a position below the baseline (away from the text) and a negative offset is above (toward the text).

runHeight

Type: FLOAT

A value that indicates the height of the tallest run where the underline is applied.

readingDirection

Type: DWRITE_READING_DIRECTION

A value that indicates the reading direction of the text associated with the underline. This value is used to interpret whether the width value runs horizontally or vertically.

flowDirection

Type: DWRITE_FLOW_DIRECTION

A value that indicates the 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

Type: const WCHAR*

An array of characters which contains the locale of the text that the underline is being drawn under. For example, in vertical text, the underline belongs on the left for Chinese but on the right for Japanese.

measuringMode

Type: DWRITE_MEASURING_MODE

The measuring mode can be useful to the renderer to determine how underlines are rendered, such as rounding the thickness to a whole pixel in GDI-compatible modes.

Remarks

All coordinates are in device independent pixels (DIPs).

Requirements

Requirement Value
Minimum supported client Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps | UWP apps]
Minimum supported server Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps | UWP apps]
Header dwrite.h