directx.dwrite

Members

Aliases

DWRITE_BREAK_CONDITION
alias DWRITE_BREAK_CONDITION = int

<summary> Condition at the edges of inline object or text used to determine line-breaking behavior. </summary>

DWRITE_FACTORY_TYPE
alias DWRITE_FACTORY_TYPE = int

<summary> Specifies the type of DirectWrite factory object. DirectWrite factory contains internal state such as font loader registration and cached font data. In most cases it is recommended to use the shared factory object, because it allows multiple components that use DirectWrite to share internal DirectWrite state and reduce memory usage. However, there are cases when it is desirable to reduce the impact of a component, such as a plug-in from an untrusted source, on the rest of the process by sandboxing and isolating it from the rest of the process components. In such cases, it is recommended to use an isolated factory for the sandboxed component. </summary>

DWRITE_FLOW_DIRECTION
alias DWRITE_FLOW_DIRECTION = int

<summary> Direction for how lines of text are placed relative to one another. </summary>

DWRITE_FONT_FACE_TYPE
alias DWRITE_FONT_FACE_TYPE = int

<summary> The file format of a complete font face. Font formats that consist of multiple files, e.g. Type 1 .PFM and .PFB, have a single enum entry. </summary>

DWRITE_FONT_FEATURE_TAG
alias DWRITE_FONT_FEATURE_TAG = int

<summary> Typographic feature of text supplied by the font. </summary>

DWRITE_FONT_FILE_TYPE
alias DWRITE_FONT_FILE_TYPE = int

<summary> The type of a font represented by a single font file. Font formats that consist of multiple files, e.g. Type 1 .PFM and .PFB, have separate enum values for each of the file type. </summary>

DWRITE_FONT_SIMULATIONS
alias DWRITE_FONT_SIMULATIONS = int

<summary> Specifies algorithmic style simulations to be applied to the font face. Bold and oblique simulations can be combined via bitwise OR operation. </summary>

DWRITE_FONT_STRETCH
alias DWRITE_FONT_STRETCH = int

<summary> The font stretch enumeration describes relative change from the normal aspect ratio as specified by a font designer for the glyphs in a font. Values less than 1 or greater than 9 are considered to be invalid, and they are rejected by font API functions. </summary>

DWRITE_FONT_STYLE
alias DWRITE_FONT_STYLE = int

<summary> The font style enumeration describes the slope style of a font face, such as Normal, Italic or Oblique. Values other than the ones defined in the enumeration are considered to be invalid, and they are rejected by font API functions. </summary>

DWRITE_FONT_WEIGHT
alias DWRITE_FONT_WEIGHT = int

<summary> The font weight enumeration describes common values for degree of blackness or thickness of strokes of characters in a font. Font weight values less than 1 or greater than 999 are considered to be invalid, and they are rejected by font API functions. </summary>

DWRITE_INFORMATIONAL_STRING_ID
alias DWRITE_INFORMATIONAL_STRING_ID = int

<summary> The informational string enumeration identifies a string in a font. </summary>

DWRITE_LINE_SPACING_METHOD
alias DWRITE_LINE_SPACING_METHOD = int

<summary> The method used for line spacing in layout. </summary>

DWRITE_NUMBER_SUBSTITUTION_METHOD
alias DWRITE_NUMBER_SUBSTITUTION_METHOD = int

<summary> How to apply number substitution on digits and related punctuation. </summary>

DWRITE_PARAGRAPH_ALIGNMENT
alias DWRITE_PARAGRAPH_ALIGNMENT = int

<summary> Alignment of paragraph text along the flow direction axis relative to the flow's beginning and ending edge of the layout box. </summary>

DWRITE_PIXEL_GEOMETRY
alias DWRITE_PIXEL_GEOMETRY = int

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

DWRITE_READING_DIRECTION
alias DWRITE_READING_DIRECTION = int

<summary> Direction for how reading progresses. </summary>

DWRITE_RENDERING_MODE
alias DWRITE_RENDERING_MODE = int

<summary> Represents a method of rendering glyphs. </summary>

DWRITE_TEXTURE_TYPE
alias DWRITE_TEXTURE_TYPE = int

