Struct GlyphRendererParameters

Namespace

SixLabors.Fonts.Rendering

Assembly

SixLabors.Fonts.dll

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

public readonly struct GlyphRendererParameters : IEquatable<GlyphRendererParameters>

Implements

IEquatable<GlyphRendererParameters>

Inherited Members

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

CodePoint

Gets the codepoint represented by this glyph.

public CodePoint CodePoint { get; }

Property Value

CodePoint

CompositeGlyphId

Gets the id of the composite glyph if the GlyphType is Painted;

public ushort CompositeGlyphId { get; }

Property Value

ushort

Dpi

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

public float Dpi { get; }

Property Value

float

Font

Gets the name of the Font this glyph belongs to.

public string Font { get; }

Property Value

string

FontStyle

Gets the style of the font this glyph belongs to.

public FontStyle FontStyle { get; }

Property Value

FontStyle

GlyphId

Gets the id of the glyph within the font tables.

public ushort GlyphId { get; }

Property Value

ushort

GlyphType

Gets the type of this glyph.

public GlyphType GlyphType { get; }

Property Value

GlyphType

GraphemeIndex

Gets the zero-based grapheme index in the original text.

public int GraphemeIndex { get; }

Property Value

int

LayoutMode

Gets the layout mode applied to the glyph.

public GlyphLayoutMode LayoutMode { get; }

Property Value

GlyphLayoutMode

PointSize

Gets the rendered point size.

public float PointSize { get; }

Property Value

float

TextRun

Gets the text run that this glyph belongs to.

public TextRun TextRun { get; }

Property Value

TextRun

Methods

Equals(GlyphRendererParameters)

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

public bool Equals(GlyphRendererParameters other)

Parameters

other GlyphRendererParameters

An object to compare with this object.

Returns

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.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current instance.

Returns

bool

true if obj and this instance are the same type and represent the same value; otherwise, false.

GetHashCode()

Returns the hash code for this instance.

public override int GetHashCode()

Returns

int

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

Operators

operator ==(GlyphRendererParameters, GlyphRendererParameters)

Compares two GlyphRendererParameters objects for equality.

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

Parameters

left GlyphRendererParameters

The GlyphRendererParameters on the left side of the operand.

right GlyphRendererParameters

The GlyphRendererParameters on the right side of the operand.

Returns

bool

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

operator !=(GlyphRendererParameters, GlyphRendererParameters)

Compares two GlyphRendererParameters objects for inequality.

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

Parameters

left GlyphRendererParameters

The GlyphRendererParameters on the left side of the operand.

right GlyphRendererParameters

The GlyphRendererParameters on the right side of the operand.

Returns

bool

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