Table of Contents

Namespace SharpDX.DirectWrite

Classes

AsyncResult
BitmapRenderTarget
BitmapRenderTarget1
ColorGlyphRunEnumerator
ColorGlyphRunEnumerator1
EllipsisTrimming

An inline object for trimming, using an ellipsis as the omission sign.

Factory
Factory1

Creates a rendering parameters object with the specified properties.

Factory2
Factory3
Factory4
Factory5
Font
Font1
Font2
Font3
FontCollection
FontCollection1
FontDownloadListener
FontDownloadQueue
FontFace
FontFace1
FontFace2
FontFace3
FontFace4
FontFaceReference
FontFallback
FontFallbackBuilder
FontFamily
FontFamily1
FontFile
FontFileLoaderNative
FontFileStreamNative
FontList
FontList1
FontSet
FontSetBuilder
FontSetBuilder1
GdiInterop
GdiInterop.LogFont
GdiInterop1
GlyphRun

Contains the information needed by renderers to draw glyph runs. All coordinates are in device independent pixels (DIPs).

GlyphRunAnalysis
GlyphRunDescription

Contains additional properties related to those in GlyphRun.

InMemoryFontFileLoader
InlineObjectNative
LocalFontFileLoader
LocalizedStrings
NumberSubstitution
RemoteFontFileLoader
RemoteFontFileStream
RenderingParams
RenderingParams1
RenderingParams2
RenderingParams3
StringList
TextAnalyzer
TextAnalyzer1
TextAnalyzer2
TextFormat
TextFormat1
TextFormat2
TextLayout
TextLayout1
TextLayout2
TextLayout3
TextRendererBase

Default abstract implementation of TextRenderer. Need to implement a least a DrawXXX method to use it.

Typography

Structs

CaretMetrics

The CaretMetrics structure specifies the metrics for caret placement in a font.

ClusterMetrics

Contains information about a glyph cluster.

ColorGlyphRun

Contains the information needed by renderers to draw glyph runs with glyph color information. All coordinates are in device independent pixels (DIPs).

ColorGlyphRun1

Represents a color glyph run. The IDWriteFactory4::TranslateColorGlyphRun method returns an ordered collection of color glyph runs of varying types depending on what the font supports.

FileFragment

No documentation.

FontFeature

Specifies properties used to identify and execute typographic features in the current font face.

FontMetrics

The FontMetrics structure specifies the metrics that are applicable to all glyphs within the font face.

FontMetrics1

The FontMetrics1 structure specifies the metrics that are applicable to all glyphs within the font face.

FontProperty

Font property used for filtering font sets and building a font set with explicit properties.

GdiInterop.FontSignature
GlyphImageData

Data for a single glyph from GetGlyphImageData.

GlyphMetrics

Specifies the metrics of an individual glyph. The units depend on how the metrics are obtained.

GlyphOffset

The optional adjustment to a glyph's position.

GlyphRunItem

A GlyphRunItem Item.

HitTestMetrics

Describes the region obtained by a hit test.

InlineObjectMetrics

Contains properties describing the geometric measurement of an application-defined inline object.

JustificationOpportunity

The JustificationOpportunity structure specifies justification info per glyph.

LineBreakpoint

Line breakpoint characteristics of a character.

LineMetrics

Contains information about a formatted line of text.

LineMetrics1

Contains information about a formatted line of text.

LineSpacing

OverhangMetrics

Indicates how much any visible DIPs (device independent pixels) overshoot each side of the layout or inline objects.

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 the final target's pixel bounds after applying grid fitting and hinting.

Panose

The Panose union describes typeface classification values that you use with IDWriteFont1::GetPanose to select and match the font.

PanoseDecorative

No documentation.

PanoseScript

No documentation.

PanoseSymbol

No documentation.

PanoseText

No documentation.

ScriptAnalysis

Stores the association of text and its writing system script, as well as some display attributes.

ScriptProperties

The ScriptProperties structure specifies script properties for caret navigation and justification.

ShapingGlyphProperties

Contains shaping output properties for an output glyph.

ShapingTextProperties

Shaping output properties for an output glyph.

Strikethrough