<summary> The DWRITE_TEXTURE_TYPE enumeration identifies a type of alpha texture. An alpha texture is a bitmap of alpha values, each representing the darkness (i.e., opacity) of a pixel or subpixel. </summary>

DWRITE_TEXT_ALIGNMENT
alias DWRITE_TEXT_ALIGNMENT = int

<summary> Alignment of paragraph text along the reading direction axis relative to the leading and trailing edge of the layout box. </summary>

DWRITE_TRIMMING_GRANULARITY
alias DWRITE_TRIMMING_GRANULARITY = int

<summary> Text granularity used to trim text overflowing the layout box. </summary>

DWRITE_WORD_WRAPPING
alias DWRITE_WORD_WRAPPING = int

<summary> Word wrapping in multiline paragraph. </summary>

Functions

DWriteCreateFactory
HRESULT DWriteCreateFactory(DWRITE_FACTORY_TYPE factoryType, REFIID iid, IUnknown* factory)

<summary> Creates a DirectWrite factory object that is used for subsequent creation of individual DirectWrite objects. </summary> <param name="factoryType">Identifies whether the factory object will be shared or isolated.</param> <param name="iid">Identifies the DirectWrite factory interface, such as __uuidof(IDWriteFactory).</param> <param name="factory">Receives the DirectWrite factory object.</param> <returns> Standard HRESULT error code. </returns> <remarks> Obtains DirectWrite factory object that is used for subsequent creation of individual DirectWrite classes. DirectWrite factory contains internal state such as font loader registration and cached font data. In most cases it is recommended to use the shared factory object, because it allows multiple components that use DirectWrite to share internal DirectWrite state and reduce memory usage. However, there are cases when it is desirable to reduce the impact of a component, such as a plug-in from an untrusted source, on the rest of the process by sandboxing and isolating it from the rest of the process components. In such cases, it is recommended to use an isolated factory for the sandboxed component. </remarks>

Interfaces

IDWriteBitmapRenderTarget
interface IDWriteBitmapRenderTarget

<summary> Encapsulates a 32-bit device independent bitmap and device context, which can be used for rendering glyphs. </summary>

IDWriteFactory
interface IDWriteFactory

<summary> The root factory interface for all DWrite objects. </summary>

IDWriteFont
interface IDWriteFont

<summary> The IDWriteFont interface represents a physical font in a font collection. </summary>

IDWriteFontCollection
interface IDWriteFontCollection

<summary> The IDWriteFontCollection encapsulates a collection of fonts. </summary>

IDWriteFontCollectionLoader
interface IDWriteFontCollectionLoader

<summary> The font collection loader interface is used to construct a collection of fonts given a particular type of key. The font collection loader interface is recommended to be implemented by a singleton object. IMPORTANT: font collection loader implementations must not register themselves with a DirectWrite factory inside their constructors and must not unregister themselves in their destructors, because registration and unregistration operations increment and decrement the object reference count respectively. Instead, registration and unregistration of font file loaders with DirectWrite factory should be performed outside of the font file loader implementation as a separate step. </summary>

IDWriteFontFace
interface IDWriteFontFace

<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>

IDWriteFontFamily
interface IDWriteFontFamily

<summary> The IDWriteFontFamily interface represents a set of fonts that share the same design but are differentiated by weight, stretch, and style. </summary>

IDWriteFontFile
interface IDWriteFontFile

<summary> The interface that represents a reference to a font file. </summary>

IDWriteFontFileEnumerator
interface IDWriteFontFileEnumerator

<summary> The font file enumerator interface encapsulates a collection of font files. The font system uses this interface to enumerate font files when building a font collection. </summary>

IDWriteFontFileLoader
interface IDWriteFontFileLoader

<summary> Font file loader interface handles loading font file resources of a particular type from a key. The font file loader interface is recommended to be implemented by a singleton object. IMPORTANT: font file loader implementations must not register themselves with DirectWrite factory inside their constructors and must not unregister themselves in their destructors, because registration and unregistration operations increment and decrement the object reference count respectively. Instead, registration and unregistration of font file loaders with DirectWrite factory should be performed outside of the font file loader implementation as a separate step. </summary>

