Edit

Share via

IDWriteTextLayout::GetClusterMetrics method (dwrite.h)

  • Article

Retrieves logical properties and measurements of each glyph cluster.

Syntax

HRESULT GetClusterMetrics(
  [out, optional] DWRITE_CLUSTER_METRICS *clusterMetrics,
                  UINT32                 maxClusterCount,
  [out]           UINT32                 *actualClusterCount
);

Parameters

[out, optional] clusterMetrics

Type: DWRITE_CLUSTER_METRICS*

When this method returns, contains metrics, such as line-break or total advance width, for a glyph cluster.

maxClusterCount

Type: UINT32

The maximum size of the clusterMetrics array.

[out] actualClusterCount

Type: UINT32*

When this method returns, contains the actual size of the clusterMetrics array that is needed.

Return value

Type: HRESULT

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

Remarks

If maxClusterCount is not large enough, then E_NOT_SUFFICIENT_BUFFER, which is equivalent to HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER), is returned and actualClusterCount is set to the number of clusters needed.

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

IDWriteTextLayout