IDWriteFactory2::CreateCustomRenderingParams method (dwrite_2.h)

Creates a rendering parameters object with the specified properties.

Syntax

HRESULT CreateCustomRenderingParams(
        FLOAT                   gamma,
        FLOAT                   enhancedContrast,
        FLOAT                   grayscaleEnhancedContrast,
        FLOAT                   clearTypeLevel,
        DWRITE_PIXEL_GEOMETRY   pixelGeometry,
        DWRITE_RENDERING_MODE   renderingMode,
        DWRITE_GRID_FIT_MODE    gridFitMode,
  [out] IDWriteRenderingParams2 **renderingParams
);

Parameters

gamma

Type: FLOAT

The gamma value used for gamma correction, which must be greater than zero and cannot exceed 256.

enhancedContrast

Type: FLOAT

The amount of contrast enhancement, zero or greater.

grayscaleEnhancedContrast

Type: FLOAT

The amount of contrast enhancement, zero or greater.

clearTypeLevel

Type: FLOAT

The degree of ClearType level, from 0.0f (no ClearType) to 1.0f (full ClearType).

pixelGeometry

Type: DWRITE_PIXEL_GEOMETRY

The geometry of a device pixel.

renderingMode

Type: DWRITE_RENDERING_MODE

Method of rendering glyphs. In most cases, this should be DWRITE_RENDERING_MODE_DEFAULT to automatically use an appropriate mode.

gridFitMode

Type: DWRITE_GRID_FIT_MODE

How to grid fit glyph outlines. In most cases, this should be DWRITE_GRID_FIT_DEFAULT to automatically choose an appropriate mode.

[out] renderingParams

Type: IDWriteRenderingParams2**

Holds the newly created rendering parameters object, or NULL in case of failure.

Return value

Type: HRESULT

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

Requirements

Requirement	Value
Minimum supported client	Windows 8.1 [desktop apps | UWP apps]
Minimum supported server	Windows Server 2012 R2 [desktop apps | UWP apps]
Target Platform	Windows
Header	dwrite_2.h
Library	Dwrite.lib
DLL	Dwrite.dll

See also

IDWriteFactory2