Contains information regarding the size and placement of strikethroughs. All coordinates are in device independent pixels (DIPs).

TextMetrics

Contains the metrics associated with text after layout. All coordinates are in device independent pixels (DIPs).

TextMetrics1

Contains the metrics associated with text after layout. All coordinates are in device independent pixels (DIPs).

TextRange

Specifies a range of text positions where format is applied in the text represented by an TextLayout object.

Trimming

Specifies the trimming option for text overflowing the layout box.

Underline

Contains information about the width, thickness, offset, run height, reading direction, and flow direction of an underline.

UnicodeRange

The UnicodeRange structure specifies the range of Unicode code points.

Interfaces

FontCollectionLoader
FontFileEnumerator
FontFileLoader
FontFileStream
InlineObject
PixelSnapping
TextAnalysisSink
TextAnalysisSink1
TextAnalysisSource
TextAnalysisSource1
TextRenderer
TextRenderer1

Enums

Baseline

The Baseline enumeration contains values that specify the baseline for text alignment.

BreakCondition

Indicates the condition at the edges of inline object or text used to determine line-breaking behavior.

ContainerType

Represents the degree to which a font has been stretched compared to a font's normal aspect ratio. The enumerated values correspond to the usWidthClass definition in the OpenType specification. The usWidthClass represents an integer value between 1 and 9?lower values indicate narrower widths; higher values indicate wider widths.

FactoryType

Specifies the type of DirectWrite factory object.

FlowDirection

Indicates the direction of how lines of text are placed relative to one another.

FontFaceType

Indicates the file format of a complete font face.

FontFeatureTag

A value that indicates the typographic feature of text supplied by the font.

FontFileType

The type of a font represented by a single font file. Font formats that consist of multiple files, for example Type 1 .PFM and .PFB, have separate enum values for each of the file types.

FontLineGapUsage

Specify whether FontMetrics::lineGap value should be part of the line metrics

FontPropertyId

Identifies a string in a font.

FontSimulations

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

FontStretch

Represents the degree to which a font has been stretched compared to a font's normal aspect ratio. The enumerated values correspond to the usWidthClass definition in the OpenType specification. The usWidthClass represents an integer value between 1 and 9?lower values indicate narrower widths; higher values indicate wider widths.

FontStyle

Represents the style of a font face as normal, italic, or oblique.

FontWeight

Represents the density of a typeface, in terms of the lightness or heaviness of the strokes. The enumerated values correspond to the usWeightClass definition in the OpenType specification. The usWeightClass represents an integer value between 1 and 999. Lower values indicate lighter weights; higher values indicate heavier weights.

GlyphOrientationAngle

The GlyphOrientationAngle enumeration contains values that specify how the glyph is oriented to the x-axis.

GridFitMode

Specifies whether to enable grid-fitting of glyph outlines (also known as hinting).

InformationalStringId

The informational string enumeration which identifies a string embedded in a font file.

LineSpacingMethod

The method used for line spacing in a text layout.

Locality

Specifies the location of a resource.

NumberSubstitutionMethod

Specifies how to apply number substitution on digits and related punctuation.

OptimizationIcalAlignment

The optical margin alignment mode.

By default, glyphs are aligned to the margin by the default origin and side-bearings of the glyph. If you specify DWRITE_OPTICAL_ALIGNMENT_NO_SIDE_BEARINGS, then the alignment uses the side bearings to offset the glyph from the aligned edge to ensure the ink of the glyphs are aligned.

OutlineThreshold

The OutlineThreshold enumeration contains values that specify the policy used by the IDWriteFontFace1::GetRecommendedRenderingMode method to determine whether to render glyphs in outline mode.

PanoseArmStyle

The PanoseArmStyle enumeration contains values that specify the style of termination of stems and rounded letterforms for text.

PanoseAspect

The PanoseAspect enumeration contains values that specify the ratio between the width and height of the character face.

PanoseAspectRatio

The PanoseAspectRatio enumeration contains values that specify info about the ratio between width and height of the character face.

PanoseCharacterRanges

The PanoseCharacterRanges enumeration contains values that specify the type of characters available in the font.

PanoseContrast

