IDWriteTextLayout::GetClusterMetrics Method

Retrieves logical properties and measurements of each glyph cluster.

Syntax

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

Parameter

• clusterMetrics [out, optional]
  When this method returns, contains metrics, such as line-break or total advance width, for a glyph cluster.

• maxClusterCount
  The maximum size of the clusterMetrics array.

• actualClusterCount [out]
  When this method returns, contains the actual size of the clusterMetrics array that is needed.

Rückgabewert

Ist Methode erfolgreich, wird "S_OK" zurückgegeben. Andernfalls wird ein HRESULT-Fehlercode zurückgegeben.

Hinweise

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.

Anforderungen

Siehe auch

IDWriteTextLayout