mirror of
https://github.com/RPCS3/rpcs3.git
synced 2024-11-17 17:11:23 +00:00
afefecf1f0
Moves GL, minidx12, OpenAL, stblib to 3rdparty Fixes AppVeyor and CMakeLists (travis-ci.yml doesn't need any changes) Points directories in the VS solution files to the new ones on the externals directory Includes stuff with the < > syntax instead of " "
1744 lines
72 KiB
C
1744 lines
72 KiB
C
//+--------------------------------------------------------------------------
|
|
//
|
|
// Copyright (c) Microsoft Corporation. All rights reserved.
|
|
//
|
|
// Abstract:
|
|
// DirectX Typography Services public API definitions.
|
|
//
|
|
//----------------------------------------------------------------------------
|
|
|
|
#ifndef DWRITE_3_H_INCLUDED
|
|
#define DWRITE_3_H_INCLUDED
|
|
|
|
#if _MSC_VER > 1000
|
|
#pragma once
|
|
#endif
|
|
|
|
#include <DWrite_2.h>
|
|
|
|
interface IDWriteFontFaceReference;
|
|
interface IDWriteFont3;
|
|
interface IDWriteFontFace3;
|
|
interface IDWriteFontFaceReference;
|
|
interface IDWriteFontSet;
|
|
interface IDWriteFontSetBuilder;
|
|
interface IDWriteFontCollection1;
|
|
interface IDWriteFontFamily1;
|
|
interface IDWriteStringList;
|
|
interface IDWriteFontDownloadQueue;
|
|
|
|
|
|
/// <summary>
|
|
/// A font resource could not be accessed because it was remote. This can happen
|
|
/// when calling CreateFontFace on a non-local font or trying to measure/draw
|
|
/// glyphs that are not downloaded yet.
|
|
/// </summary>
|
|
#ifndef DWRITE_E_REMOTEFONT
|
|
#define DWRITE_E_REMOTEFONT _HRESULT_TYPEDEF_(0x8898500DL)
|
|
#endif
|
|
|
|
/// <summary>
|
|
/// The download was canceled, which happens if the application calls
|
|
/// IDWriteFontDownloadQueue::CancelDownload before they finish.
|
|
/// </summary>
|
|
#ifndef DWRITE_E_DOWNLOADCANCELLED
|
|
#define DWRITE_E_DOWNLOADCANCELLED _HRESULT_TYPEDEF_(0x8898500EL)
|
|
#endif
|
|
|
|
/// <summary>
|
|
/// The download failed to complete because the remote resource is missing
|
|
/// or the network is down.
|
|
/// </summary>
|
|
#ifndef DWRITE_E_DOWNLOADFAILED
|
|
#define DWRITE_E_DOWNLOADFAILED _HRESULT_TYPEDEF_(0x8898500FL)
|
|
#endif
|
|
|
|
/// <summary>
|
|
/// A download request was not added or a download failed because there
|
|
/// are too many active downloads.
|
|
/// </summary>
|
|
#ifndef DWRITE_E_TOOMANYDOWNLOADS
|
|
#define DWRITE_E_TOOMANYDOWNLOADS _HRESULT_TYPEDEF_(0x88985010L)
|
|
#endif
|
|
|
|
/// <summary>
|
|
/// The font property enumeration identifies a string in a font.
|
|
/// </summary>
|
|
enum DWRITE_FONT_PROPERTY_ID
|
|
{
|
|
/// <summary>
|
|
/// Unspecified font property identifier.
|
|
/// </summary>
|
|
DWRITE_FONT_PROPERTY_ID_NONE,
|
|
|
|
/// <summary>
|
|
/// Family name for the weight-width-slope model.
|
|
/// </summary>
|
|
DWRITE_FONT_PROPERTY_ID_FAMILY_NAME,
|
|
|
|
/// <summary>
|
|
/// Family name preferred by the designer. This enables font designers to group more than four fonts in a single family without losing compatibility with
|
|
/// GDI. This name is typically only present if it differs from the GDI-compatible family name.
|
|
/// </summary>
|
|
DWRITE_FONT_PROPERTY_ID_PREFERRED_FAMILY_NAME,
|
|
|
|
/// <summary>
|
|
/// Face name of the (e.g., Regular or Bold).
|
|
/// </summary>
|
|
DWRITE_FONT_PROPERTY_ID_FACE_NAME,
|
|
|
|
/// <summary>
|
|
/// The full name of the font, e.g. "Arial Bold", from name id 4 in the name table.
|
|
/// </summary>
|
|
DWRITE_FONT_PROPERTY_ID_FULL_NAME,
|
|
|
|
/// <summary>
|
|
/// GDI-compatible family name. Because GDI allows a maximum of four fonts per family, fonts in the same family may have different GDI-compatible family names
|
|
/// (e.g., "Arial", "Arial Narrow", "Arial Black").
|
|
/// </summary>
|
|
DWRITE_FONT_PROPERTY_ID_WIN32_FAMILY_NAME,
|
|
|
|
/// <summary>
|
|
/// The postscript name of the font, e.g. "GillSans-Bold" from name id 6 in the name table.
|
|
/// </summary>
|
|
DWRITE_FONT_PROPERTY_ID_POSTSCRIPT_NAME,
|
|
|
|
/// <summary>
|
|
/// Script/language tag to identify the scripts or languages that the font was
|
|
/// primarily designed to support.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// The design script/language tag is meant to be understood from the perspective of
|
|
/// users. For example, a font is considered designed for English if it is considered
|
|
/// useful for English users. Note that this is different from what a font might be
|
|
/// capable of supporting. For example, the Meiryo font was primarily designed for
|
|
/// Japanese users. While it is capable of displaying English well, it was not
|
|
/// meant to be offered for the benefit of non-Japanese-speaking English users.
|
|
///
|
|
/// As another example, a font designed for Chinese may be capable of displaying
|
|
/// Japanese text, but would likely look incorrect to Japanese users.
|
|
///
|
|
/// The valid values for this property are "ScriptLangTag" values. These are adapted
|
|
/// from the IETF BCP 47 specification, "Tags for Identifying Languages" (see
|
|
/// http://tools.ietf.org/html/bcp47). In a BCP 47 language tag, a language subtag
|
|
/// element is mandatory and other subtags are optional. In a ScriptLangTag, a
|
|
/// script subtag is mandatory and other subtags are option. The following
|
|
/// augmented BNF syntax, adapted from BCP 47, is used:
|
|
///
|
|
/// ScriptLangTag = [language "-"]
|
|
/// script
|
|
/// ["-" region]
|
|
/// *("-" variant)
|
|
/// *("-" extension)
|
|
/// ["-" privateuse]
|
|
///
|
|
/// The expansion of the elements and the intended semantics associated with each
|
|
/// are as defined in BCP 47. Script subtags are taken from ISO 15924. At present,
|
|
/// no extensions are defined, and any extension should be ignored. Private use
|
|
/// subtags are defined by private agreement between the source and recipient and
|
|
/// may be ignored.
|
|
///
|
|
/// Subtags must be valid for use in BCP 47 and contained in the Language Subtag
|
|
/// Registry maintained by IANA. (See
|
|
/// http://www.iana.org/assignments/language-subtag-registry/language-subtag-registry
|
|
/// and section 3 of BCP 47 for details.
|
|
///
|
|
/// Any ScriptLangTag value not conforming to these specifications is ignored.
|
|
///
|
|
/// Examples:
|
|
/// "Latn" denotes Latin script (and any language or writing system using Latin)
|
|
/// "Cyrl" denotes Cyrillic script
|
|
/// "sr-Cyrl" denotes Cyrillic script as used for writing the Serbian language;
|
|
/// a font that has this property value may not be suitable for displaying
|
|
/// text in Russian or other languages written using Cyrillic script
|
|
/// "Jpan" denotes Japanese writing (Han + Hiragana + Katakana)
|
|
///
|
|
/// When passing this property to GetPropertyValues, use the overload which does
|
|
/// not take a language parameter, since this property has no specific language.
|
|
/// </remarks>
|
|
DWRITE_FONT_PROPERTY_ID_DESIGN_SCRIPT_LANGUAGE_TAG,
|
|
|
|
/// <summary>
|
|
/// Script/language tag to identify the scripts or languages that the font declares
|
|
/// it is able to support.
|
|
/// </summary>
|
|
DWRITE_FONT_PROPERTY_ID_SUPPORTED_SCRIPT_LANGUAGE_TAG,
|
|
|
|
/// <summary>
|
|
/// Semantic tag to describe the font (e.g. Fancy, Decorative, Handmade, Sans-serif, Swiss, Pixel, Futuristic).
|
|
/// </summary>
|
|
DWRITE_FONT_PROPERTY_ID_SEMANTIC_TAG,
|
|
|
|
/// <summary>
|
|
/// Weight of the font represented as a decimal string in the range 1-999.
|
|
/// </summary>
|
|
DWRITE_FONT_PROPERTY_ID_WEIGHT,
|
|
|
|
/// <summary>
|
|
/// Stretch of the font represented as a decimal string in the range 1-9.
|
|
/// </summary>
|
|
DWRITE_FONT_PROPERTY_ID_STRETCH,
|
|
|
|
/// <summary>
|
|
/// Stretch of the font represented as a decimal string in the range 0-2.
|
|
/// </summary>
|
|
DWRITE_FONT_PROPERTY_ID_STYLE,
|
|
|
|
/// <summary>
|
|
/// Total number of properties.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// DWRITE_FONT_PROPERTY_ID_TOTAL cannot be used as a property ID.
|
|
/// </remarks>
|
|
DWRITE_FONT_PROPERTY_ID_TOTAL,
|
|
};
|
|
|
|
|
|
/// <summary>
|
|
/// Font property used for filtering font sets and
|
|
/// building a font set with explicit properties.
|
|
/// </summary>
|
|
struct DWRITE_FONT_PROPERTY
|
|
{
|
|
/// <summary>
|
|
/// Specifies the requested font property, such as DWRITE_FONT_PROPERTY_ID_FAMILY_NAME.
|
|
/// </summary>
|
|
DWRITE_FONT_PROPERTY_ID propertyId;
|
|
|
|
/// <summary>
|
|
/// Specifies the property value, such as "Segoe UI".
|
|
/// </summary>
|
|
_Field_z_ WCHAR const* propertyValue;
|
|
|
|
/// <summary>
|
|
/// Specifies the language / locale to use, such as "en-US".
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// When passing property information to AddFontFaceReference, localeName indicates
|
|
/// the language of the property value. BCP 47 language tags should be used. If a
|
|
/// property value is inherently non-linguistic, this can be left empty.
|
|
///
|
|
/// When used for font set filtering, leave this empty: a match will be found
|
|
/// regardless of language associated with property values.
|
|
/// </remarks>
|
|
_Field_z_ _Maybenull_ WCHAR const* localeName;
|
|
};
|
|
|
|
|
|
/// <summary>
|
|
/// Specifies the locality of a resource.
|
|
/// </summary>
|
|
enum DWRITE_LOCALITY
|
|
{
|
|
/// <summary>
|
|
/// The resource is remote, and information is unknown yet, including the file size and date.
|
|
/// Attempting to create a font or file stream will fail until locality becomes at least partial.
|
|
/// </summary>
|
|
DWRITE_LOCALITY_REMOTE,
|
|
|
|
/// <summary>
|
|
/// The resource is partially local, meaning you can query the size and date of the file
|
|
/// stream, and you may be able to create a font face and retrieve the particular glyphs
|
|
/// for metrics and drawing, but not all the glyphs will be present.
|
|
/// </summary>
|
|
DWRITE_LOCALITY_PARTIAL,
|
|
|
|
/// <summary>
|
|
/// The resource is completely local, and all font functions can be called
|
|
/// without concern of missing data or errors related to network connectivity.
|
|
/// </summary>
|
|
DWRITE_LOCALITY_LOCAL,
|
|
};
|
|
|
|
|
|
/// <summary>
|
|
/// Represents a method of rendering glyphs.
|
|
/// </summary>
|
|
enum DWRITE_RENDERING_MODE1
|
|
{
|
|
/// <summary>
|
|
/// Specifies that the rendering mode is determined automatically based on the font and size.
|
|
/// </summary>
|
|
DWRITE_RENDERING_MODE1_DEFAULT = DWRITE_RENDERING_MODE_DEFAULT,
|
|
|
|
/// <summary>
|
|
/// Specifies that no antialiasing is performed. Each pixel is either set to the foreground
|
|
/// color of the text or retains the color of the background.
|
|
/// </summary>
|
|
DWRITE_RENDERING_MODE1_ALIASED = DWRITE_RENDERING_MODE_ALIASED,
|
|
|
|
/// <summary>
|
|
/// Specifies that antialiasing is performed in the horizontal direction and the appearance
|
|
/// of glyphs is layout-compatible with GDI using CLEARTYPE_QUALITY. Use DWRITE_MEASURING_MODE_GDI_CLASSIC
|
|
/// to get glyph advances. The antialiasing may be either ClearType or grayscale depending on
|
|
/// the text antialiasing mode.
|
|
/// </summary>
|
|
DWRITE_RENDERING_MODE1_GDI_CLASSIC = DWRITE_RENDERING_MODE_GDI_CLASSIC,
|
|
|
|
/// <summary>
|
|
/// Specifies that antialiasing is performed in the horizontal direction and the appearance
|
|
/// of glyphs is layout-compatible with GDI using CLEARTYPE_NATURAL_QUALITY. Glyph advances
|
|
/// are close to the font design advances, but are still rounded to whole pixels. Use
|
|
/// DWRITE_MEASURING_MODE_GDI_NATURAL to get glyph advances. The antialiasing may be either
|
|
/// ClearType or grayscale depending on the text antialiasing mode.
|
|
/// </summary>
|
|
DWRITE_RENDERING_MODE1_GDI_NATURAL = DWRITE_RENDERING_MODE_GDI_NATURAL,
|
|
|
|
/// <summary>
|
|
/// Specifies that antialiasing is performed in the horizontal direction. This rendering
|
|
/// mode allows glyphs to be positioned with subpixel precision and is therefore suitable
|
|
/// for natural (i.e., resolution-independent) layout. The antialiasing may be either
|
|
/// ClearType or grayscale depending on the text antialiasing mode.
|
|
/// </summary>
|
|
DWRITE_RENDERING_MODE1_NATURAL = DWRITE_RENDERING_MODE_NATURAL,
|
|
|
|
/// <summary>
|
|
/// Similar to natural mode except that antialiasing is performed in both the horizontal
|
|
/// and vertical directions. This is typically used at larger sizes to make curves and
|
|
/// diagonal lines look smoother. The antialiasing may be either ClearType or grayscale
|
|
/// depending on the text antialiasing mode.
|
|
/// </summary>
|
|
DWRITE_RENDERING_MODE1_NATURAL_SYMMETRIC = DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC,
|
|
|
|
/// <summary>
|
|
/// Specifies that rendering should bypass the rasterizer and use the outlines directly.
|
|
/// This is typically used at very large sizes.
|
|
/// </summary>
|
|
DWRITE_RENDERING_MODE1_OUTLINE = DWRITE_RENDERING_MODE_OUTLINE,
|
|
|
|
/// <summary>
|
|
/// Similar to natural symmetric mode except that when possible, text should be rasterized
|
|
/// in a downsampled form.
|
|
/// </summary>
|
|
DWRITE_RENDERING_MODE1_NATURAL_SYMMETRIC_DOWNSAMPLED,
|
|
};
|
|
|
|
|
|
/// <summary>
|
|
/// The interface that represents text rendering settings for glyph rasterization and filtering.
|
|
/// </summary>
|
|
interface DWRITE_DECLARE_INTERFACE("b7924baa-391b-412a-8c5c-e44cc2d867dc") IDWriteRenderingParams3 : public IDWriteRenderingParams2
|
|
{
|
|
/// <summary>
|
|
/// Gets the rendering mode.
|
|
/// </summary>
|
|
STDMETHOD_(DWRITE_RENDERING_MODE1, GetRenderingMode1)() PURE;
|
|
};
|
|
|
|
|
|
/// <summary>
|
|
/// The root factory interface for all DWrite objects.
|
|
/// </summary>
|
|
interface DWRITE_DECLARE_INTERFACE("9a1b41c3-d3bb-466a-87fc-fe67556a3b65") IDWriteFactory3 : public IDWriteFactory2
|
|
{
|
|
/// <summary>
|
|
/// Creates a glyph run analysis object, which encapsulates information
|
|
/// used to render a glyph run.
|
|
/// </summary>
|
|
/// <param name="glyphRun">Structure specifying the properties of the glyph run.</param>
|
|
/// <param name="transform">Optional transform applied to the glyphs and their positions. This transform is applied after the
|
|
/// scaling specified by the emSize.</param>
|
|
/// <param name="renderingMode">Specifies the rendering mode, which must be one of the raster rendering modes (i.e., not default
|
|
/// and not outline).</param>
|
|
/// <param name="measuringMode">Specifies the method to measure glyphs.</param>
|
|
/// <param name="gridFitMode">How to grid-fit glyph outlines. This must be non-default.</param>
|
|
/// <param name="baselineOriginX">Horizontal position of the baseline origin, in DIPs.</param>
|
|
/// <param name="baselineOriginY">Vertical position of the baseline origin, in DIPs.</param>
|
|
/// <param name="glyphRunAnalysis">Receives a pointer to the newly created object.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(CreateGlyphRunAnalysis)(
|
|
_In_ DWRITE_GLYPH_RUN const* glyphRun,
|
|
_In_opt_ DWRITE_MATRIX const* transform,
|
|
DWRITE_RENDERING_MODE1 renderingMode,
|
|
DWRITE_MEASURING_MODE measuringMode,
|
|
DWRITE_GRID_FIT_MODE gridFitMode,
|
|
DWRITE_TEXT_ANTIALIAS_MODE antialiasMode,
|
|
FLOAT baselineOriginX,
|
|
FLOAT baselineOriginY,
|
|
_COM_Outptr_ IDWriteGlyphRunAnalysis** glyphRunAnalysis
|
|
) PURE;
|
|
|
|
using IDWriteFactory::CreateGlyphRunAnalysis;
|
|
using IDWriteFactory2::CreateGlyphRunAnalysis;
|
|
|
|
/// <summary>
|
|
/// Creates a rendering parameters object with the specified properties.
|
|
/// </summary>
|
|
/// <param name="gamma">The gamma value used for gamma correction, which must be greater than zero and cannot exceed 256.</param>
|
|
/// <param name="enhancedContrast">The amount of contrast enhancement, zero or greater.</param>
|
|
/// <param name="grayscaleEnhancedContrast">The amount of contrast enhancement to use for grayscale antialiasing, zero or greater.</param>
|
|
/// <param name="clearTypeLevel">The degree of ClearType level, from 0.0f (no ClearType) to 1.0f (full ClearType).</param>
|
|
/// <param name="pixelGeometry">The geometry of a device pixel.</param>
|
|
/// <param name="renderingMode">Method of rendering glyphs. In most cases, this should be DWRITE_RENDERING_MODE_DEFAULT to automatically use an appropriate mode.</param>
|
|
/// <param name="gridFitMode">How to grid fit glyph outlines. In most cases, this should be DWRITE_GRID_FIT_DEFAULT to automatically choose an appropriate mode.</param>
|
|
/// <param name="renderingParams">Holds the newly created rendering parameters object, or NULL in case of failure.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(CreateCustomRenderingParams)(
|
|
FLOAT gamma,
|
|
FLOAT enhancedContrast,
|
|
FLOAT grayscaleEnhancedContrast,
|
|
FLOAT clearTypeLevel,
|
|
DWRITE_PIXEL_GEOMETRY pixelGeometry,
|
|
DWRITE_RENDERING_MODE1 renderingMode,
|
|
DWRITE_GRID_FIT_MODE gridFitMode,
|
|
_COM_Outptr_ IDWriteRenderingParams3** renderingParams
|
|
) PURE;
|
|
|
|
using IDWriteFactory::CreateCustomRenderingParams;
|
|
using IDWriteFactory1::CreateCustomRenderingParams;
|
|
using IDWriteFactory2::CreateCustomRenderingParams;
|
|
|
|
/// <summary>
|
|
/// Creates a reference to a font given a full path.
|
|
/// </summary>
|
|
/// <param name="filePath">Absolute file path. Subsequent operations on the constructed object may fail
|
|
/// if the user provided filePath doesn't correspond to a valid file on the disk.</param>
|
|
/// <param name="lastWriteTime">Last modified time of the input file path. If the parameter is omitted,
|
|
/// the function will access the font file to obtain its last write time, so the clients are encouraged to specify this value
|
|
/// to avoid extra disk access. Subsequent operations on the constructed object may fail
|
|
/// if the user provided lastWriteTime doesn't match the file on the disk.</param>
|
|
/// <param name="faceIndex">The zero based index of a font face in cases when the font files contain a collection of font faces.
|
|
/// If the font files contain a single face, this value should be zero.</param>
|
|
/// <param name="fontFaceSimulationFlags">Font face simulation flags for algorithmic emboldening and italicization.</param>
|
|
/// <param name="fontFaceReference">Contains newly created font face reference object, or nullptr in case of failure.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(CreateFontFaceReference)(
|
|
_In_z_ WCHAR const* filePath,
|
|
_In_opt_ FILETIME const* lastWriteTime,
|
|
UINT32 faceIndex,
|
|
DWRITE_FONT_SIMULATIONS fontSimulations,
|
|
_COM_Outptr_ IDWriteFontFaceReference** fontFaceReference
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Creates a reference to a font given a file.
|
|
/// </summary>
|
|
/// <param name="fontFiles">User provided font file representing the font face.</param>
|
|
/// <param name="faceIndex">The zero based index of a font face in cases when the font files contain a collection of font faces.
|
|
/// If the font files contain a single face, this value should be zero.</param>
|
|
/// <param name="fontFaceSimulationFlags">Font face simulation flags for algorithmic emboldening and italicization.</param>
|
|
/// <param name="fontFaceReference">Contains newly created font face reference object, or nullptr in case of failure.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(CreateFontFaceReference)(
|
|
_In_ IDWriteFontFile* fontFile,
|
|
UINT32 faceIndex,
|
|
DWRITE_FONT_SIMULATIONS fontSimulations,
|
|
_COM_Outptr_ IDWriteFontFaceReference** fontFaceReference
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Retrieves the list of system fonts.
|
|
/// </summary>
|
|
/// <param name="fontSet">Holds the newly created font set object, or NULL in case of failure.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(GetSystemFontSet)(
|
|
_COM_Outptr_ IDWriteFontSet** fontSet
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Creates an empty font set builder to add font face references
|
|
/// and create a custom font set.
|
|
/// </summary>
|
|
/// <param name="fontSetBuilder">Holds the newly created font set builder object, or NULL in case of failure.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(CreateFontSetBuilder)(
|
|
_COM_Outptr_ IDWriteFontSetBuilder** fontSetBuilder
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Create a weight/width/slope tree from a set of fonts.
|
|
/// </summary>
|
|
/// <param name="fontSet">A set of fonts to use to build the collection.</param>
|
|
/// <param name="fontCollection">Holds the newly created font collection object, or NULL in case of failure.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(CreateFontCollectionFromFontSet)(
|
|
IDWriteFontSet* fontSet,
|
|
_COM_Outptr_ IDWriteFontCollection1** fontCollection
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Retrieves a weight/width/slope tree of system fonts.
|
|
/// </summary>
|
|
/// <param name="includeDownloadableFonts">Include cloud fonts or only locally installed ones.</param>
|
|
/// <param name="fontCollection">Holds the newly created font collection object, or NULL in
|
|
/// case of failure.</param>
|
|
/// <param name="checkForUpdates">If this parameter is nonzero, the function performs an immediate check for changes
|
|
/// to the set of system fonts. If this parameter is FALSE, the function will still detect changes if the font
|
|
/// cache service is running, but there may be some latency. For example, an application might specify TRUE if
|
|
/// it has itself just installed a font and wants to be sure the font collection contains that font.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(GetSystemFontCollection)(
|
|
BOOL includeDownloadableFonts,
|
|
_COM_Outptr_ IDWriteFontCollection1** fontCollection,
|
|
BOOL checkForUpdates = FALSE
|
|
) PURE;
|
|
|
|
using IDWriteFactory2::GetSystemFontCollection;
|
|
|
|
/// <summary>
|
|
/// Gets the font download queue associated with this factory object.
|
|
/// </summary>
|
|
/// <param name="IDWriteFontDownloadQueue">Receives a pointer to the font download queue interface.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(GetFontDownloadQueue)(
|
|
_COM_Outptr_ IDWriteFontDownloadQueue** fontDownloadQueue
|
|
) PURE;
|
|
};
|
|
|
|
|
|
interface DWRITE_DECLARE_INTERFACE("53585141-D9F8-4095-8321-D73CF6BD116B") IDWriteFontSet : public IUnknown
|
|
{
|
|
/// <summary>
|
|
/// Get the number of total fonts in the set.
|
|
/// </summary>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD_(UINT32, GetFontCount)() PURE;
|
|
|
|
/// <summary>
|
|
/// Get a reference to the font at this index, which may be local or remote.
|
|
/// </summary>
|
|
/// <param name="listIndex">Zero-based index of the font.</param>
|
|
/// <param name="fontFaceReference">Receives a pointer the font face reference object, or nullptr on failure.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(GetFontFaceReference)(
|
|
UINT32 listIndex,
|
|
_COM_Outptr_ IDWriteFontFaceReference** fontFaceReference
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Gets the index of the matching font face reference in the font set, with the same file, face index, and simulations.
|
|
/// </summary>
|
|
/// <param name="fontFaceReference">Font face reference object that specifies the physical font.</param>
|
|
/// <param name="listIndex">Receives the zero-based index of the matching font if the font was found, or UINT_MAX otherwise.</param>
|
|
/// <param name="exists">Receives TRUE if the font exists or FALSE otherwise.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(FindFontFaceReference)(
|
|
IDWriteFontFaceReference* fontFaceReference,
|
|
_Out_ UINT32* listIndex,
|
|
_Out_ BOOL* exists
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Gets the index of the matching font face reference in the font set, with the same file, face index, and simulations.
|
|
/// </summary>
|
|
/// <param name="fontFaceReference">Font face object that specifies the physical font.</param>
|
|
/// <param name="listIndex">Receives the zero-based index of the matching font if the font was found, or UINT_MAX otherwise.</param>
|
|
/// <param name="exists">Receives TRUE if the font exists or FALSE otherwise.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(FindFontFace)(
|
|
IDWriteFontFace* fontFace,
|
|
_Out_ UINT32* listIndex,
|
|
_Out_ BOOL* exists
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Returns the property values of a specific font item index.
|
|
/// </summary>
|
|
/// <param name="listIndex">Zero-based index of the font.</param>
|
|
/// <param name="propertyID">Font property of interest.</param>
|
|
/// <param name="exists">Receives the value TRUE if the font contains the specified property identifier or FALSE if not.</param>
|
|
/// <param name="strings">Receives a pointer to the newly created localized strings object, or nullptr on failure or non-existent property.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(GetPropertyValues)(
|
|
UINT32 listIndex,
|
|
DWRITE_FONT_PROPERTY_ID propertyId,
|
|
_Out_ BOOL* exists,
|
|
_COM_Outptr_result_maybenull_ IDWriteLocalizedStrings** values
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Returns all unique property values in the set, which can be used
|
|
/// for purposes such as displaying a family list or tag cloud. Values are
|
|
/// returned in priority order according to the language list, such that if
|
|
/// a font contains more than one localized name, the preferred one will be
|
|
/// returned.
|
|
/// </summary>
|
|
/// <param name="propertyID">Font property of interest.</param>
|
|
/// <param name="preferredLocaleNames">List of semicolon delimited language names in preferred
|
|
/// order. When a particular string like font family has more than one localized name,
|
|
/// the first match is returned.</param>
|
|
/// <param name="stringsList">Receives a pointer to the newly created strings list.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
/// <remarks>
|
|
/// For example, suppose the font set includes the Meiryo family, which has both Japanese and English family names.
|
|
/// The returned list of distinct family names would include either the Japanese name (if "ja-jp" was specified as
|
|
/// a preferred locale) or the English name (in all other cases).
|
|
/// </remarks>
|
|
STDMETHOD(GetPropertyValues)(
|
|
DWRITE_FONT_PROPERTY_ID propertyID,
|
|
_In_z_ WCHAR const* preferredLocaleNames,
|
|
_COM_Outptr_ IDWriteStringList** values
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Returns all unique property values in the set, which can be used
|
|
/// for purposes such as displaying a family list or tag cloud. All values
|
|
/// are returned regardless of language, including all localized names.
|
|
/// </summary>
|
|
/// <param name="propertyID">Font property of interest.</param>
|
|
/// <param name="stringsList">Receives a pointer to the newly created strings list.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
/// <remarks>
|
|
/// For example, suppose the font set includes the Meiryo family, which has both Japanese and English family names.
|
|
/// The returned list of distinct family names would include both the Japanese and English names.
|
|
/// </remarks>
|
|
STDMETHOD(GetPropertyValues)(
|
|
DWRITE_FONT_PROPERTY_ID propertyID,
|
|
_COM_Outptr_ IDWriteStringList** values
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Returns how many times a given property value occurs in the set.
|
|
/// </summary>
|
|
/// <param name="property">Font property of interest.</param>
|
|
/// <param name="propertyOccurrenceCount">How many times that property occurs.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
/// <remarks>
|
|
/// For example, the family name "Segoe UI" may return a count of 12,
|
|
/// whereas Harrington only has 1.
|
|
/// </remarks>
|
|
STDMETHOD(GetPropertyOccurrenceCount)(
|
|
_In_ DWRITE_FONT_PROPERTY const* property,
|
|
_Out_ UINT32* propertyOccurrenceCount
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Returns a subset of fonts filtered by the given properties.
|
|
/// </summary>
|
|
/// <param name="properties">List of properties to filter using.</param>
|
|
/// <param name="propertyCount">How many properties to filter.</param>
|
|
/// <param name="filteredSet">Subset of fonts that match the properties,
|
|
/// or nullptr on failure.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
/// <remarks>
|
|
/// If no fonts matched the filter, the subset will be empty (GetFontCount
|
|
/// returns 0), but the function does not return an error. The subset will
|
|
/// always be equal to or less than the original set.
|
|
/// </remarks>
|
|
STDMETHOD(GetMatchingFonts)(
|
|
_In_reads_(propertyCount) DWRITE_FONT_PROPERTY const* properties,
|
|
UINT32 propertyCount,
|
|
_COM_Outptr_ IDWriteFontSet** filteredSet
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Returns a list of fonts within the given WWS family prioritized by
|
|
/// WWS distance.
|
|
/// </summary>
|
|
/// <param name="familyName">Neutral or localized family name of font.</param>
|
|
/// <param name="fontWeight">Weight of font.</param>
|
|
/// <param name="fontStretch">Stretch of font.</param>
|
|
/// <param name="fontStyle">Slope of font.</param>
|
|
/// <param name="filteredSet">Subset of fonts that match the properties,
|
|
/// or nullptr on failure.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
/// <remarks>
|
|
/// The returned list can include simulated bold and oblique variants,
|
|
/// which would be useful for font fallback selection.
|
|
/// </remarks>
|
|
STDMETHOD(GetMatchingFonts)(
|
|
_In_z_ WCHAR const* familyName,
|
|
DWRITE_FONT_WEIGHT fontWeight,
|
|
DWRITE_FONT_STRETCH fontStretch,
|
|
DWRITE_FONT_STYLE fontStyle,
|
|
_COM_Outptr_ IDWriteFontSet** filteredSet
|
|
) PURE;
|
|
};
|
|
|
|
|
|
interface DWRITE_DECLARE_INTERFACE("2F642AFE-9C68-4F40-B8BE-457401AFCB3D") IDWriteFontSetBuilder : public IUnknown
|
|
{
|
|
/// <summary>
|
|
/// Adds a reference to a font to the set being built. The necessary
|
|
/// metadata will automatically be extracted from the font upon calling
|
|
/// CreateFontSet.
|
|
/// </summary>
|
|
/// <param name="fontFaceReference">Font face reference object to add to the set.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(AddFontFaceReference)(
|
|
_In_ IDWriteFontFaceReference* fontFaceReference
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Adds a reference to a font to the set being built. The caller
|
|
/// supplies enough information to search on, avoiding the need to open
|
|
/// the potentially non-local font. Any properties not supplied by the
|
|
/// caller will be missing, and those properties will not be available as
|
|
/// filters in GetMatchingFonts. GetPropertyValues for missing properties
|
|
/// will return an empty string list. The properties passed should generally
|
|
/// be consistent with the actual font contents, but they need not be. You
|
|
/// could, for example, alias a font using a different name or unique
|
|
/// identifier, or you could set custom tags not present in the actual
|
|
/// font.
|
|
/// </summary>
|
|
/// <param name="fontFaceReference">Reference to the font.</param>
|
|
/// <param name="properties">List of properties to associate with the reference.</param>
|
|
/// <param name="propertyCount">How many properties are defined.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(AddFontFaceReference)(
|
|
_In_ IDWriteFontFaceReference* fontFaceReference,
|
|
_In_reads_(propertyCount) DWRITE_FONT_PROPERTY const* properties,
|
|
UINT32 propertyCount
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Appends an existing font set to the one being built, allowing
|
|
/// one to aggregate two sets or to essentially extend an existing one.
|
|
/// </summary>
|
|
/// <param name="fontSet">Font set to append font face references from.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(AddFontSet)(
|
|
_In_ IDWriteFontSet* fontSet
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Creates a font set from all the font face references added so
|
|
/// far via AddFontFaceReference.
|
|
/// </summary>
|
|
/// <param name="fontSet">Contains newly created font set object,
|
|
/// or nullptr in case of failure.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
/// <remarks>
|
|
/// Creating a font set takes less time if the references were added
|
|
/// with metadata rather than needing to extract the metadata from the
|
|
/// font file.
|
|
/// </remarks>
|
|
STDMETHOD(CreateFontSet)(
|
|
_COM_Outptr_ IDWriteFontSet** fontSet
|
|
) PURE;
|
|
};
|
|
|
|
|
|
interface DWRITE_DECLARE_INTERFACE("53585141-D9F8-4095-8321-D73CF6BD116C") IDWriteFontCollection1 : public IDWriteFontCollection
|
|
{
|
|
/// <summary>
|
|
/// Get the underlying font set used by this collection.
|
|
/// </summary>
|
|
/// <param name="fontSet">Contains font set used by the collection.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(GetFontSet)(
|
|
_COM_Outptr_ IDWriteFontSet** fontSet
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Creates a font family object given a zero-based font family index.
|
|
/// </summary>
|
|
/// <param name="index">Zero-based index of the font family.</param>
|
|
/// <param name="fontFamily">Receives a pointer the newly created font family object.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(GetFontFamily)(
|
|
UINT32 index,
|
|
_COM_Outptr_ IDWriteFontFamily1** fontFamily
|
|
) PURE;
|
|
|
|
using IDWriteFontCollection::GetFontFamily;
|
|
};
|
|
|
|
|
|
/// <summary>
|
|
/// The IDWriteFontFamily interface represents a set of fonts that share the same design but are differentiated
|
|
/// by weight, stretch, and style.
|
|
/// </summary>
|
|
interface DWRITE_DECLARE_INTERFACE("DA20D8EF-812A-4C43-9802-62EC4ABD7ADF") IDWriteFontFamily1 : public IDWriteFontFamily
|
|
{
|
|
/// <summary>
|
|
/// Gets the current locality of a font given its zero-based index.
|
|
/// </summary>
|
|
/// <param name="listIndex">Zero-based index of the font in the font list.</param>
|
|
/// <remarks>
|
|
/// The locality enumeration. For fully local files, the result will always
|
|
/// be DWRITE_LOCALITY_LOCAL. For downloadable files, the result depends on how
|
|
/// much of the file has been downloaded, and GetFont() fails if the locality
|
|
/// is REMOTE and potentially fails if PARTIAL. The application can explicitly
|
|
/// ask for the font to be enqueued for download via EnqueueFontDownloadRequest
|
|
/// followed by BeginDownload().
|
|
/// </remarks>
|
|
/// <returns>
|
|
/// The locality enumeration.
|
|
/// </returns>
|
|
STDMETHOD_(DWRITE_LOCALITY, GetFontLocality)(UINT32 listIndex) PURE;
|
|
|
|
/// <summary>
|
|
/// Gets a font given its zero-based index.
|
|
/// </summary>
|
|
/// <param name="listIndex">Zero-based index of the font in the font list.</param>
|
|
/// <param name="font">Receives a pointer to the newly created font object.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(GetFont)(
|
|
UINT32 listIndex,
|
|
_COM_Outptr_ IDWriteFont3** font
|
|
) PURE;
|
|
|
|
using IDWriteFontFamily::GetFont;
|
|
|
|
/// <summary>
|
|
/// Gets a font face reference given its zero-based index.
|
|
/// </summary>
|
|
/// <param name="listIndex">Zero-based index of the font in the font list.</param>
|
|
/// <param name="fontFaceReference">Receives a pointer to the newly created font face reference object.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(GetFontFaceReference)(
|
|
UINT32 listIndex,
|
|
_COM_Outptr_ IDWriteFontFaceReference** fontFaceReference
|
|
) PURE;
|
|
};
|
|
|
|
|
|
/// <summary>
|
|
/// The IDWriteFontList interface represents a list of fonts.
|
|
/// </summary>
|
|
interface DWRITE_DECLARE_INTERFACE("DA20D8EF-812A-4C43-9802-62EC4ABD7ADE") IDWriteFontList1 : public IDWriteFontList
|
|
{
|
|
/// <summary>
|
|
/// Gets the current locality of a font given its zero-based index.
|
|
/// </summary>
|
|
/// <param name="listIndex">Zero-based index of the font in the font list.</param>
|
|
/// <remarks>
|
|
/// The locality enumeration. For fully local files, the result will always
|
|
/// be DWRITE_LOCALITY_LOCAL. For downloadable files, the result depends on how
|
|
/// much of the file has been downloaded, and GetFont() fails if the locality
|
|
/// is REMOTE and potentially fails if PARTIAL. The application can explicitly
|
|
/// ask for the font to be enqueued for download via EnqueueFontDownloadRequest
|
|
/// followed by BeginDownload().
|
|
/// </remarks>
|
|
/// <returns>
|
|
/// The locality enumeration.
|
|
/// </returns>
|
|
STDMETHOD_(DWRITE_LOCALITY, GetFontLocality)(UINT32 listIndex) PURE;
|
|
|
|
/// <summary>
|
|
/// Gets a font given its zero-based index.
|
|
/// </summary>
|
|
/// <param name="listIndex">Zero-based index of the font in the font list.</param>
|
|
/// <param name="font">Receives a pointer to the newly created font object.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code. The function returns DWRITE_E_REMOTEFONT if it could not construct a remote font.
|
|
/// </returns>
|
|
STDMETHOD(GetFont)(
|
|
UINT32 listIndex,
|
|
_COM_Outptr_ IDWriteFont3** font
|
|
) PURE;
|
|
|
|
using IDWriteFontList::GetFont;
|
|
|
|
/// <summary>
|
|
/// Gets a font face reference given its zero-based index.
|
|
/// </summary>
|
|
/// <param name="listIndex">Zero-based index of the font in the font list.</param>
|
|
/// <param name="fontFaceReference">Receives a pointer to the newly created font face reference object.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(GetFontFaceReference)(
|
|
UINT32 listIndex,
|
|
_COM_Outptr_ IDWriteFontFaceReference** fontFaceReference
|
|
) PURE;
|
|
};
|
|
|
|
|
|
/// <summary>
|
|
/// A uniquely identifying reference to a font, from which you can create a font
|
|
/// face to query font metrics and use for rendering. A font face reference
|
|
/// consists of a font file, font face index, and font face simulation. The file
|
|
/// data may or may not be physically present on the local machine yet.
|
|
/// </summary>
|
|
interface DWRITE_DECLARE_INTERFACE("5E7FA7CA-DDE3-424C-89F0-9FCD6FED58CD") IDWriteFontFaceReference : public IUnknown
|
|
{
|
|
/// <summary>
|
|
/// Creates a font face from the reference for use with layout,
|
|
/// shaping, or rendering.
|
|
/// </summary>
|
|
/// <param name="fontFace">Newly created font face object, or nullptr in the case of failure.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
/// <remarks>
|
|
/// This function can fail with DWRITE_E_REMOTEFONT if the font is not local.
|
|
/// </remarks>
|
|
STDMETHOD(CreateFontFace)(
|
|
_COM_Outptr_ IDWriteFontFace3** fontFace
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Creates a font face with alternate font simulations, for example, to
|
|
/// explicitly simulate a bold font face out of a regular variant.
|
|
/// </summary>
|
|
/// <param name="fontFaceSimulationFlags">Font face simulation flags for algorithmic emboldening and italicization.</param>
|
|
/// <param name="fontFace">Newly created font face object, or nullptr in the case of failure.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
/// <remarks>
|
|
/// This function can fail with DWRITE_E_REMOTEFONT if the font is not local.
|
|
/// </remarks>
|
|
STDMETHOD(CreateFontFaceWithSimulations)(
|
|
DWRITE_FONT_SIMULATIONS fontFaceSimulationFlags,
|
|
_COM_Outptr_ IDWriteFontFace3** fontFace
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Compares two instances of a font face references for equality.
|
|
/// </summary>
|
|
STDMETHOD_(BOOL, Equals)(IDWriteFontFaceReference* fontFaceReference) PURE;
|
|
|
|
/// <summary>
|
|
/// Obtains the zero-based index of the font face in its font file or files. If the font files contain a single face,
|
|
/// the return value is zero.
|
|
/// </summary>
|
|
STDMETHOD_(UINT32, GetFontFaceIndex)() PURE;
|
|
|
|
/// <summary>
|
|
/// Obtains the algorithmic style simulation flags of a font face.
|
|
/// </summary>
|
|
STDMETHOD_(DWRITE_FONT_SIMULATIONS, GetSimulations)() PURE;
|
|
|
|
/// <summary>
|
|
/// Obtains the font file representing a font face.
|
|
/// </summary>
|
|
STDMETHOD(GetFontFile)(
|
|
_COM_Outptr_ IDWriteFontFile** fontFile
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Get the local size of the font face in bytes.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// The value returned by GetLocalFileSize will always be less than or
|
|
/// equal to the value returned by GetFullSize. If the locality is remote,
|
|
/// the GetLocalFileSize value is zero. If the locality is local, this
|
|
/// value will equal the value returned by GetFileSize. If the locality is
|
|
/// partial, this value will equal the size of the portions of the font
|
|
/// data that have been downloaded, which will be greater than zero and
|
|
/// less than or equal to the GetFileSize value.
|
|
/// </remarks>
|
|
STDMETHOD_(UINT64, GetLocalFileSize)() PURE;
|
|
|
|
/// <summary>
|
|
/// Get the total size of the font face in bytes.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// If the locality is remote, this value is unknown and will be zero.
|
|
/// If the locality is partial or local, the value is the full size of
|
|
/// the font face.
|
|
/// </remarks>
|
|
STDMETHOD_(UINT64, GetFileSize)() PURE;
|
|
|
|
/// <summary>
|
|
/// Get the last modified date.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// The time may be zero if the font file loader does not expose file time.
|
|
/// </remarks>
|
|
STDMETHOD(GetFileTime)(_Out_ FILETIME* lastWriteTime) PURE;
|
|
|
|
/// <summary>
|
|
/// Get the locality of this font face reference. You can always successfully
|
|
/// create a font face from a fully local font. Attempting to create a font
|
|
/// face on a remote or partially local font may fail with DWRITE_E_REMOTEFONT.
|
|
/// This function may change between calls depending on background downloads
|
|
/// and whether cached data expires.
|
|
/// </summary>
|
|
STDMETHOD_(DWRITE_LOCALITY, GetLocality)() PURE;
|
|
|
|
/// <summary>
|
|
/// Adds a request to the font download queue (IDWriteFontDownloadQueue).
|
|
/// </summary>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(EnqueueFontDownloadRequest)() PURE;
|
|
|
|
/// <summary>
|
|
/// Adds a request to the font download queue (IDWriteFontDownloadQueue).
|
|
/// </summary>
|
|
/// <param name="characters">Array of characters to download.</param>
|
|
/// <param name="characterCount">The number of elements in the character array.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
/// <remarks>
|
|
/// Downloading a character involves downloading every glyph it depends on
|
|
/// directly or indirectly, via font tables (cmap, GSUB, COLR, glyf).
|
|
/// </remarks>
|
|
STDMETHOD(EnqueueCharacterDownloadRequest)(
|
|
_In_reads_(characterCount) WCHAR const* characters,
|
|
UINT32 characterCount
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Adds a request to the font download queue (IDWriteFontDownloadQueue).
|
|
/// </summary>
|
|
/// <param name="glyphIndices">Array of glyph indices to download.</param>
|
|
/// <param name="glyhphCount">The number of elements in the glyph index array.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
/// <remarks>
|
|
/// Downloading a glyph involves downloading any other glyphs it depends on
|
|
/// from the font tables (GSUB, COLR, glyf).
|
|
/// </remarks>
|
|
STDMETHOD(EnqueueGlyphDownloadRequest)(
|
|
_In_reads_(glyphCount) UINT16 const* glyphIndices,
|
|
UINT32 glyphCount
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Adds a request to the font download queue (IDWriteFontDownloadQueue).
|
|
/// </summary>
|
|
/// <param name="fileOffset">Offset of the fragment from the beginning of the font file.</param>
|
|
/// <param name="fragmentSize">Size of the fragment in bytes.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(EnqueueFileFragmentDownloadRequest)(
|
|
UINT64 fileOffset,
|
|
UINT64 fragmentSize
|
|
) PURE;
|
|
};
|
|
|
|
|
|
/// <summary>
|
|
/// The IDWriteFont interface represents a font in a font collection.
|
|
/// </summary>
|
|
interface DWRITE_DECLARE_INTERFACE("29748ED6-8C9C-4A6A-BE0B-D912E8538944") IDWriteFont3 : public IDWriteFont2
|
|
{
|
|
/// <summary>
|
|
/// Creates a font face object for the font.
|
|
/// </summary>
|
|
/// <param name="fontFace">Receives a pointer to the newly created font face object.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code. The function returns DWRITE_E_REMOTEFONT if it could not construct a remote font.
|
|
/// </returns>
|
|
STDMETHOD(CreateFontFace)(
|
|
_COM_Outptr_ IDWriteFontFace3** fontFace
|
|
) PURE;
|
|
|
|
using IDWriteFont::CreateFontFace;
|
|
|
|
/// <summary>
|
|
/// Compares two instances of a font references for equality.
|
|
/// </summary>
|
|
STDMETHOD_(BOOL, Equals)(IDWriteFont* font) PURE;
|
|
|
|
/// <summary>
|
|
/// Return a font face reference identifying this font.
|
|
/// </summary>
|
|
/// <param name="fontFaceReference">A uniquely identifying reference to a font face.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(GetFontFaceReference)(
|
|
_COM_Outptr_ IDWriteFontFaceReference** fontFaceReference
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Determines whether the font supports the specified character.
|
|
/// </summary>
|
|
/// <param name="unicodeValue">Unicode (UCS-4) character value.</param>
|
|
/// <returns>
|
|
/// Returns TRUE if the font has the specified character, FALSE if not.
|
|
/// </returns>
|
|
STDMETHOD_(BOOL, HasCharacter)(
|
|
UINT32 unicodeValue
|
|
) PURE;
|
|
|
|
using IDWriteFont::HasCharacter;
|
|
|
|
/// <summary>
|
|
/// Gets the current locality of the font.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// The locality enumeration. For fully local files, the result will always
|
|
/// be DWRITE_LOCALITY_LOCAL. A downloadable file may be any of the states,
|
|
/// and this function may change between calls.
|
|
/// </remarks>
|
|
/// <returns>
|
|
/// The locality enumeration.
|
|
/// </returns>
|
|
STDMETHOD_(DWRITE_LOCALITY, GetLocality)() PURE;
|
|
};
|
|
|
|
|
|
/// <summary>
|
|
/// The interface that represents an absolute reference to a font face.
|
|
/// It contains font face type, appropriate file references and face identification data.
|
|
/// Various font data such as metrics, names and glyph outlines is obtained from IDWriteFontFace.
|
|
/// </summary>
|
|
interface DWRITE_DECLARE_INTERFACE("D37D7598-09BE-4222-A236-2081341CC1F2") IDWriteFontFace3 : public IDWriteFontFace2
|
|
{
|
|
/// <summary>
|
|
/// Return a font face reference identifying this font.
|
|
/// </summary>
|
|
/// <param name="fontFaceReference">A uniquely identifying reference to a font face.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(GetFontFaceReference)(
|
|
_COM_Outptr_ IDWriteFontFaceReference** fontFaceReference
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Gets the PANOSE values from the font, used for font selection and
|
|
/// matching.
|
|
/// </summary>
|
|
/// <param name="panose">PANOSE structure to fill in.</param>
|
|
/// <remarks>
|
|
/// The function does not simulate these, such as substituting a weight or
|
|
/// proportion inferred on other values. If the font does not specify them,
|
|
/// they are all set to 'any' (0).
|
|
/// </remarks>
|
|
STDMETHOD_(void, GetPanose)(
|
|
_Out_ DWRITE_PANOSE* panose
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Gets the weight of the specified font.
|
|
/// </summary>
|
|
STDMETHOD_(DWRITE_FONT_WEIGHT, GetWeight)() PURE;
|
|
|
|
/// <summary>
|
|
/// Gets the stretch (aka. width) of the specified font.
|
|
/// </summary>
|
|
STDMETHOD_(DWRITE_FONT_STRETCH, GetStretch)() PURE;
|
|
|
|
/// <summary>
|
|
/// Gets the style (aka. slope) of the specified font.
|
|
/// </summary>
|
|
STDMETHOD_(DWRITE_FONT_STYLE, GetStyle)() PURE;
|
|
|
|
/// <summary>
|
|
/// Creates an localized strings object that contains the family names for the font family, indexed by locale name.
|
|
/// </summary>
|
|
/// <param name="names">Receives a pointer to the newly created localized strings object.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(GetFamilyNames)(
|
|
_COM_Outptr_ IDWriteLocalizedStrings** names
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Gets a localized strings collection containing the face names for the font (e.g., Regular or Bold), indexed by locale name.
|
|
/// </summary>
|
|
/// <param name="names">Receives a pointer to the newly created localized strings object.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(GetFaceNames)(
|
|
_COM_Outptr_ IDWriteLocalizedStrings** names
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Gets a localized strings collection containing the specified informational strings, indexed by locale name.
|
|
/// </summary>
|
|
/// <param name="informationalStringID">Identifies the string to get.</param>
|
|
/// <param name="informationalStrings">Receives a pointer to the newly created localized strings object.</param>
|
|
/// <param name="exists">Receives the value TRUE if the font contains the specified string ID or FALSE if not.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code. If the font does not contain the specified string, the return value is S_OK but
|
|
/// informationalStrings receives a NULL pointer and exists receives the value FALSE.
|
|
/// </returns>
|
|
STDMETHOD(GetInformationalStrings)(
|
|
DWRITE_INFORMATIONAL_STRING_ID informationalStringID,
|
|
_COM_Outptr_result_maybenull_ IDWriteLocalizedStrings** informationalStrings,
|
|
_Out_ BOOL* exists
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Determines whether the font supports the specified character.
|
|
/// </summary>
|
|
/// <param name="unicodeValue">Unicode (UCS-4) character value.</param>
|
|
/// <returns>
|
|
/// Returns TRUE if the font has the specified character, FALSE if not.
|
|
/// </returns>
|
|
STDMETHOD_(BOOL, HasCharacter)(
|
|
UINT32 unicodeValue
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Determines the recommended text rendering and grid-fit mode to be used based on the
|
|
/// font, size, world transform, and measuring mode.
|
|
/// </summary>
|
|
/// <param name="fontEmSize">Logical font size in DIPs.</param>
|
|
/// <param name="dpiX">Number of pixels per logical inch in the horizontal direction.</param>
|
|
/// <param name="dpiY">Number of pixels per logical inch in the vertical direction.</param>
|
|
/// <param name="transform">Specifies the world transform.</param>
|
|
/// <param name="outlineThreshold">Specifies the quality of the graphics system's outline rendering,
|
|
/// affects the size threshold above which outline rendering is used.</param>
|
|
/// <param name="measuringMode">Specifies the method used to measure during text layout. For proper
|
|
/// glyph spacing, the function returns a rendering mode that is compatible with the specified
|
|
/// measuring mode.</param>
|
|
/// <param name="renderingParams">Rendering parameters object. This parameter is necessary in case the rendering parameters
|
|
/// object overrides the rendering mode.</param>
|
|
/// <param name="renderingMode">Receives the recommended rendering mode.</param>
|
|
/// <param name="gridFitMode">Receives the recommended grid-fit mode.</param>
|
|
/// <remarks>
|
|
/// This method should be used to determine the actual rendering mode in cases where the rendering
|
|
/// mode of the rendering params object is DWRITE_RENDERING_MODE_DEFAULT, and the actual grid-fit
|
|
/// mode when the rendering params object is DWRITE_GRID_FIT_MODE_DEFAULT.
|
|
/// </remarks>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(GetRecommendedRenderingMode)(
|
|
FLOAT fontEmSize,
|
|
FLOAT dpiX,
|
|
FLOAT dpiY,
|
|
_In_opt_ DWRITE_MATRIX const* transform,
|
|
BOOL isSideways,
|
|
DWRITE_OUTLINE_THRESHOLD outlineThreshold,
|
|
DWRITE_MEASURING_MODE measuringMode,
|
|
_In_opt_ IDWriteRenderingParams* renderingParams,
|
|
_Out_ DWRITE_RENDERING_MODE1* renderingMode,
|
|
_Out_ DWRITE_GRID_FIT_MODE* gridFitMode
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Determines whether the character is locally downloaded from the font.
|
|
/// </summary>
|
|
/// <param name="unicodeValue">Unicode (UCS-4) character value.</param>
|
|
/// <returns>
|
|
/// Returns TRUE if the font has the specified character locally available,
|
|
/// FALSE if not or if the font does not support that character.
|
|
/// </returns>
|
|
STDMETHOD_(BOOL, IsCharacterLocal)(
|
|
UINT32 unicodeValue
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Determines whether the glyph is locally downloaded from the font.
|
|
/// </summary>
|
|
/// <param name="glyphId">Glyph identifier.</param>
|
|
/// <returns>
|
|
/// Returns TRUE if the font has the specified glyph locally available.
|
|
/// </returns>
|
|
STDMETHOD_(BOOL, IsGlyphLocal)(
|
|
UINT16 glyphId
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Determines whether the specified characters are local.
|
|
/// </summary>
|
|
/// <param name="characters">Array of characters.</param>
|
|
/// <param name="characterCount">The number of elements in the character array.</param>
|
|
/// <param name="enqueueIfNotLocal">Specifies whether to enqueue a download request
|
|
/// if any of the specified characters are not local.</param>
|
|
/// <param name="isLocal">Receives TRUE if all of the specified characters are local,
|
|
/// FALSE if any of the specified characters are remote.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(AreCharactersLocal)(
|
|
_In_reads_(characterCount) WCHAR const* characters,
|
|
UINT32 characterCount,
|
|
BOOL enqueueIfNotLocal,
|
|
_Out_ BOOL* isLocal
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Determines whether the specified glyphs are local.
|
|
/// </summary>
|
|
/// <param name="glyphIndices">Array of glyph indices.</param>
|
|
/// <param name="glyphCount">The number of elements in the glyph index array.</param>
|
|
/// <param name="enqueueIfNotLocal">Specifies whether to enqueue a download request
|
|
/// if any of the specified glyphs are not local.</param>
|
|
/// <param name="isLocal">Receives TRUE if all of the specified glyphs are local,
|
|
/// FALSE if any of the specified glyphs are remote.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(AreGlyphsLocal)(
|
|
_In_reads_(glyphCount) UINT16 const* glyphIndices,
|
|
UINT32 glyphCount,
|
|
BOOL enqueueIfNotLocal,
|
|
_Out_ BOOL* isLocal
|
|
) PURE;
|
|
};
|
|
|
|
|
|
/// <summary>
|
|
/// Represents a collection of strings indexed by number.
|
|
/// An IDWriteStringList is otherwise identical to IDWriteLocalizedStrings except
|
|
/// for the semantics, where localized strings are indexed on language (each
|
|
/// language has one string property) whereas a string list may contain multiple
|
|
/// strings of the same language, such as a string list of family names from a
|
|
/// font set. You can QueryInterface from an IDWriteLocalizedStrings to an
|
|
/// IDWriteStringList.
|
|
/// </summary>
|
|
interface DWRITE_DECLARE_INTERFACE("CFEE3140-1157-47CA-8B85-31BFCF3F2D0E") IDWriteStringList : public IUnknown
|
|
{
|
|
/// <summary>
|
|
/// Gets the number of strings.
|
|
/// </summary>
|
|
STDMETHOD_(UINT32, GetCount)() PURE;
|
|
|
|
/// <summary>
|
|
/// Gets the length in characters (not including the null terminator) of the locale name with the specified index.
|
|
/// </summary>
|
|
/// <param name="listIndex">Zero-based index of the locale name.</param>
|
|
/// <param name="length">Receives the length in characters, not including the null terminator.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(GetLocaleNameLength)(
|
|
UINT32 listIndex,
|
|
_Out_ UINT32* length
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Copies the locale name with the specified index to the specified array.
|
|
/// </summary>
|
|
/// <param name="listIndex">Zero-based index of the locale name.</param>
|
|
/// <param name="localeName">Character array that receives the locale name.</param>
|
|
/// <param name="size">Size of the array in characters. The size must include space for the terminating
|
|
/// null character.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(GetLocaleName)(
|
|
UINT32 listIndex,
|
|
_Out_writes_z_(size) WCHAR* localeName,
|
|
UINT32 size
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Gets the length in characters (not including the null terminator) of the string with the specified index.
|
|
/// </summary>
|
|
/// <param name="listIndex">Zero-based index of the string.</param>
|
|
/// <param name="length">Receives the length in characters, not including the null terminator.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(GetStringLength)(
|
|
UINT32 listIndex,
|
|
_Out_ UINT32* length
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Copies the string with the specified index to the specified array.
|
|
/// </summary>
|
|
/// <param name="listIndex">Zero-based index of the string.</param>
|
|
/// <param name="stringBuffer">Character array that receives the string.</param>
|
|
/// <param name="size">Size of the array in characters. The size must include space for the terminating
|
|
/// null character.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(GetString)(
|
|
UINT32 listIndex,
|
|
_Out_writes_z_(stringBufferSize) WCHAR* stringBuffer,
|
|
UINT32 stringBufferSize
|
|
) PURE;
|
|
};
|
|
|
|
|
|
/// <summary>
|
|
/// Application-defined callback interface that receives notifications from the font
|
|
/// download queue (IDWriteFontDownloadQueue interface). Callbacks will occur on the
|
|
/// downloading thread, and objects must be prepared to handle calls on their methods
|
|
/// from other threads at any time.
|
|
/// </summary>
|
|
interface DWRITE_DECLARE_INTERFACE("B06FE5B9-43EC-4393-881B-DBE4DC72FDA7") IDWriteFontDownloadListener : public IUnknown
|
|
{
|
|
/// <summary>
|
|
/// The DownloadCompleted method is called back on an arbitrary thread when a
|
|
/// download operation ends.
|
|
/// </summary>
|
|
/// <param name="downloadQueue">Pointer to the download queue interface on which
|
|
/// the BeginDownload method was called.</param>
|
|
/// <param name="context">Optional context object that was passed to BeginDownload.
|
|
/// AddRef is called on the context object by BeginDownload and Release is called
|
|
/// after the DownloadCompleted method returns.</param>
|
|
/// <param name="downloadResult">Result of the download operation.</param>
|
|
STDMETHOD_(void, DownloadCompleted)(
|
|
_In_ IDWriteFontDownloadQueue* downloadQueue,
|
|
_In_opt_ IUnknown* context,
|
|
HRESULT downloadResult
|
|
) PURE;
|
|
};
|
|
|
|
|
|
/// <summary>
|
|
/// Interface that enqueues download requests for remote fonts, characters, glyphs, and font fragments.
|
|
/// Provides methods to asynchronously execute a download, cancel pending downloads, and be notified of
|
|
/// download completion. Callbacks to listeners will occur on the downloading thread, and objects must
|
|
/// be must be able to handle calls on their methods from other threads at any time.
|
|
/// </summary>
|
|
interface DWRITE_DECLARE_INTERFACE("B71E6052-5AEA-4FA3-832E-F60D431F7E91") IDWriteFontDownloadQueue : public IUnknown
|
|
{
|
|
/// <summary>
|
|
/// Registers a client-defined listener object that receives download notifications.
|
|
/// All registered listener's DownloadCompleted will be called after BeginDownload
|
|
/// completes.
|
|
/// </summary>
|
|
/// <param name="listener">Listener object to add.</param>
|
|
/// <param name="token">Receives a token value, which the caller must subsequently
|
|
/// pass to RemoveListener.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
/// <remarks>
|
|
/// An IDWriteFontDownloadListener can also be passed to BeginDownload via the
|
|
/// context parameter, rather than globally registered to the queue.
|
|
/// </remarks>
|
|
STDMETHOD(AddListener)(
|
|
IDWriteFontDownloadListener* listener,
|
|
_Out_ UINT32* token
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Unregisters a notification handler that was previously registered using
|
|
/// AddListener.
|
|
/// </summary>
|
|
/// <param name="token">Token value previously returned by AddListener.</param>
|
|
/// <returns>
|
|
/// Returns S_OK if successful or E_INVALIDARG if the specified token does not
|
|
/// correspond to a registered listener.
|
|
/// </returns>
|
|
STDMETHOD(RemoveListener)(
|
|
UINT32 token
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Determines whether the download queue is empty. Note that the queue does not
|
|
/// include requests that are already being downloaded. In other words, BeginDownload
|
|
/// clears the queue.
|
|
/// </summary>
|
|
/// <returns>
|
|
/// TRUE if the queue is empty, FALSE if there are requests pending for BeginDownload.
|
|
/// </returns>
|
|
STDMETHOD_(BOOL, IsEmpty)() PURE;
|
|
|
|
/// <summary>
|
|
/// Begins an asynchronous download operation. The download operation executes
|
|
/// in the background until it completes or is cancelled by a CancelDownload call.
|
|
/// </summary>
|
|
/// <param name="context">Optional context object that is passed back to the
|
|
/// download notification handler's DownloadCompleted method. If the context object
|
|
/// implements IDWriteFontDownloadListener, its DownloadCompleted will be called
|
|
/// when done.</param>
|
|
/// <returns>
|
|
/// Returns S_OK if a download was successfully begun, S_FALSE if the queue was
|
|
/// empty, or a standard HRESULT error code.
|
|
/// </returns>
|
|
/// <remarks>
|
|
/// BeginDownload removes all download requests from the queue, transferring them
|
|
/// to a background download operation. If any previous downloads are still ongoing
|
|
/// when BeginDownload is called again, the new download does not complete until
|
|
/// the previous downloads have finished. If the queue is empty and no active
|
|
/// downloads are pending, the DownloadCompleted callback is called immediately with
|
|
/// DWRITE_DOWNLOAD_RESULT_NONE.
|
|
/// </remarks>
|
|
STDMETHOD(BeginDownload)(
|
|
_In_opt_ IUnknown* context = nullptr
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Removes all download requests from the queue and cancels any active download
|
|
/// operations. This calls DownloadCompleted with DWRITE_E_DOWNLOADCANCELLED.
|
|
/// Applications should call this when shutting down if they started any
|
|
/// downloads that have not finished yet with a call to DownloadCompleted.
|
|
/// </summary>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(CancelDownload)() PURE;
|
|
|
|
/// <summary>
|
|
/// Get the current generation number of the download queue, which is incremented
|
|
/// every time after a download completes, whether failed or successful. This cookie
|
|
/// comparison value may be used to compared against cached data to know when it is
|
|
/// stale.
|
|
/// </summary>
|
|
/// <returns>
|
|
/// The number of download queue generations.
|
|
/// </returns>
|
|
STDMETHOD_(UINT64, GetGenerationCount)() PURE;
|
|
};
|
|
|
|
|
|
/// <summary>
|
|
/// The GDI interop interface provides interoperability with GDI.
|
|
/// </summary>
|
|
interface DWRITE_DECLARE_INTERFACE("4556BE70-3ABD-4F70-90BE-421780A6F515") IDWriteGdiInterop1 : public IDWriteGdiInterop
|
|
{
|
|
/// <summary>
|
|
/// Creates a font object that matches the properties specified by the LOGFONT structure.
|
|
/// </summary>
|
|
/// <param name="logFont">Structure containing a GDI-compatible font description.</param>
|
|
/// <param name="fontCollection">The font collection to search. If NULL, the local system font collection is used.</param>
|
|
/// <param name="font">Receives a newly created font object if successful, or NULL in case of error.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
/// <remarks>
|
|
/// The only fields that matter include: lfFaceName, lfCharSet, lfWeight, lfItalic.
|
|
/// Font size and rendering mode are a rendering time property, not a font property,
|
|
/// and text decorations like underline are drawn separately from the text. If no
|
|
/// font matches the given weight, slope, and character set, the best match within
|
|
/// the given GDI family name will be returned. DWRITE_E_NOFONT is returned if there
|
|
/// is no matching font name using either the GDI family name (e.g. Arial) or the
|
|
/// full font name (e.g. Arial Bold Italic).
|
|
/// </remarks>
|
|
STDMETHOD(CreateFontFromLOGFONT)(
|
|
_In_ LOGFONTW const* logFont,
|
|
_In_opt_ IDWriteFontCollection* fontCollection,
|
|
_COM_Outptr_ IDWriteFont** font
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Reads the font signature from the given font.
|
|
/// </summary>
|
|
/// <param name="font">Font to read font signature from.</param>
|
|
/// <param name="fontSignature">Font signature from the OS/2 table, ulUnicodeRange and ulCodePageRange.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(GetFontSignature)(
|
|
_In_ IDWriteFont* font,
|
|
_Out_ FONTSIGNATURE* fontSignature
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Reads the font signature from the given font.
|
|
/// </summary>
|
|
/// <param name="font">Font to read font signature from.</param>
|
|
/// <param name="fontSignature">Font signature from the OS/2 table, ulUnicodeRange and ulCodePageRange.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(GetFontSignature)(
|
|
_In_ IDWriteFontFace* fontFace,
|
|
_Out_ FONTSIGNATURE* fontSignature
|
|
) PURE;
|
|
|
|
/// <summary>
|
|
/// Get a list of matching fonts based on the LOGFONT values. Only fonts
|
|
/// of that family name will be returned.
|
|
/// </summary>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(GetMatchingFontsByLOGFONT)(
|
|
_In_ LOGFONT const* logFont,
|
|
_In_ IDWriteFontSet* fontSet,
|
|
_COM_Outptr_ IDWriteFontSet** filteredSet
|
|
) PURE;
|
|
};
|
|
|
|
/// <summary>
|
|
/// Information about a formatted line of text.
|
|
/// </summary>
|
|
struct DWRITE_LINE_METRICS1 : DWRITE_LINE_METRICS
|
|
{
|
|
/// <summary>
|
|
/// White space before the content of the line. This is included in the line height and baseline distances.
|
|
/// If the line is formatted horizontally either with a uniform line spacing or with proportional
|
|
/// line spacing, this value represents the extra space above the content.
|
|
/// </summary>
|
|
FLOAT leadingBefore;
|
|
|
|
/// <summary>
|
|
/// White space after the content of the line. This is included in the height of the line.
|
|
/// If the line is formatted horizontally either with a uniform line spacing or with proportional
|
|
/// line spacing, this value represents the extra space below the content.
|
|
/// </summary>
|
|
FLOAT leadingAfter;
|
|
};
|
|
|
|
/// <summary>
|
|
/// Specify whether DWRITE_FONT_METRICS::lineGap value should be part of the line metrics.
|
|
/// </summary>
|
|
enum DWRITE_FONT_LINE_GAP_USAGE
|
|
{
|
|
/// <summary>
|
|
/// The usage of the font line gap depends on the method used for text layout.
|
|
/// </summary>
|
|
DWRITE_FONT_LINE_GAP_USAGE_DEFAULT,
|
|
|
|
/// <summary>
|
|
/// The font line gap is excluded from line spacing
|
|
/// </summary>
|
|
DWRITE_FONT_LINE_GAP_USAGE_DISABLED,
|
|
|
|
/// <summary>
|
|
/// The font line gap is included in line spacing
|
|
/// </summary>
|
|
DWRITE_FONT_LINE_GAP_USAGE_ENABLED
|
|
};
|
|
|
|
/// <summary>
|
|
/// The DWRITE_LINE_SPACING structure specifies the parameters used to specify how to manage space between lines.
|
|
/// </summary>
|
|
struct DWRITE_LINE_SPACING
|
|
{
|
|
/// <summary>
|
|
/// Method used to determine line spacing.
|
|
/// </summary>
|
|
DWRITE_LINE_SPACING_METHOD method;
|
|
|
|
/// <summary>
|
|
/// Spacing between lines.
|
|
/// The interpretation of this parameter depends upon the line spacing method, as follows:
|
|
/// - default line spacing: ignored
|
|
/// - uniform line spacing: explicit distance in DIPs between lines
|
|
/// - proportional line spacing: a scaling factor to be applied to the computed line height;
|
|
/// for each line, the height of the line is computed as for default line spacing, and the scaling factor is applied to that value.
|
|
/// </summary>
|
|
FLOAT height;
|
|
|
|
/// <summary>
|
|
/// Distance from top of line to baseline.
|
|
/// The interpretation of this parameter depends upon the line spacing method, as follows:
|
|
/// - default line spacing: ignored
|
|
/// - uniform line spacing: explicit distance in DIPs from the top of the line to the baseline
|
|
/// - proportional line spacing: a scaling factor applied to the computed baseline; for each line,
|
|
/// the baseline distance is computed as for default line spacing, and the scaling factor is applied to that value.
|
|
/// </summary>
|
|
FLOAT baseline;
|
|
|
|
/// <summary>
|
|
/// Proportion of the entire leading distributed before the line. The allowed value is between 0 and 1.0. The remaining
|
|
/// leading is distributed after the line. It is ignored for the default and uniform line spacing methods.
|
|
/// The leading that is available to distribute before or after the line depends on the values of the height and
|
|
/// baseline parameters.
|
|
/// </summary>
|
|
FLOAT leadingBefore;
|
|
|
|
/// <summary>
|
|
/// Specify whether DWRITE_FONT_METRICS::lineGap value should be part of the line metrics.
|
|
/// </summary>
|
|
DWRITE_FONT_LINE_GAP_USAGE fontLineGapUsage;
|
|
};
|
|
|
|
interface DWRITE_DECLARE_INTERFACE("F67E0EDD-9E3D-4ECC-8C32-4183253DFE70") IDWriteTextFormat2 : public IDWriteTextFormat1
|
|
{
|
|
/// <summary>
|
|
/// Set line spacing.
|
|
/// </summary>
|
|
/// <param name="lineSpacing">How to manage space between lines.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(SetLineSpacing)(_In_ DWRITE_LINE_SPACING const* lineSpacingOptions) PURE;
|
|
|
|
/// <summary>
|
|
/// Get line spacing.
|
|
/// </summary>
|
|
/// <param name="lineSpacing">How to manage space between lines.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(GetLineSpacing)(_Out_ DWRITE_LINE_SPACING* lineSpacingOptions) PURE;
|
|
};
|
|
|
|
interface DWRITE_DECLARE_INTERFACE("07DDCD52-020E-4DE8-AC33-6C953D83F92D") IDWriteTextLayout3 : public IDWriteTextLayout2
|
|
{
|
|
/// <summary>
|
|
/// Invalidates the layout, forcing layout to remeasure before calling the
|
|
/// metrics or drawing functions. This is useful if the locality of a font
|
|
/// changes, and layout should be redrawn, or if the size of a client
|
|
/// implemented IDWriteInlineObject changes.
|
|
/// </summary>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(InvalidateLayout)() PURE;
|
|
|
|
/// <summary>
|
|
/// Set line spacing.
|
|
/// </summary>
|
|
/// <param name="lineSpacing">How to manage space between lines.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(SetLineSpacing)(_In_ DWRITE_LINE_SPACING const* lineSpacingOptions) PURE;
|
|
|
|
/// <summary>
|
|
/// Get line spacing.
|
|
/// </summary>
|
|
/// <param name="lineSpacing">How to manage space between lines.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
STDMETHOD(GetLineSpacing)(_Out_ DWRITE_LINE_SPACING* lineSpacingOptions) PURE;
|
|
|
|
/// <summary>
|
|
/// GetLineMetrics returns properties of each line.
|
|
/// </summary>
|
|
/// <param name="lineMetrics">The array to fill with line information.</param>
|
|
/// <param name="maxLineCount">The maximum size of the lineMetrics array.</param>
|
|
/// <param name="actualLineCount">The actual size of the lineMetrics
|
|
/// array that is needed.</param>
|
|
/// <returns>
|
|
/// Standard HRESULT error code.
|
|
/// </returns>
|
|
/// <remarks>
|
|
/// If maxLineCount is not large enough E_NOT_SUFFICIENT_BUFFER,
|
|
/// which is equivalent to HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER),
|
|
/// is returned and *actualLineCount is set to the number of lines
|
|
/// needed.
|
|
/// </remarks>
|
|
STDMETHOD(GetLineMetrics)(
|
|
_Out_writes_to_opt_(maxLineCount, *actualLineCount) DWRITE_LINE_METRICS1* lineMetrics,
|
|
UINT32 maxLineCount,
|
|
_Out_ UINT32* actualLineCount
|
|
) PURE;
|
|
};
|
|
|
|
#endif /* DWRITE_3_H_INCLUDED */
|