IDWriteFactory1::CreateCustomRenderingParams method (dwrite_1.h)

  • Article

Creates a rendering parameters object with the specified properties.

Syntax

HRESULT CreateCustomRenderingParams(
        FLOAT                   gamma,
        FLOAT                   enhancedContrast,
        FLOAT                   enhancedContrastGrayscale,
        FLOAT                   clearTypeLevel,
        DWRITE_PIXEL_GEOMETRY   pixelGeometry,
        DWRITE_RENDERING_MODE   renderingMode,
  [out] IDWriteRenderingParams1 **renderingParams
);

Parameters

gamma

Type: FLOAT

The gamma level to be set for the new rendering parameters object.

enhancedContrast

Type: FLOAT

The enhanced contrast level to be set for the new rendering parameters object.

enhancedContrastGrayscale

Type: FLOAT

The amount of contrast enhancement to use for grayscale antialiasing, zero or greater.

clearTypeLevel

Type: FLOAT

The ClearType level to be set for the new rendering parameters object.

pixelGeometry

Type: DWRITE_PIXEL_GEOMETRY

Represents the internal structure of a device pixel (that is, the physical arrangement of red, green, and blue color components) that is assumed for purposes of rendering text.

renderingMode

Type: DWRITE_RENDERING_MODE

A value that represents the method (for example, ClearType natural quality) for rendering glyphs.

[out] renderingParams

Type: IDWriteRenderingParams1**

When this method returns, contains an address of a pointer to the newly created rendering parameters object.

Return value

Type: HRESULT

Standard HRESULT error code.

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

IDWriteFactory1