IDWriteFontResource::CreateFontFaceReference method (dwrite_3.h)

Article
11/20/2024

Creates a font face reference with specific axis values.

Syntax

HRESULT CreateFontFaceReference(
        DWRITE_FONT_SIMULATIONS      fontSimulations,
        DWRITE_FONT_AXIS_VALUE const *fontAxisValues,
        UINT32                       fontAxisValueCount,
  [out] IDWriteFontFaceReference1    **fontFaceReference
);

Parameters

fontSimulations

Type: DWRITE_FONT_SIMULATIONS

Font face simulation flags for algorithmic emboldening and italicization.

fontAxisValues

Type: DWRITE_FONT_AXIS_VALUE const *

A pointer to an array containing a list of font axis values. The array should be the size (the number of elements) indicated by the fontAxisValueCount argument.

fontAxisValueCount

Type: UINT32

The number of font axis values contained in the fontAxisValues array.

[out] fontFaceReference

Type: IDWriteFontFaceReference1**

The address of a pointer to an IDWriteFontFaceReference1 interface. On successful completion, the function sets the pointer to a newly created font face reference object, otherwise it sets the pointer to nullptr.

Return value

Type: HRESULT

If the function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The axis values that you provide are permitted to be a subset or superset of all the ones actually supported by the font. Any unspecified axes use their default values: values beyond the ranges are clamped, and any non-varying axes have no effect.

Requirements

Requirement	Value
Minimum supported client	Windows 10 Build 16299
Minimum supported server	Windows 10 Build 16299
Target Platform	Windows
Header	dwrite_3.h
Library	Dwrite.lib

Share via