directwrite.md

layout	wiki
title	DirectWrite API

This page is automatically generated from the assembly documentation.

It provides links between managed types and methods in the SharpDX.Direct2D1 assembly and the original documentation of the DirectWrite API on MSDN.

Today's applications must support high-quality text rendering, resolution-independent outline fonts, and full Unicode text and layout support.

• Enumerations
• Structures
• Interfaces

Enumerations

Managed	Native
Baseline	DWRITE_BASELINE The enumeration contains values that specify the baseline for text alignment.
BreakCondition	DWRITE_BREAK_CONDITION Indicates the condition at the edges of inline object or text used to determine line-breaking behavior.
FactoryType	DWRITE_FACTORY_TYPE Specifies the type of DirectWrite factory object.
FlowDirection	DWRITE_FLOW_DIRECTION Indicates the direction of flow for placing lines of text in a paragraph.
FontFaceType	DWRITE_FONT_FACE_TYPE Indicates the file format of a complete font face.
FontFeatureTag	DWRITE_FONT_FEATURE_TAG A value that indicates the typographic feature of text supplied by the font.
FontFileType	DWRITE_FONT_FILE_TYPE The type of a font represented by a single font file.
FontSimulations	DWRITE_FONT_SIMULATIONS Specifies algorithmic style simulations to be applied to the font face.
FontStretch	DWRITE_FONT_STRETCH Represents the degree to which a font has been stretched compared to a font's normal aspect ratio.
FontStyle	DWRITE_FONT_STYLE Represents the style of a font face as normal, italic, or oblique.
FontWeight	DWRITE_FONT_WEIGHT Represents the density of a typeface, in terms of the lightness or heaviness of the strokes.
GlyphOrientationAngle	DWRITE_GLYPH_ORIENTATION_ANGLE The enumeration contains values that specify how the glyph is oriented to the x-axis.
InformationalStringId	DWRITE_INFORMATIONAL_STRING_ID The informational string enumeration which identifies a string embedded in a font file.
LineSpacingMethod	DWRITE_LINE_SPACING_METHOD The method used for line spacing in a text layout.
NumberSubstitutionMethod	DWRITE_NUMBER_SUBSTITUTION_METHOD Specifies how to apply number substitution on digits and related punctuation.
OutlineThreshold	DWRITE_OUTLINE_THRESHOLD The enumeration contains values that specify the policy used by the method to determine whether to render glyphs in outline mode.
PanoseArmStyle	DWRITE_PANOSE_ARM_STYLE The enumeration contains values that specify the style of termination of stems and rounded letterforms for text.
PanoseAspect	DWRITE_PANOSE_ASPECT The enumeration contains values that specify info about the ratio between width and height of the character face.
PanoseAspectRatio	DWRITE_PANOSE_ASPECT_RATIO The enumeration contains values that specify info about the ratio between width and height of the character face.
PanoseCharacterRanges	DWRITE_PANOSE_CHARACTER_RANGES The enumeration contains values that specify the type of characters available in the font.
PanoseContrast	DWRITE_PANOSE_CONTRAST The enumeration contains values that specify the ratio between thickest and thinnest point of the stroke for a letter such as uppercase 'O'.
PanoseDecorativeClass	DWRITE_PANOSE_DECORATIVE_CLASS The enumeration contains values that specify the general look of the character face.
PanoseDecorativeTopology	DWRITE_PANOSE_DECORATIVE_TOPOLOGY The enumeration contains values that specify the overall shape characteristics of the font.
PanoseFamily	DWRITE_PANOSE_FAMILY The enumeration contains values that specify the kind of typeface classification.
PanoseFill	DWRITE_PANOSE_FILL The enumeration contains values that specify the type of fill and line treatment.
PanoseFinials	DWRITE_PANOSE_FINIALS The enumeration contains values that specify how character ends and miniscule ascenders are treated.
PanoseLetterform	DWRITE_PANOSE_LETTERFORM The enumeration contains values that specify the roundness of letterform for text.
PanoseLining	DWRITE_PANOSE_LINING The enumeration contains values that specify the handling of the outline for the decorative typeface.
PanoseMidline	DWRITE_PANOSE_MIDLINE The enumeration contains values that specify info about the placement of midline across uppercase characters and the treatment of diagonal stem apexes.
PanoseProportion	DWRITE_PANOSE_PROPORTION The enumeration contains values that specify the proportion of the glyph shape by considering additional detail to standard characters.
PanoseScriptForm	DWRITE_PANOSE_SCRIPT_FORM The enumeration contains values that specify the general look of the character face, with consideration of its slope and tails.
PanoseScriptTopology	DWRITE_PANOSE_SCRIPT_TOPOLOGY The enumeration contains values that specify the topology of letterforms.
PanoseSerifStyle	DWRITE_PANOSE_SERIF_STYLE The enumeration contains values that specify the appearance of the serif text.
PanoseSpacing	DWRITE_PANOSE_SPACING The enumeration contains values that specify character spacing (monospace versus proportional).
PanoseStrokeVariation	DWRITE_PANOSE_STROKE_VARIATION The enumeration contains values that specify the relationship between thin and thick stems of text characters.
PanoseSymbolAspectRatio	DWRITE_PANOSE_SYMBOL_ASPECT_RATIO The enumeration contains values that specify the aspect ratio of symbolic characters.
PanoseSymbolKind	DWRITE_PANOSE_SYMBOL_KIND The enumeration contains values that specify the kind of symbol set.
PanoseToolKind	DWRITE_PANOSE_TOOL_KIND The enumeration contains values that specify the kind of tool that is used to create character forms.
PanoseWeight	DWRITE_PANOSE_WEIGHT The enumeration contains values that specify the weight of characters.
PanoseXascent	DWRITE_PANOSE_XASCENT The enumeration contains values that specify the relative size of the lowercase letters.
PanoseXheight	DWRITE_PANOSE_XHEIGHT The enumeration contains values that specify info about the relative size of lowercase letters and the treatment of diacritic marks (xheight).
ParagraphAlignment	DWRITE_PARAGRAPH_ALIGNMENT Specifies the alignment of paragraph text along the flow direction axis, relative to the top and bottom of the flow's layout box.
PixelGeometry	DWRITE_PIXEL_GEOMETRY Represents the internal structure of a device pixel (that is, the physical arrangement of red, green, and blue color components) that is assumed for purposes of rendering text.
ReadingDirection	DWRITE_READING_DIRECTION Specifies the direction in which reading progresses.
RenderingMode	DWRITE_RENDERING_MODE Represents a method of rendering glyphs.
ScriptShapes	DWRITE_SCRIPT_SHAPES Indicates additional shaping requirements for text.
TextAlignment	DWRITE_TEXT_ALIGNMENT Specifies the alignment of paragraph text along the reading direction axis, relative to the leading and trailing edge of the layout box.
TextAntialiasMode	DWRITE_TEXT_ANTIALIAS_MODE The enumeration contains values that specify the type of antialiasing to use for text when the rendering mode calls for antialiasing.
TextureType	DWRITE_TEXTURE_TYPE Identifies a type of alpha texture.
TrimmingGranularity	DWRITE_TRIMMING_GRANULARITY Specifies the text granularity used to trim text overflowing the layout box.
VerticalGlyphOrientation	DWRITE_VERTICAL_GLYPH_ORIENTATION The enumeration contains values that specify the desired kind of glyph orientation for the text.
WordWrapping	DWRITE_WORD_WRAPPING Specifies the word wrapping to be used in a particular multiline paragraph.

