Struct DWriteTextMetrics

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

Implements

IEquatable<DWriteTextMetrics>

Inherited Members

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: JeremyAnsel.DirectX.DWrite

Assembly: JeremyAnsel.DirectX.DWrite.dll

Syntax

public struct DWriteTextMetrics : IEquatable<DWriteTextMetrics>

Properties

Height

Gets the height of the formatted text. The height of an empty string is determined by the size of the default font's line height.

Declaration

public float Height { get; }

Property Value

Type	Description
float

LayoutHeight

Gets the initial height given to the layout. Depending on the length of the text, it may be larger or smaller than the text content height.

Declaration

public float LayoutHeight { get; }

Property Value

Type	Description
float

LayoutWidth

Gets the initial width given to the layout. Depending on whether the text was wrapped or not, it can be either larger or smaller than the text content width.

Declaration

public float LayoutWidth { get; }

Property Value

Type	Description
float

Left

Gets the left-most point of formatted text relative to layout box (excluding any glyph overhang).

Declaration

public float Left { get; }

Property Value

Type	Description
float

LineCount

Gets the total number of lines.

Declaration

public uint LineCount { get; }

Property Value

Type	Description
uint

MaxBidiReorderingDepth

Gets the maximum reordering count of any line of text, used to calculate the most number of hit-testing boxes needed. If the layout has no bidirectional text or no text at all, the minimum level is 1.

Declaration

public uint MaxBidiReorderingDepth { get; }

Property Value

Type	Description
uint

Top

Gets the top-most point of formatted text relative to layout box (excluding any glyph overhang).

Declaration

public float Top { get; }

Property Value

Type	Description
float

Width

Gets the width of the formatted text ignoring trailing whitespace at the end of each line.

Declaration

public float Width { get; }

Property Value

Type	Description
float

WidthIncludingTrailingWhitespace

Gets the width of the formatted text taking into account the trailing whitespace at the end of each line.

Declaration

public float WidthIncludingTrailingWhitespace { get; }

Property Value

Type	Description
float

Methods

Equals(DWriteTextMetrics)

Declaration

public readonly bool Equals(DWriteTextMetrics other)

Parameters

Type	Name	Description
DWriteTextMetrics	other

Returns

Type	Description
bool

Equals(object?)

Declaration

public override readonly bool Equals(object? obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

ValueType.Equals(object)

GetHashCode()

Declaration

public override readonly int GetHashCode()

Returns

Type	Description
int

Overrides

ValueType.GetHashCode()

NativeReadFrom(nint)

Declaration

public static DWriteTextMetrics NativeReadFrom(nint buffer)

Parameters

Type	Name	Description
nint	buffer

Returns

Type	Description
DWriteTextMetrics

NativeReadFrom(nint, Span<DWriteTextMetrics>)

Declaration

public static void NativeReadFrom(nint buffer, Span<DWriteTextMetrics> objects)

Parameters

Type	Name	Description
nint	buffer
Span<DWriteTextMetrics>	objects

NativeRequiredSize()

Declaration

public static int NativeRequiredSize()

Returns

Type	Description
int

NativeRequiredSize(int)

Declaration

public static int NativeRequiredSize(int count)

Parameters

Type	Name	Description
int	count

Returns

Type	Description
int

NativeWriteTo(nint, in DWriteTextMetrics)

Declaration

public static void NativeWriteTo(nint buffer, in DWriteTextMetrics obj)

Parameters

Type	Name	Description
nint	buffer
DWriteTextMetrics	obj

NativeWriteTo(nint, ReadOnlySpan<DWriteTextMetrics>)

Declaration

public static void NativeWriteTo(nint buffer, ReadOnlySpan<DWriteTextMetrics> objects)

Parameters

Type	Name	Description
nint	buffer
ReadOnlySpan<DWriteTextMetrics>	objects

Operators

operator ==(DWriteTextMetrics, DWriteTextMetrics)

Declaration

public static bool operator ==(DWriteTextMetrics left, DWriteTextMetrics right)

Parameters

Type	Name	Description
DWriteTextMetrics	left
DWriteTextMetrics	right

Returns

Type	Description
bool

operator !=(DWriteTextMetrics, DWriteTextMetrics)

Declaration

public static bool operator !=(DWriteTextMetrics left, DWriteTextMetrics right)

Parameters

Type	Name	Description
DWriteTextMetrics	left
DWriteTextMetrics	right

Returns

Type	Description
bool

Implements

IEquatable<T>