IDWriteFontFileStream
interface IDWriteFontFileStream

<summary> The interface for loading font file data. </summary>

IDWriteFontList
interface IDWriteFontList

<summary> The IDWriteFontList interface represents a list of fonts. </summary>

IDWriteGdiInterop
interface IDWriteGdiInterop

<summary> The GDI interop interface provides interoperability with GDI. </summary>

IDWriteGlyphRunAnalysis
interface IDWriteGlyphRunAnalysis

<summary> Interface that encapsulates information used to render a glyph run. </summary>

IDWriteInlineObject
interface IDWriteInlineObject

<summary> The IDWriteInlineObject interface wraps an application defined inline graphic, allowing DWrite to query metrics as if it was a glyph inline with the text. </summary>

IDWriteLocalFontFileLoader
interface IDWriteLocalFontFileLoader

<summary> A built-in implementation of IDWriteFontFileLoader interface that operates on local font files and exposes local font file information from the font file reference key. Font file references created using CreateFontFileReference use this font file loader. </summary>

IDWriteLocalizedStrings
interface IDWriteLocalizedStrings

<summary> Represents a collection of strings indexed by locale name. </summary>

IDWriteNumberSubstitution
interface IDWriteNumberSubstitution

<summary> Holds the appropriate digits and numeric punctuation for a given locale. </summary>

IDWritePixelSnapping
interface IDWritePixelSnapping

<summary> The IDWritePixelSnapping interface defines the pixel snapping properties of a text renderer. </summary>

IDWriteRenderingParams
interface IDWriteRenderingParams

<summary> The interface that represents text rendering settings for glyph rasterization and filtering. </summary>

IDWriteTextAnalysisSink
interface IDWriteTextAnalysisSink

<summary> The interface implemented by the text analyzer's client to receive the output of a given text analysis. The Text analyzer disregards any current state of the analysis sink, therefore a Set method call on a range overwrites the previously set analysis result of the same range. </summary>

IDWriteTextAnalysisSource
interface IDWriteTextAnalysisSource

<summary> The interface implemented by the text analyzer's client to provide text to the analyzer. It allows the separation between the logical view of text as a continuous stream of characters identifiable by unique text positions, and the actual memory layout of potentially discrete blocks of text in the client's backing store.

IDWriteTextAnalyzer
interface IDWriteTextAnalyzer

<summary> Analyzes various text properties for complex script processing. </summary>

IDWriteTextFormat
interface IDWriteTextFormat

<summary> The format of text used for text layout. </summary> <remarks> This object may not be thread-safe and it may carry the state of text format change. </remarks>

IDWriteTextLayout
interface IDWriteTextLayout

<summary> The IDWriteTextLayout interface represents a block of text after it has been fully analyzed and formatted.

IDWriteTextRenderer
interface IDWriteTextRenderer

<summary> The IDWriteTextRenderer interface represents a set of application-defined callbacks that perform rendering of text, inline objects, and decorations such as underlines. </summary>

IDWriteTypography
interface IDWriteTypography

<summary> Font typography setting. </summary>

Manifest constants

DWRITE_ALPHA_MAX
enum DWRITE_ALPHA_MAX;

<summary> Maximum alpha value in a texture returned by IDWriteGlyphRunAnalysis::CreateAlphaTexture. </summary>

Structs

DWRITE_CLUSTER_METRICS
struct DWRITE_CLUSTER_METRICS

<summary> The DWRITE_CLUSTER_METRICS structure contains information about a glyph cluster. </summary>

DWRITE_FONT_FEATURE
struct DWRITE_FONT_FEATURE

<summary> The DWRITE_FONT_FEATURE structure specifies properties used to identify and execute typographic feature in the font. </summary>

DWRITE_FONT_METRICS
struct DWRITE_FONT_METRICS

<summary> The DWRITE_FONT_METRICS structure specifies the metrics of a font face that are applicable to all glyphs within the font face. </summary>

DWRITE_GLYPH_METRICS
struct DWRITE_GLYPH_METRICS

<summary> The DWRITE_GLYPH_METRICS structure specifies the metrics of an individual glyph. The units depend on how the metrics are obtained. </summary>

