IDWriteTextRenderer::DrawInlineObject method (dwrite.h)

IDWriteTextLayout::Draw calls this application callback when it needs to draw an inline object.

Syntax

HRESULT DrawInlineObject(
  void                *clientDrawingContext,
  FLOAT               originX,
  FLOAT               originY,
  IDWriteInlineObject *inlineObject,
  BOOL                isSideways,
  BOOL                isRightToLeft,
  IUnknown            *clientDrawingEffect
);

Parameters

clientDrawingContext

Type: void*

The application-defined drawing context passed to IDWriteTextLayout::Draw.

originX

Type: FLOAT

X-coordinate at the top-left corner of the inline object.

originY

Type: FLOAT

Y-coordinate at the top-left corner of the inline object.

inlineObject

Type: IDWriteInlineObject*

The application-defined inline object set using IDWriteTextFormat::SetInlineObject.

isSideways

Type: BOOL

A Boolean flag that indicates whether the object's baseline runs alongside the baseline axis of the line.

isRightToLeft

Type: BOOL

A Boolean flag that indicates whether the object is in a right-to-left context, hinting that the drawing may want to mirror the normal image.

clientDrawingEffect

Type: IUnknown*

Application-defined drawing effects for the glyphs to render. Usually this argument represents effects such as the foreground brush filling the interior of a line.

Return value

Type: HRESULT

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

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]
Target Platform	Windows
Header	dwrite.h
Library	Dwrite.lib
DLL	Dwrite.dll

See also

IDWriteTextRenderer