IDWriteInlineObject::GetOverhangMetrics method

IDWriteTextLayout calls this callback function to get the visible extents (in DIPs) of the inline object. In the case of a simple bitmap, with no padding and no overhang, all the overhangs will simply be zeroes.

The overhangs should be returned relative to the reported size of the object (see DWRITE_INLINE_OBJECT_METRICS), and should not be baseline adjusted.

Syntax

virtual HRESULT GetOverhangMetrics(
  [out] DWRITE_OVERHANG_METRICS *overhangs
) = 0;

Parameters

overhangs [out]

Type: DWRITE_OVERHANG_METRICS*

Overshoot of visible extents (in DIPs) outside the object.

Return value

Type: HRESULT

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

Requirements

See also

IDWriteInlineObject

IDWriteInlineObject