Struct GlyphRendererParameters

The combined set of properties that uniquely identify the glyph that is to be rendered at a particular size and dpi.

Implements

IEquatable<GlyphRendererParameters>

Inherited Members

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: SixLabors.Fonts

Assembly: SixLabors.Fonts.dll

Syntax

public readonly struct GlyphRendererParameters : IEquatable<GlyphRendererParameters>

Properties

CodePoint

Gets the codepoint represented by this glyph.

Declaration

public CodePoint CodePoint { get; }

Property Value

Type	Description
CodePoint

Dpi

Gets the dots-per-inch the glyph is to be rendered at.

Declaration

public float Dpi { get; }

Property Value

Type	Description
float

Font

Gets the name of the Font this glyph belongs to.

Declaration

public string Font { get; }

Property Value

Type	Description
string

FontStyle

Gets the style of the font this glyph belongs to.

Declaration

public FontStyle FontStyle { get; }

Property Value

Type	Description
FontStyle

GlyphColor

Gets the color details of this glyph.

Declaration

public GlyphColor GlyphColor { get; }

Property Value

Type	Description
GlyphColor

GlyphId

Gets the id of the glyph within the font tables.

Declaration

public ushort GlyphId { get; }

Property Value

Type	Description
ushort

GlyphType

Gets the type of this glyph.

Declaration

public GlyphType GlyphType { get; }

Property Value

Type	Description
GlyphType

LayoutMode

Gets the layout mode applied to the glyph.

Declaration

public GlyphLayoutMode LayoutMode { get; }

Property Value

Type	Description
GlyphLayoutMode

PointSize

Gets the rendered point size.

Declaration

public float PointSize { get; }

Property Value

Type	Description
float

TextRun

Gets the text run that this glyph belongs to.

Declaration

public TextRun TextRun { get; }

Property Value

Type	Description
TextRun

Methods

Equals(GlyphRendererParameters)

Indicates whether the current object is equal to another object of the same type.

Declaration

public bool Equals(GlyphRendererParameters other)

Parameters

Type	Name	Description
GlyphRendererParameters	other	An object to compare with this object.

Returns

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

Equals(object?)

Indicates whether this instance and a specified object are equal.

Declaration

public override bool Equals(object? obj)

Parameters

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

Returns

Type	Description
bool	true if obj and this instance are the same type and represent the same value; 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 ==(GlyphRendererParameters, GlyphRendererParameters)

Compares two GlyphRendererParameters objects for equality.

Declaration

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

Parameters

Type	Name	Description
GlyphRendererParameters	left	The GlyphRendererParameters on the left side of the operand.
GlyphRendererParameters	right	The GlyphRendererParameters on the right side of the operand.

Returns

Type	Description
bool	True if the current left is equal to the right parameter; otherwise, false.

operator !=(GlyphRendererParameters, GlyphRendererParameters)

Compares two GlyphRendererParameters objects for inequality.

Declaration

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

Parameters

Type	Name	Description
GlyphRendererParameters	left	The GlyphRendererParameters on the left side of the operand.
GlyphRendererParameters	right	The GlyphRendererParameters on the right side of the operand.

Returns

Type	Description
bool	True if the current left is unequal to the right parameter; otherwise, false.

Implements

IEquatable<T>