Meziantou.Framework

ShapingFeature Struct

Namespace
Meziantou.Framework.Fonts
Assembly
Meziantou.Framework.Fonts.dll
Package
Meziantou.Framework.Fonts 1.0.9
Source
ShapingFeature.cs
Available in package assets
net10.0net11.0

A feature of the OpenType Layout tables to apply to a run, with its value: 0 turns it off, 1 turns it on, a larger value selects an alternate. A feature applies to the whole run, or to the characters of a range.

public readonly struct ShapingFeature : IEquatable<ShapingFeature>
Implements

Constructors

NameDescription
ShapingFeature(string, int)Initializes a feature for the whole run from the four characters of its tag.
ShapingFeature(uint, int, int, int)A feature of the OpenType Layout tables to apply to a run, with its value: 0 turns it off, 1 turns it on, a larger value selects an alternate. A feature applies to the whole run, or to the characters of a range.

ShapingFeature overloads

ShapingFeature(string, int)

ShapingFeature.cs

Initializes a feature for the whole run from the four characters of its tag.

public ShapingFeature(string tag, int value = 1)
Parameters
tag string
The four characters of the tag, such as liga.
value int
The value of the feature.

ShapingFeature(uint, int, int, int)

A feature of the OpenType Layout tables to apply to a run, with its value: 0 turns it off, 1 turns it on, a larger value selects an alternate. A feature applies to the whole run, or to the characters of a range.

public ShapingFeature(uint Tag, int Value, int Start = 0, int End = 2147483647)
Parameters
Tag uint
The tag of the feature.
Value int
The value of the feature.
Start int
The cluster of the first character the value is for.
End int
The cluster after the last character the value is for.

Properties

NameDescription
EndThe cluster after the last character the value is for.
IsGlobalGets a value indicating whether the value is for the whole run.
StartThe cluster of the first character the value is for.
TagThe tag of the feature.
ValueThe value of the feature.

End

ShapingFeature.cs

The cluster after the last character the value is for.

public int End { get; init; }

Property value

int

IsGlobal

ShapingFeature.cs

Gets a value indicating whether the value is for the whole run.

public bool IsGlobal { get; }

Property value

bool

Start

ShapingFeature.cs

The cluster of the first character the value is for.

public int Start { get; init; }

Property value

int

Tag

ShapingFeature.cs

The tag of the feature.

public uint Tag { get; init; }

Property value

uint

Value

ShapingFeature.cs

The value of the feature.

public int Value { get; init; }

Property value

int

Methods

NameDescription
Deconstruct(uint, int, int, int)
Equals(ShapingFeature)
Equals(object)
GetHashCode()
ToString()
ToTag(string)Converts the four characters of a tag to its value.

Deconstruct(uint, int, int, int)

public void Deconstruct(out uint Tag, out int Value, out int Start, out int End)

Parameters

Tag uint
Value int
Start int
End int

No documentation is available.

Equals overloads

Equals(ShapingFeature)

public bool Equals(ShapingFeature other)
Parameters
other ShapingFeature
Returns

bool

No documentation is available.

Equals(object)

public override bool Equals(object obj)
Parameters
obj object
Returns

bool

No documentation is available.

GetHashCode()

public override int GetHashCode()

Returns

int

No documentation is available.

ToString()

public override string ToString()

Returns

string

No documentation is available.

ToTag(string)

ShapingFeature.cs

Converts the four characters of a tag to its value.

public static uint ToTag(string tag)

Parameters

tag string

Returns

uint

Operators

NameDescription
operator ==(ShapingFeature, ShapingFeature)
operator !=(ShapingFeature, ShapingFeature)

operator ==(ShapingFeature, ShapingFeature)

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

Parameters

left ShapingFeature
right ShapingFeature

Returns

bool

No documentation is available.

operator !=(ShapingFeature, ShapingFeature)

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

Parameters

left ShapingFeature
right ShapingFeature

Returns

bool

No documentation is available.