IDWriteFactory3::CreateCustomRenderingParams method

Creates a rendering parameters object with the specified properties.

Syntax

virtual HRESULT CreateCustomRenderingParams(
        FLOAT                   gamma,
        FLOAT                   enhancedContrast,
        FLOAT                   grayscaleEnhancedContrast,
        FLOAT                   clearTypeLevel,
        DWRITE_PIXEL_GEOMETRY   pixelGeometry,
        DWRITE_RENDERING_MODE1  renderingMode,
        DWRITE_GRID_FIT_MODE    gridFitMode,
  [out] IDWriteRenderingParams3 **renderingParams
) = 0;

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 to use for grayscale antialiasing, 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

A DWRITE_PIXEL_GEOMETRY-typed value that specifies 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_MODE1

A DWRITE_RENDERING_MODE1-typed value that specifies the method (for example, ClearType natural quality) for rendering glyphs. In most cases, specify DWRITE_RENDERING_MODE1_DEFAULT to automatically use an appropriate mode.

gridFitMode

Type: DWRITE_GRID_FIT_MODE

A DWRITE_GRID_FIT_MODE-typed value that specifies how to grid-fit glyph outlines. In most cases, specify DWRITE_GRID_FIT_DEFAULT to automatically choose an appropriate mode.

renderingParams [out]

Type: IDWriteRenderingParams3**

A pointer to a memory block that receives a pointer to a IDWriteRenderingParams3 interface for 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

See also

IDWriteFactory3