Structures

Managed	Native
CaretMetrics	DWRITE_CARET_METRICS The structure specifies the metrics for caret placement in a font.
ClusterMetrics	DWRITE_CLUSTER_METRICS Contains information about a glyph cluster.
FontCollectionLoader	IDWriteFontCollectionLoader Used to construct a collection of fonts given a particular type of key.
FontFeature	DWRITE_FONT_FEATURE Specifies properties used to identify and execute typographic features in the current font face.
FontFileEnumerator	IDWriteFontFileEnumerator Encapsulates a collection of font files.
FontFileLoader	IDWriteFontFileLoader Handles loading font file resources of a particular type from a font file reference key into a font file stream object.
FontFileStream	IDWriteFontFileStream Loads font file data from a custom font file loader.
FontMetrics	DWRITE_FONT_METRICS The structure specifies the metrics that are applicable to all glyphs within the font face.
FontMetrics1	DWRITE_FONT_METRICS1 The structure specifies the metrics that are applicable to all glyphs within the font face.
GlyphMetrics	DWRITE_GLYPH_METRICS Specifies the metrics of an individual glyph.
GlyphOffset	DWRITE_GLYPH_OFFSET The optional adjustment to a glyph's position.
GlyphRun	DWRITE_GLYPH_RUN Contains the information needed by renderers to draw glyph runs.
GlyphRunDescription	DWRITE_GLYPH_RUN_DESCRIPTION Contains additional properties related to those in .
HitTestMetrics	DWRITE_HIT_TEST_METRICS Describes the region obtained by a hit test.
InlineObject	IDWriteInlineObject Wraps an application-defined inline graphic, allowing DWrite to query metrics as if the graphic were a glyph inline with the text.
InlineObjectMetrics	DWRITE_INLINE_OBJECT_METRICS Contains properties describing the geometric measurement of an application-defined inline object.
JustificationOpportunity	DWRITE_JUSTIFICATION_OPPORTUNITY The structure specifies justification info per glyph.
LineBreakpoint	DWRITE_LINE_BREAKPOINT Line breakpoint characteristics of a character.
LineMetrics	DWRITE_LINE_METRICS Contains information about a formatted line of text.
OverhangMetrics	DWRITE_OVERHANG_METRICS Indicates how much any visible DIPs (device independent pixels) overshoot each side of the layout or inline objects.
Panose	DWRITE_PANOSE The enumeration contains values that specify the type of characters available in the font.
PanoseDecorative	DWRITE_PANOSE_INNER_2 The enumeration contains values that specify the type of characters available in the font.
PanoseScript	DWRITE_PANOSE_INNER_1 The enumeration contains values that specify the type of characters available in the font.
PanoseSymbol	DWRITE_PANOSE_INNER_3 The enumeration contains values that specify the type of characters available in the font.
PanoseText	DWRITE_PANOSE_INNER_0 The enumeration contains values that specify the type of characters available in the font.
PixelSnapping	IDWritePixelSnapping Defines the pixel snapping properties such as pixels per DIP(device-independent pixel) and the current transform matrix of a text renderer.
ScriptAnalysis	DWRITE_SCRIPT_ANALYSIS Stores the association of text and its writing system script, as well as some display attributes.
ScriptProperties	DWRITE_SCRIPT_PROPERTIES The structure specifies script properties for caret navigation and justification.
ShapingGlyphProperties	DWRITE_SHAPING_GLYPH_PROPERTIES Contains shaping output properties for an output glyph.
ShapingTextProperties	DWRITE_SHAPING_TEXT_PROPERTIES Shaping output properties for an output glyph.
Strikethrough	DWRITE_STRIKETHROUGH Contains information regarding the size and placement of strikethroughs.
TextAnalysisSink	IDWriteTextAnalysisSink This interface is implemented by the text analyzer's client to receive the output of a given text analysis.
TextAnalysisSink1	IDWriteTextAnalysisSink1 The interface you implement to receive the output of the text analyzers.
TextAnalysisSource	IDWriteTextAnalysisSource Implemented by the text analyzer's client to provide text to the analyzer.
TextAnalysisSource1	IDWriteTextAnalysisSource1 The interface you implement to provide needed information to the text analyzer, like the text and associated text properties.
TextMetrics	DWRITE_TEXT_METRICS Contains the metrics associated with text after layout.
TextRange	DWRITE_TEXT_RANGE Specifies a range of text positions where format is applied in the text represented by an object.
TextRenderer	IDWriteTextRenderer Represents a set of application-defined callbacks that perform rendering of text, inline objects, and decorations such as underlines.
Trimming	DWRITE_TRIMMING Specifies the trimming option for text overflowing the layout box.
Underline	DWRITE_UNDERLINE Contains information about the width, thickness, offset, run height, reading direction, and flow direction of an underline.
UnicodeRange	DWRITE_UNICODE_RANGE The structure specifies the range of Unicode code points.