DWRITE_GLYPH_OFFSET
struct DWRITE_GLYPH_OFFSET

<summary> Optional adjustment to a glyph's position. A glyph offset changes the position of a glyph without affecting the pen position. Offsets are in logical, pre-transform units. </summary>

DWRITE_GLYPH_RUN
struct DWRITE_GLYPH_RUN

<summary> The DWRITE_GLYPH_RUN structure contains the information needed by renderers to draw glyph runs. All coordinates are in device independent pixels (DIPs). </summary>

DWRITE_GLYPH_RUN_DESCRIPTION
struct DWRITE_GLYPH_RUN_DESCRIPTION

<summary> The DWRITE_GLYPH_RUN_DESCRIPTION structure contains additional properties related to those in DWRITE_GLYPH_RUN. </summary>

DWRITE_HIT_TEST_METRICS
struct DWRITE_HIT_TEST_METRICS

<summary> Geometry enclosing of text positions. </summary>

DWRITE_INLINE_OBJECT_METRICS
struct DWRITE_INLINE_OBJECT_METRICS

<summary> Properties describing the geometric measurement of an application-defined inline object. </summary>

DWRITE_LINE_BREAKPOINT
struct DWRITE_LINE_BREAKPOINT

<summary> Line breakpoint characteristics of a character. </summary>

DWRITE_LINE_METRICS
struct DWRITE_LINE_METRICS

<summary> The DWRITE_LINE_METRICS structure contains information about a formatted line of text. </summary>

DWRITE_MATRIX
struct DWRITE_MATRIX

<summary> The DWRITE_MATRIX structure specifies the graphics transform to be applied to rendered glyphs. </summary>

DWRITE_OVERHANG_METRICS
struct DWRITE_OVERHANG_METRICS

<summary> The DWRITE_OVERHANG_METRICS structure holds how much any visible pixels (in DIPs) overshoot each side of the layout or inline objects. </summary> <remarks> Positive overhangs indicate that the visible area extends outside the layout box or inline object, while negative values mean there is whitespace inside. The returned values are unaffected by rendering transforms or pixel snapping. Additionally, they may not exactly match final target's pixel bounds after applying grid fitting and hinting. </remarks>

DWRITE_SCRIPT_ANALYSIS
struct DWRITE_SCRIPT_ANALYSIS

<summary> Association of text and its writing system script as well as some display attributes. </summary>

DWRITE_SHAPING_GLYPH_PROPERTIES
struct DWRITE_SHAPING_GLYPH_PROPERTIES

<summary> Shaping output properties per output glyph. </summary>

DWRITE_SHAPING_TEXT_PROPERTIES
struct DWRITE_SHAPING_TEXT_PROPERTIES

<summary> Shaping output properties per input character. </summary>

DWRITE_STRIKETHROUGH
struct DWRITE_STRIKETHROUGH

<summary> The DWRITE_STRIKETHROUGH structure contains information about the size and placement of strikethroughs. All coordinates are in device independent pixels (DIPs). </summary>

DWRITE_TEXT_METRICS
struct DWRITE_TEXT_METRICS

<summary> Overall metrics associated with text after layout. All coordinates are in device independent pixels (DIPs). </summary>

DWRITE_TEXT_RANGE
struct DWRITE_TEXT_RANGE

<summary> The DWRITE_TEXT_RANGE structure specifies a range of text positions where format is applied. </summary>

DWRITE_TRIMMING
struct DWRITE_TRIMMING

<summary> The DWRITE_TRIMMING structure specifies the trimming option for text overflowing the layout box. </summary>

DWRITE_TYPOGRAPHIC_FEATURES
struct DWRITE_TYPOGRAPHIC_FEATURES

<summary> Defines a set of typographic features to be applied during shaping. Notice the character range which this feature list spans is specified as a separate parameter to GetGlyphs. </summary>

DWRITE_UNDERLINE
struct DWRITE_UNDERLINE

<summary> The DWRITE_UNDERLINE structure contains information about the size and placement of underlines. All coordinates are in device independent pixels (DIPs). </summary>

Meta