Struct DWriteClusterMetrics

The DWRITE_CLUSTER_METRICS structure contains information about a glyph cluster.

Implements

IEquatable<DWriteClusterMetrics>

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 DWriteClusterMetrics : IEquatable<DWriteClusterMetrics>

Properties

CanWrapLineAfter

Gets a value indicating whether the line can be broken right after the cluster.

Declaration

public bool CanWrapLineAfter { get; }

Property Value

Type	Description
bool

IsNewline

Gets a value indicating whether the cluster corresponds to a newline character.

Declaration

public bool IsNewline { get; }

Property Value

Type	Description
bool

IsRightToLeft

Gets a value indicating whether the cluster is read from right to left.

Declaration

public bool IsRightToLeft { get; }

Property Value

Type	Description
bool

IsSoftHyphen

Gets a value indicating whether the cluster corresponds to soft hyphen character.

Declaration

public bool IsSoftHyphen { get; }

Property Value

Type	Description
bool

IsWhitespace

Gets a value indicating whether the cluster corresponds to whitespace character.

Declaration

public bool IsWhitespace { get; }

Property Value

Type	Description
bool

Length

Gets the number of text positions in the cluster.

Declaration

public ushort Length { get; }

Property Value

Type	Description
ushort

Width

Gets the total advance width of all glyphs in the cluster.

Declaration

public float Width { get; }

Property Value

Type	Description
float

Methods

Equals(DWriteClusterMetrics)

Determines whether the specified object is equal to the current object.

Declaration

public bool Equals(DWriteClusterMetrics other)

Parameters

Type	Name	Description
DWriteClusterMetrics	other	The object to compare with the current object.

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The object to compare with the current object.

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Overrides

ValueType.Equals(object)

GetHashCode()

Returns the hash code for this instance.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A 32-bit signed integer that is the hash code for this instance.

Overrides

ValueType.GetHashCode()

Operators

operator ==(DWriteClusterMetrics, DWriteClusterMetrics)

Compares two DWriteClusterMetrics objects. The result specifies whether the values of the two objects are equal.

Declaration

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

Parameters

Type	Name	Description
DWriteClusterMetrics	left	The left DWriteClusterMetrics to compare.
DWriteClusterMetrics	right	The right DWriteClusterMetrics to compare.

Returns

Type	Description
bool	true if the values of left and right are equal; otherwise, false.

operator !=(DWriteClusterMetrics, DWriteClusterMetrics)

Compares two DWriteClusterMetrics objects. The result specifies whether the values of the two objects are unequal.

Declaration

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

Parameters

Type	Name	Description
DWriteClusterMetrics	left	The left DWriteClusterMetrics to compare.
DWriteClusterMetrics	right	The right DWriteClusterMetrics to compare.

Returns

Type	Description
bool	true if the values of left and right differ; otherwise, false.

Implements

IEquatable<T>