Interfaces

Managed	Native
BitmapRenderTarget CurrentTransform DrawGlyphRun DrawGlyphRun MemoryDC PixelsPerDip Resize Size	IDWriteBitmapRenderTarget GetCurrentTransform DrawGlyphRun ??? GetMemoryDC GetPixelsPerDip Resize GetSize Encapsulates a 32-bit device independent bitmap and device context, which can be used for rendering glyphs.
BitmapRenderTarget1 TextAntialiasMode	IDWriteBitmapRenderTarget1 GetTextAntialiasMode Encapsulates a 32-bit device independent bitmap and device context, which you can use for rendering glyphs.
Factory GdiInterop GetSystemFontCollection RegisterFontCollectionLoader RegisterFontFileLoader UnregisterFontCollectionLoader UnregisterFontFileLoader	IDWriteFactory GetGdiInterop GetSystemFontCollection ??? ??? ??? ??? Used to create all subsequent DirectWrite objects.
Factory1 CreateCustomRenderingParams GetEudcFontCollection	IDWriteFactory1 CreateCustomRenderingParams GetEudcFontCollection Creates a rendering parameters object with the specified properties.
Font FaceNames FontFamily GetInformationalStrings HasCharacter IsSymbolFont Metrics Simulations Stretch Style Weight	IDWriteFont GetFaceNames GetFontFamily GetInformationalStrings HasCharacter IsSymbolFont GetMetrics GetSimulations GetStretch GetStyle GetWeight Represents a physical font in a font collection.
Font1 GetUnicodeRanges IsMonospacedFont Metrics Panose	IDWriteFont1 GetUnicodeRanges IsMonospacedFont GetMetrics GetPanose Represents a physical font in a font collection.
FontCollection .ctor FindFamilyName FontFamilyCount GetFontFamily GetFontFromFontFace	IDWriteFontCollection ??? FindFamilyName GetFontFamilyCount GetFontFamily GetFontFromFontFace An object that encapsulates a set of fonts, such as the set of fonts installed on the system, or the set of fonts in a particular directory.
FontFace .ctor .ctor FaceType GetDesignGlyphMetrics GetFiles GetGdiCompatibleGlyphMetrics GetGdiCompatibleMetrics GetGlyphIndices GetGlyphRunOutline GetRecommendedRenderingMode GlyphCount Index IsSymbolFont Metrics ReleaseFontTable Simulations TryGetFontTable	IDWriteFontFace ??? ??? GetType ??? ??? ??? GetGdiCompatibleMetrics ??? ??? GetRecommendedRenderingMode GetGlyphCount GetIndex IsSymbolFont GetMetrics ReleaseFontTable GetSimulations ??? Represents an absolute reference to a font face which contains font face type, appropriate file references, face identification data and various font data such as metrics, names and glyph outlines.
FontFace1 CaretMetrics GetDesignGlyphAdvances GetGdiCompatibleGlyphAdvances GetGdiCompatibleMetrics GetKerningPairAdjustments GetRecommendedRenderingMode GetUnicodeRanges GetVerticalGlyphVariants HasKerningPairs HasVerticalGlyphVariants IsMonospacedFont Metrics	IDWriteFontFace1 GetCaretMetrics GetDesignGlyphAdvances GetGdiCompatibleGlyphAdvances GetGdiCompatibleMetrics GetKerningPairAdjustments GetRecommendedRenderingMode GetUnicodeRanges GetVerticalGlyphVariants HasKerningPairs HasVerticalGlyphVariants IsMonospacedFont GetMetrics Represents an absolute reference to a font face.
FontFamily FamilyNames GetFirstMatchingFont GetMatchingFonts	IDWriteFontFamily GetFamilyNames GetFirstMatchingFont GetMatchingFonts Creates a localized strings object that contains the family names for the font family, indexed by locale name.
FontFile .ctor .ctor .ctor Analyze GetReferenceKey Loader	IDWriteFontFile ??? ??? ??? Analyze ??? ??? Represents a font file.
FontFileLoaderNative CreateStreamFromKey	IDWriteFontFileLoader ??? Handles loading font file resources of a particular type from a font file reference key into a font file stream object.
FontFileStreamNative GetFileSize GetLastWriteTime ReadFileFragment ReleaseFileFragment	IDWriteFontFileStream ??? ??? ??? ??? Loads font file data from a custom font file loader.
FontList FontCollection FontCount GetFont	IDWriteFontList GetFontCollection GetFontCount GetFont Represents a list of fonts.
GdiInterop CreateBitmapRenderTarget CreateFontFaceFromHdc FromLogFont ToLogFont	IDWriteGdiInterop CreateBitmapRenderTarget CreateFontFaceFromHdc ??? ??? Provides interoperability with GDI, such as methods to convert a font face to a structure, or to convert a GDI font description into a font face.
GlyphRunAnalysis .ctor .ctor CreateAlphaTexture GetAlphaBlendParams GetAlphaTextureBounds	IDWriteGlyphRunAnalysis ??? ??? CreateAlphaTexture GetAlphaBlendParams GetAlphaTextureBounds Contains low-level information used to render a glyph run.
InlineObjectNative Draw GetBreakConditions Metrics OverhangMetrics	IDWriteInlineObject ??? ??? ??? ??? Wraps an application-defined inline graphic, allowing DWrite to query metrics as if the graphic were a glyph inline with the text.
LocalFontFileLoader GetFilePath GetLastWriteTime	IDWriteLocalFontFileLoader GetFilePathFromKey GetLastWriteTimeFromKey A built-in implementation of the interface, that operates on local font files and exposes local font file information from the font file reference key.
LocalizedStrings Count FindLocaleName GetLocaleName GetString	IDWriteLocalizedStrings GetCount FindLocaleName ??? ??? Represents a collection of strings indexed by locale name.
NumberSubstitution .ctor	IDWriteNumberSubstitution ??? Holds the appropriate digits and numeric punctuation for a specified locale.
RenderingParams .ctor .ctor .ctor ClearTypeLevel EnhancedContrast Gamma PixelGeometry RenderingMode	IDWriteRenderingParams ??? ??? ??? GetClearTypeLevel GetEnhancedContrast GetGamma GetPixelGeometry GetRenderingMode Represents text rendering settings such as ClearType level, enhanced contrast, and gamma correction for glyph rasterization and filtering.
RenderingParams1 GrayscaleEnhancedContrast	IDWriteRenderingParams1 GetGrayscaleEnhancedContrast Represents text rendering settings for glyph rasterization and filtering.
TextAnalyzer .ctor AnalyzeBidi AnalyzeLineBreakpoints AnalyzeNumberSubstitution AnalyzeScript GetGdiCompatibleGlyphPlacements GetGlyphPlacements GetGlyphs	IDWriteTextAnalyzer ??? ??? ??? ??? ??? ??? ??? ??? Analyzes various text properties for complex script processing such as bidirectional (bidi) support for languages like Arabic, determination of line break opportunities, glyph placement, and number substitution.
TextAnalyzer1 AnalyzeVerticalGlyphOrientation ApplyCharacterSpacing GetBaseline GetGlyphOrientationTransform GetJustificationOpportunities GetJustifiedGlyphs GetScriptProperties GetTextComplexity JustifyGlyphAdvances	IDWriteTextAnalyzer1 AnalyzeVerticalGlyphOrientation ApplyCharacterSpacing GetBaseline GetGlyphOrientationTransform GetJustificationOpportunities GetJustifiedGlyphs GetScriptProperties GetTextComplexity JustifyGlyphAdvances Analyzes various text properties for complex script processing.
TextFormat .ctor .ctor .ctor .ctor .ctor FlowDirection FontCollection FontFamilyName FontSize FontStretch FontStyle FontWeight GetLineSpacing GetTrimming IncrementalTabStop LocaleName ParagraphAlignment ReadingDirection SetLineSpacing SetTrimming TextAlignment WordWrapping	IDWriteTextFormat ??? ??? ??? ??? ??? GetFlowDirection GetFontCollection ??? GetFontSize GetFontStretch GetFontStyle GetFontWeight GetLineSpacing GetTrimming GetIncrementalTabStop ??? GetParagraphAlignment GetReadingDirection SetLineSpacing SetTrimming GetTextAlignment GetWordWrapping The interface describes the font and paragraph properties used to format text, and it describes locale information.
TextLayout .ctor .ctor .ctor DetermineMinWidth Draw Draw GetClusterMetrics GetDrawingEffect GetDrawingEffect GetFontCollection GetFontCollection GetFontFamilyName GetFontFamilyName GetFontSize GetFontSize GetFontStretch GetFontStretch GetFontStyle GetFontStyle GetFontWeight GetFontWeight GetInlineObject GetInlineObject GetLineMetrics GetLocaleName GetLocaleName GetTypography GetTypography HasStrikethrough HasStrikethrough HasUnderline HasUnderline HitTestPoint HitTestTextPosition HitTestTextRange MaxHeight MaxWidth Metrics OverhangMetrics SetDrawingEffect SetFontCollection SetFontFamilyName SetFontSize SetFontStretch SetFontStyle SetFontWeight SetInlineObject SetLocaleName SetStrikethrough SetTypography SetUnderline	IDWriteTextLayout ??? ??? ??? DetermineMinWidth ??? ??? ??? ??? ??? ??? GetFontCollection ??? ??? ??? GetFontSize ??? GetFontStretch ??? GetFontStyle ??? GetFontWeight ??? GetInlineObject ??? ??? ??? ??? GetTypography ??? GetStrikethrough ??? GetUnderline HitTestPoint HitTestTextPosition ??? GetMaxHeight GetMaxWidth GetMetrics GetOverhangMetrics ??? SetFontCollection SetFontFamilyName SetFontSize SetFontStretch SetFontStyle SetFontWeight ??? SetLocaleName SetStrikethrough SetTypography SetUnderline The interface represents a block of text after it has been fully analyzed and formatted.
TextLayout1 GetCharacterSpacing GetPairKerning SetCharacterSpacing SetPairKerning	IDWriteTextLayout1 GetCharacterSpacing GetPairKerning SetCharacterSpacing SetPairKerning Represents a block of text after it has been fully analyzed and formatted.
Typography .ctor AddFontFeature FontFeatureCount GetFontFeature	IDWriteTypography ??? AddFontFeature GetFontFeatureCount GetFontFeature Represents a font typography setting.