ID2D1RenderTarget::SetTextRenderingParams method (d2d1.h)

Specifies text rendering options to be applied to all subsequent text and glyph drawing operations.

Syntax

void SetTextRenderingParams(
  [in, optional] IDWriteRenderingParams *textRenderingParams
);

Parameters

[in, optional] textRenderingParams

Type: IDWriteRenderingParams*

The text rendering options to be applied to all subsequent text and glyph drawing operations; NULL to clear current text rendering options.

Return value

None

Remarks

If the settings specified by textRenderingParams are incompatible with the render target's text antialiasing mode (specified by SetTextAntialiasMode), subsequent text and glyph drawing operations will fail and put the render target into an error state.

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 d2d1.h
Library D2d1.lib
DLL D2d1.dll

See also

GetTextRenderingParams

ID2D1RenderTarget

SetTextAntialiasMode