Edit

Share via

IDWriteBitmapRenderTarget3::DrawPaintGlyphRun method (dwrite_3.h)

  • Article

Draws a glyph run in a "paint" image format returned by IDWriteColorGlyphRunEnumerator1.

Syntax

HRESULT DrawPaintGlyphRun(
  FLOAT                      baselineOriginX,
  FLOAT                      baselineOriginY,
  DWRITE_MEASURING_MODE      measuringMode,
  DWRITE_GLYPH_RUN const     *glyphRun,
  DWRITE_GLYPH_IMAGE_FORMATS glyphImageFormat,
  COLORREF                   textColor,
  UINT32                     colorPaletteIndex,
  RECT                       *blackBoxRect
);

Parameters

baselineOriginX

Type: FLOAT

X-coordinate of the baseline.

baselineOriginY

Type: FLOAT

Y-coordinate of the baseline.

measuringMode

Type: DWRITE_MEASURING_MODE

Specifies measuring mode for positioning glyphs in the run.

glyphRun

Type: _In_ DWRITE_GLYPH_RUN const*

The glyph run to draw.

glyphImageFormat

Type: DWRITE_GLYPH_IMAGE_FORMATS

The image format of the color glyph run, as returned by IDWriteColorGlyphRunEnumerator1. This must be one of the "paint" image formats.

textColor

Type: COLORREF

Foreground color of the text, used in cases where a color glyph uses the text color.

colorPaletteIndex

Type: UINT32

Zero-based index of the font-defined color palette to use.

blackBoxRect

Type: _Out_opt_ RECT *

Optional rectangle that receives the bounding box (in pixels, not DIPs) of all the pixels affected by drawing the glyph run. The black box rectangle might extend beyond the dimensions of the bitmap.

Return value

A standard HRESULT error code.

Requirements

Requirement Value
Minimum supported client Windows 10, version 1809 (with Windows App SDK 1.2 or later)
Header dwrite_3.h