IDWritePixelSnapping::IsPixelSnappingEnabled method

  • Article

Determines whether pixel snapping is disabled. The recommended default is FALSE, unless doing animation that requires subpixel vertical placement.

Syntax

virtual HRESULT IsPixelSnappingEnabled(
         void * clientDrawingContext,
  [out] BOOL  * isDisabled
) = 0;

Parameters

  • clientDrawingContext
    Type: void*

    The context passed to IDWriteTextLayout::Draw.

  • isDisabled [out]
    Type: BOOL*

    Receives TRUE if pixel snapping is disabled; otherwise, FALSE.

Return value

Type: HRESULT

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

Requirements

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]

Minimum supported phone

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

Header

 Dwrite.h

Library

 Dwrite.lib

DLL

 Dwrite.dll

See also

IDWritePixelSnapping