IDWriteBitmapRenderTarget1::SetTextAntialiasMode method (dwrite_1.h)

Sets the current text antialiasing mode of the bitmap render target.

Syntax

HRESULT SetTextAntialiasMode(
  DWRITE_TEXT_ANTIALIAS_MODE antialiasMode
);

Parameters

antialiasMode

Type: DWRITE_TEXT_ANTIALIAS_MODE

A DWRITE_TEXT_ANTIALIAS_MODE-typed value that specifies the antialiasing mode.

Return value

Type: HRESULT

Returns S_OK if successful, or E_INVALIDARG if the argument is not valid.

Remarks

The antialiasing mode of a newly-created bitmap render target defaults to DWRITE_TEXT_ANTIALIAS_MODE_CLEARTYPE. An app can change the antialiasing mode by calling SetTextAntialiasMode. For example, an app might specify DWRITE_TEXT_ANTIALIAS_MODE_GRAYSCALE for grayscale antialiasing when it renders text onto a transparent bitmap.

Requirements

Requirement	Value
Minimum supported client	Windows 8 and Platform Update for Windows 7 [desktop apps | UWP apps]
Minimum supported server	Windows Server 2012 and Platform Update for Windows Server 2008 R2 [desktop apps | UWP apps]
Target Platform	Windows
Header	dwrite_1.h
Library	Dwrite.lib
DLL	Dwrite.dll

See also

IDWriteBitmapRenderTarget1