IDWriteTextLayout::GetDrawingEffect method (dwrite.h)

Gets the application-defined drawing effect at the specified text position.

Syntax

HRESULT GetDrawingEffect(
                  UINT32            currentPosition,
  [out]           IUnknown          **drawingEffect,
  [out, optional] DWRITE_TEXT_RANGE *textRange
);

Parameters

currentPosition

Type: UINT32

The position of the text whose drawing effect is to be retrieved.

[out] drawingEffect

Type: IUnknown**

When this method returns, contains an address of a pointer to the current application-defined drawing effect. Usually this effect is a foreground brush that is used in glyph drawing.

[out, optional] textRange

Type: DWRITE_TEXT_RANGE*

Contains the range of text that has the same formatting as the text at the position specified by currentPosition. This means the run has the exact formatting as the position specified, including but not limited to the drawing effect.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

See also

IDWriteTextLayout