The PanoseContrast enumeration contains values that specify the ratio between thickest and thinnest point of the stroke for a letter such as uppercase 'O'.

PanoseDecorativeClass

The PanoseDecorativeClass enumeration contains values that specify the general look of the character face.

PanoseDecorativeTopology

The PanoseDecorativeTopology enumeration contains values that specify the overall shape characteristics of the font.

PanoseFamily

The PanoseFamily enumeration contains values that specify the kind of typeface classification.

PanoseFill

The PanoseFill enumeration contains values that specify the type of fill and line treatment.

PanoseFinials

The PanoseFinials enumeration contains values that specify how character ends and miniscule ascenders are treated.

PanoseLetterform

The PanoseLetterform enumeration contains values that specify the roundness of letterform for text.

PanoseLining

The PanoseLining enumeration contains values that specify the handling of the outline for the decorative typeface.

PanoseMidline

The PanoseMidline enumeration contains values that specify info about the placement of midline across uppercase characters and the treatment of diagonal stem apexes.

PanoseProportion

The PanoseProportion enumeration contains values that specify the proportion of the glyph shape by considering additional detail to standard characters.

PanoseScriptForm

The PanoseScriptForm enumeration contains values that specify the general look of the character face, with consideration of its slope and tails.

PanoseScriptTopology

The PanoseScriptTopology enumeration contains values that specify the topology of letterforms.

PanoseSerifStyle

The PanoseSerifStyle enumeration contains values that specify the appearance of the serif text.

PanoseSpacing

The PanoseSpacing enumeration contains values that specify character spacing (monospace versus proportional).

PanoseStrokeVariation

The PanoseStrokeVariation enumeration contains values that specify the relationship between thin and thick stems of text characters.

PanoseSymbolAspectRatio

The PanoseSymbolAspectRatio enumeration contains values that specify the aspect ratio of symbolic characters.

PanoseSymbolKind

The PanoseSymbolKind enumeration contains values that specify the kind of symbol set.

PanoseToolKind

The PanoseToolKind enumeration contains values that specify the kind of tool that is used to create character forms.

PanoseWeight

The PanoseWeight enumeration contains values that specify the weight of characters.

PanoseXascent

The PanoseXascent enumeration contains values that specify the relative size of the lowercase letters.

PanoseXheight

The PanoseXheight enumeration contains values that specify info about the relative size of lowercase letters and the treatment of diacritic marks (xheight).

ParagraphAlignment

Specifies the alignment of paragraph text along the flow direction axis, relative to the top and bottom of the flow's layout box.

PixelGeometry

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

Specifies the direction in which reading progresses.

Note??DWRITE_READING_DIRECTION_TOP_TO_BOTTOM and DWRITE_READING_DIRECTION_BOTTOM_TO_TOP are available in Windows?8.1 and later, only.?
RenderingMode

Represents a method of rendering glyphs.

Note?? This topic is about RenderingMode in Windows?8 and later. For info on the previous version see this topic.?
RenderingMode1

Represents a method of rendering glyphs.

Note?? This topic is about RenderingMode in Windows?8 and later. For info on the previous version see this topic.?
ScriptJustify

Defines glyph characteristic information that an application needs to implement justification.

ScriptShapes

Indicates additional shaping requirements for text.

TextAlignment

Specifies the alignment of paragraph text along the reading direction axis, relative to the leading and trailing edge of the layout box.

TextAntialiasMode

The TextAntialiasMode enumeration contains values that specify the type of antialiasing to use for text when the rendering mode calls for antialiasing.

TextureType

Identifies a type of alpha texture.

TrimmingGranularity

Specifies the text granularity used to trim text overflowing the layout box.

VerticalGlyphOrientation

The VerticalGlyphOrientation enumeration contains values that specify the desired kind of glyph orientation for the text.

WordWrapping

Specifies the word wrapping to be used in a particular multiline paragraph.

Note??DWRITE_WORD_WRAPPING_EMERGENCY_BREAK, DWRITE_WORD_WRAPPING_WHOLE _WORD, and DWRITE_WORD_WRAPPING_CHARACTER are available in Windows?8.1 and later, only.?