IDWriteFontFace1::GetRecommendedRenderingMode method

Determines the recommended rendering mode for the font, using the specified size and rendering parameters.

Syntax


virtual HRESULT GetRecommendedRenderingMode(
  FLOAT  fontEmSize,
  FLOAT dpiX,
  FLOAT dpiY,
  [in, optional]  const DWRITE_MATRIX *transform,
  BOOL isSideways,
  DWRITE_OUTLINE_THRESHOLD outlineThreshold,
  DWRITE_MEASURING_MODE  measuringMode,
  [out]           DWRITE_RENDERING_MODE * renderingMode
) = 0;

Parameters

fontEmSize

Type: FLOAT

The logical size of the font in DIP units. A DIP ("device-independent pixel") equals 1/96 inch.

dpiX

Type: FLOAT

The number of physical pixels per DIP in a horizontal position. For example, if the DPI of the rendering surface is 96, this value is 1.0f. If the DPI is 120, this value is 120.0f/96.

dpiY

Type: FLOAT

The number of physical pixels per DIP in a vertical position. For example, if the DPI of the rendering surface is 96, this value is 1.0f. If the DPI is 120, this value is 120.0f/96.

transform [in, optional]

Type: const DWRITE_MATRIX*

Specifies the world transform.

isSideways

Type: BOOL

Whether the glyphs in the run are sideways or not.

outlineThreshold

Type: DWRITE_OUTLINE_THRESHOLD

A DWRITE_OUTLINE_THRESHOLD-typed value that specifies the quality of the graphics system's outline rendering, affects the size threshold above which outline rendering is used.

measuringMode

Type: DWRITE_MEASURING_MODE

The measuring method that will be used for glyphs in the font. Renderer implementations may choose different rendering modes for different measuring methods, for example:

renderingMode [out]

Type: DWRITE_RENDERING_MODE*

When this method returns, contains a value that indicates the recommended rendering mode to use.

Return value

Type: HRESULT

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

Remarks

This method should be used to determine the actual rendering mode in cases where the rendering mode of the rendering params object is DWRITE_RENDERING_MODE_DEFAULT.

Requirements

Minimum supported client

Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps | Windows Store apps]

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Header

Dwrite_1.h

Library

Dwrite_1.lib

DLL

Dwrite_1.dll

See also

IDWriteFontFace1

 

 

Community Additions

ADD
Show:
© 2014 Microsoft