HarfBuzzSharp

https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp
Admin
HarfBuzzSharp is a .NET library that provides text shaping capabilities for complex scripts, fonts,...
Tokens:7,794
Snippets:112
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### OpenTypeVarAxisInfo.MinValue Property

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.opentypevaraxisinfo.minvalue

Gets or sets the minimum value for the OpenType variable axis.

```APIDOC
## Property: MinValue

### Description
Gets or sets the minimum value for this axis.

### Signature
`public float MinValue { get; set; }`

### Property Value
- **Type**: Single (float)
- **Description**: The minimum axis value.
```

--------------------------------

### OpenTypeMathGlyphPart.Glyph Property

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.opentypemathglyphpart.glyph

Gets or sets the glyph identifier for this part.

```APIDOC
## Property: Glyph

### Description
Gets or sets the glyph identifier for this part.

### Signature
`public uint Glyph { get; set; }`

### Property Value
- **Type**: UInt32
- **Description**: The glyph identifier.
```

--------------------------------

### OpenTypeMathGlyphVariant.Glyph Property

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.opentypemathglyphvariant.glyph

Gets or sets the glyph index of the variant.

```APIDOC
## OpenTypeMathGlyphVariant.Glyph Property

### Description
Gets or sets the glyph index of the variant.

### Property Value
- **Type**: UInt32
- **Description**: The glyph index.
```

--------------------------------

### Initialize HBColor from 32-bit value

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.hbcolor.-ctor

Creates an HBColor instance using a raw 32-bit BGRA value.

```C#
public HBColor(uint value);
```

--------------------------------

### Initialize HBColor from RGBA channels

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.hbcolor.-ctor

Creates an HBColor instance using individual byte values for red, green, blue, and alpha channels.

```C#
public HBColor(byte red, byte green, byte blue, byte alpha);
```

--------------------------------

### HBColor(UInt32)

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.hbcolor.-ctor

Initializes a new instance of the HBColor struct from a raw 32-bit BGRA value.

```APIDOC
## HBColor(UInt32)

### Description
Initializes a new instance of the HBColor struct from a raw 32-bit BGRA value.

### Signature
`public HBColor(uint value);`

### Parameters
- **value** (UInt32) - Required - The raw packed BGRA value to store.
```

--------------------------------

### HBColor(Byte, Byte, Byte, Byte)

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.hbcolor.-ctor

Initializes a new instance of the HBColor struct from individual RGBA channel values.

```APIDOC
## HBColor(Byte, Byte, Byte, Byte)

### Description
Initializes a new instance of the HBColor struct from individual RGBA channel values.

### Signature
`public HBColor(byte red, byte green, byte blue, byte alpha);`

### Parameters
- **red** (Byte) - Required - The red channel value (0–255).
- **green** (Byte) - Required - The green channel value (0–255).
- **blue** (Byte) - Required - The blue channel value (0–255).
- **alpha** (Byte) - Required - The alpha channel value (0–255), where 0 is fully transparent and 255 is fully opaque.
```

--------------------------------

### PlatformConfiguration Class Definition

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.internals.platformconfiguration

The static class definition for PlatformConfiguration within the HarfBuzzSharp.Internals namespace.

```csharp
public static class PlatformConfiguration
```

--------------------------------

### TryCompose(UInt32, UInt32, UInt32)

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.unicodefunctions.trycompose

Attempts to compose two UInt32 Unicode code points into a single code point.

```APIDOC
## TryCompose(uint a, uint b, out uint ab)

### Description
Attempts to compose two Unicode code points represented as UInt32 values into a single code point.

### Parameters
- **a** (UInt32) - The first Unicode code point to compose.
- **b** (UInt32) - The second Unicode code point to compose.
- **ab** (UInt32) - When this method returns, contains the composed Unicode code point if successful.

### Returns
- **Boolean** - true if the code points were successfully composed; otherwise, false.
```

--------------------------------

### Compare GlyphInfo instances

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.glyphinfo.equals

Determines whether the specified GlyphInfo is equal to the current instance.

```C#
public readonly bool Equals(HarfBuzzSharp.GlyphInfo obj);
```

--------------------------------

### TryCompose Method Overloads

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.unicodefunctions.trycompose

Use these methods to attempt composition of two Unicode code points. The 'ab' parameter will contain the result if the operation returns true.

```C#
public bool TryCompose(int a, int b, out int ab);
```

```C#
public bool TryCompose(uint a, uint b, out uint ab);
```

--------------------------------

### TryCompose(Int32, Int32, Int32)

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.unicodefunctions.trycompose

Attempts to compose two Int32 Unicode code points into a single code point.

```APIDOC
## TryCompose(int a, int b, out int ab)

### Description
Attempts to compose two Unicode code points represented as Int32 values into a single code point.

### Parameters
- **a** (Int32) - The first Unicode code point to compose.
- **b** (Int32) - The second Unicode code point to compose.
- **ab** (Int32) - When this method returns, contains the composed Unicode code point if successful.

### Returns
- **Boolean** - true if the code points were successfully composed; otherwise, false.
```

--------------------------------

### Compare Tag instances

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.tag.equals

Determines whether the specified Tag is equal to the current instance.

```C#
public bool Equals(HarfBuzzSharp.Tag other);
```

--------------------------------

### Script.ToString Method Definition

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.script.tostring

The method signature for converting a Script instance to its string representation.

```C#
public override string ToString();
```

--------------------------------

### FontExtentsDelegate

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.fontextentsdelegate

The delegate signature for handling font extents retrieval in HarfBuzzSharp.

```APIDOC
## FontExtentsDelegate

### Description
The delegate that is invoked when TryGetHorizontalFontExtents(FontExtents) or TryGetVerticalFontExtents(FontExtents) is invoked.

### Signature
`public delegate bool FontExtentsDelegate(Font font, object fontData, out FontExtents extents);`

### Parameters
- **font** (Font) - The font.
- **fontData** (Object) - The additional data passed to SetFontFunctions(FontFunctions, Object, ReleaseDelegate) when the functions were set.
- **extents** (FontExtents) - The font extents.

### Return Value
- **Boolean** - Returns true if the Font has extents; otherwise, false.
```

--------------------------------

### Define ScriptDelegate

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.scriptdelegate

The signature for the callback delegate used to query the script of a Unicode code point.

```csharp
public delegate HarfBuzzSharp.Script ScriptDelegate(UnicodeFunctions ufuncs, uint unicode);
```

--------------------------------

### Retrieve IsWindows property

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.internals.platformconfiguration.iswindows

Access the static IsWindows property to determine if the host environment is Windows.

```csharp
public static bool IsWindows { get; }
```

--------------------------------

### CombiningClassDelegate

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.combiningclassdelegate

A callback delegate used to retrieve the canonical combining class of a Unicode code point.

```APIDOC
## CombiningClassDelegate

### Definition
`public delegate HarfBuzzSharp.UnicodeCombiningClass CombiningClassDelegate(UnicodeFunctions ufuncs, uint unicode);`

### Description
A callback delegate used to retrieve the canonical combining class of a Unicode code point.

### Parameters
- **ufuncs** (UnicodeFunctions) - The UnicodeFunctions instance invoking this callback.
- **unicode** (UInt32) - The Unicode code point to query.

### Return Value
- **UnicodeCombiningClass** - The UnicodeCombiningClass for the specified code point.
```

--------------------------------

### MirroringDelegate Delegate Definition

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.mirroringdelegate

The signature and parameter details for the MirroringDelegate callback.

```APIDOC
## public delegate uint MirroringDelegate(UnicodeFunctions ufuncs, uint unicode);

### Description
A callback delegate used to retrieve the mirrored glyph of a Unicode code point for bidirectional text rendering.

### Parameters
- **ufuncs** (UnicodeFunctions) - The UnicodeFunctions instance invoking this callback.
- **unicode** (UInt32) - The Unicode code point to query.

### Return Value
- **UInt32** - The mirrored Unicode code point, or the original code point if no mirroring is defined.
```

--------------------------------

### public override string ToString()

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.script.tostring

Returns a string representation of the value of this instance of the Script.

```APIDOC
## public override string ToString()

### Description
Returns a string representation of the value of this instance of the Script.

### Returns
- **String** - A string representation of the Script instance.
```

--------------------------------

### Compare object to GlyphInfo

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.glyphinfo.equals

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

```C#
public override readonly bool Equals(object obj);
```

--------------------------------

### GetTableDelegate Definition

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.gettabledelegate

The delegate signature for retrieving a font table blob.

```C#
public delegate HarfBuzzSharp.Blob GetTableDelegate(Face face, Tag tag);
```

--------------------------------

### Compare Tag with object

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.tag.equals

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

```C#
public override bool Equals(object obj);
```

--------------------------------

### Accessing the Default Language Property

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.language.default

Retrieves the default language instance for the current locale.

```C#
public static HarfBuzzSharp.Language Default { get; }
```

--------------------------------

### Equals(GlyphInfo)

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.glyphinfo.equals

Determines whether the specified GlyphInfo is equal to this instance.

```APIDOC
## Equals(HarfBuzzSharp.GlyphInfo)

### Description
Determines whether the specified GlyphInfo is equal to this instance.

### Signature
`public readonly bool Equals(HarfBuzzSharp.GlyphInfo obj);`

### Parameters
- **obj** (GlyphInfo) - The GlyphInfo to compare with.

### Returns
- **Boolean** - Returns true if the specified GlyphInfo is equal to this instance; otherwise, false.
```

--------------------------------

### SetHorizontalGlyphOriginDelegate Method Definition

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.fontfunctions.sethorizontalglyphorigindelegate

Defines the signature for setting the horizontal glyph origin callback, including an optional release delegate.

```C#
public void SetHorizontalGlyphOriginDelegate(HarfBuzzSharp.GlyphOriginDelegate del, HarfBuzzSharp.ReleaseDelegate destroy = default);
```

--------------------------------

### SetHorizontalGlyphOriginDelegate

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.fontfunctions.sethorizontalglyphorigindelegate

Sets the callback for retrieving the origin point for horizontal glyph layout.

```APIDOC
## SetHorizontalGlyphOriginDelegate

### Description
Sets the callback for retrieving the origin point for horizontal glyph layout.

### Signature
`public void SetHorizontalGlyphOriginDelegate(HarfBuzzSharp.GlyphOriginDelegate del, HarfBuzzSharp.ReleaseDelegate destroy = default);`

### Parameters
- **del** (HarfBuzzSharp.GlyphOriginDelegate) - Required - The delegate to set for retrieving horizontal glyph origins.
- **destroy** (HarfBuzzSharp.ReleaseDelegate) - Optional - The delegate to call when the callback is replaced or destroyed, or null.
```

--------------------------------

### Define GlyphKerningDelegate

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.glyphkerningdelegate

The delegate signature for retrieving kerning adjustments between two glyphs.

```csharp
public delegate int GlyphKerningDelegate(Font font, object fontData, uint firstGlyph, uint secondGlyph);
```

--------------------------------

### Equals(Tag)

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.tag.equals

Determines whether the specified Tag is equal to this instance.

```APIDOC
## Equals(HarfBuzzSharp.Tag other)

### Description
Determines whether the specified Tag is equal to this instance.

### Signature
`public bool Equals(HarfBuzzSharp.Tag other);`

### Parameters
- **other** (Tag) - The Tag to compare with.

### Returns
- **Boolean** - Returns true if the specified Tag is equal to this instance; otherwise, false.
```

--------------------------------

### GlyphKerningDelegate

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.glyphkerningdelegate

A delegate definition for retrieving kerning adjustments between two glyphs.

```APIDOC
## GlyphKerningDelegate

### Description
Represents a callback method that retrieves the horizontal kerning adjustment between two glyphs.

### Signature
`public delegate int GlyphKerningDelegate(Font font, object fontData, uint firstGlyph, uint secondGlyph);`

### Parameters
- **font** (Font) - The font being queried.
- **fontData** (Object) - User-supplied font data.
- **firstGlyph** (UInt32) - The first glyph in the pair.
- **secondGlyph** (UInt32) - The second glyph in the pair.

### Return Value
- **Int32** - The horizontal kerning adjustment in font units.
```

--------------------------------

### Define GlyphOriginDelegate

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.glyphorigindelegate

The delegate signature for retrieving glyph origin coordinates in font units.

```csharp
public delegate bool GlyphOriginDelegate(Font font, object fontData, uint glyph, out int x, out int y);
```

--------------------------------

### Equals(Object)

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.glyphinfo.equals

Determines whether the specified object is equal to this instance.

```APIDOC
## Equals(object)

### Description
Determines whether the specified object is equal to this instance.

### Signature
`public override readonly bool Equals(object obj);`

### Parameters
- **obj** (Object) - The object to compare with.

### Returns
- **Boolean** - Returns true if the specified object is equal to this instance; otherwise, false.
```

--------------------------------

### Define GlyphAdvanceDelegate

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.glyphadvancedelegate

The delegate signature for handling glyph advance calculations in HarfBuzzSharp.

```C#
public delegate int GlyphAdvanceDelegate(Font font, object fontData, uint glyph);
```

--------------------------------

### public override int GetHashCode()

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.glyphextents.gethashcode

Returns the hash code for the current GlyphExtents instance.

```APIDOC
## public override int GetHashCode()

### Description
Returns the hash code for this instance.

### Signature
`public override readonly int GetHashCode();`

### Returns
- **Int32** - A 32-bit signed integer hash code.
```

--------------------------------

### CombiningClassDelegate Definition

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.combiningclassdelegate

The delegate signature for retrieving the Unicode combining class of a specific code point.

```C#
public delegate HarfBuzzSharp.UnicodeCombiningClass CombiningClassDelegate(UnicodeFunctions ufuncs, uint unicode);
```

--------------------------------

### GetHashCode Method Definition

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.glyphextents.gethashcode

The method signature for retrieving the hash code of a GlyphExtents instance.

```csharp
public override readonly int GetHashCode();
```

--------------------------------

### NominalGlyphsDelegate

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.nominalglyphsdelegate

A callback delegate used to map multiple Unicode code points to their nominal glyph identifiers in a single batch operation.

```APIDOC
## NominalGlyphsDelegate

### Signature
`public delegate uint NominalGlyphsDelegate(Font font, object fontData, uint count, ReadOnlySpan<uint> codepoints, Span<uint> glyphs);`

### Description
A callback delegate used to map multiple Unicode code points to their nominal glyph identifiers in a single batch operation.

### Parameters
- **font** (Font) - The Font instance invoking this callback.
- **fontData** (Object) - The user-specified font data associated with the font.
- **count** (UInt32) - The number of code points to map.
- **codepoints** (ReadOnlySpan<UInt32>) - A read-only span of Unicode code points to map to glyphs.
- **glyphs** (Span<UInt32>) - A span to receive the resulting glyph identifiers.

### Return Value
- **UInt32** - The number of code points successfully mapped to glyphs.
```

--------------------------------

### GetTableDelegate Delegate

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.gettabledelegate

Represents a callback method that retrieves a font table blob.

```APIDOC
## GetTableDelegate Delegate

### Definition
Represents a callback method that retrieves a font table blob.

### Signature
`public delegate HarfBuzzSharp.Blob GetTableDelegate(Face face, Tag tag);`

### Parameters
- **face** (Face) - The font face being queried.
- **tag** (Tag) - The table tag to retrieve.

### Return Value
- **Blob** - A Blob containing the table data, or null if not found.
```

--------------------------------

### Define GeneralCategoryDelegate

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.generalcategorydelegate

The delegate signature for retrieving the UnicodeGeneralCategory of a specific code point.

```C#
public delegate HarfBuzzSharp.UnicodeGeneralCategory GeneralCategoryDelegate(UnicodeFunctions ufuncs, uint unicode);
```

--------------------------------

### Define GlyphFromNameDelegate

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.glyphfromnamedelegate

The delegate signature for retrieving a glyph identifier from a glyph name.

```C#
public delegate bool GlyphFromNameDelegate(Font font, object fontData, string name, out uint glyph);
```

--------------------------------

### Accessing the Glyph property in C#

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.opentypecolorlayer.glyph

Defines the property signature for retrieving or assigning the glyph index as a 32-bit unsigned integer.

```C#
public uint Glyph { get; set; }
```

--------------------------------

### Accessing the Tag property

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.opentypevaraxis.tag

Retrieves or sets the four-character identifier for the OpenType variable axis.

```C#
public uint Tag { get; set; }
```

--------------------------------

### GlyphNameDelegate

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.glyphnamedelegate

A callback delegate used to retrieve the name of a glyph.

```APIDOC
## GlyphNameDelegate

### Definition
`public delegate bool GlyphNameDelegate(Font font, object fontData, uint glyph, out string name);`

### Parameters
- **font** (Font) - The Font instance invoking this callback.
- **fontData** (Object) - The user-specified font data associated with the font.
- **glyph** (UInt32) - The glyph identifier to query.
- **name** (String) - When this method returns, contains the name of the glyph.

### Return Value
- **Boolean** - `true` if the glyph name was found; otherwise, `false`.
```

--------------------------------

### GlyphExtentsDelegate Definition

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.glyphextentsdelegate

The delegate signature for retrieving glyph extents, requiring a font, user data, glyph ID, and an output parameter for the extents.

```C#
public delegate bool GlyphExtentsDelegate(Font font, object fontData, uint glyph, out GlyphExtents extents);
```

--------------------------------

### GlyphExtentsDelegate

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.glyphextentsdelegate

Represents a callback method that retrieves the extents (bounding box) of a glyph.

```APIDOC
## GlyphExtentsDelegate

### Description
Represents a callback method that retrieves the extents (bounding box) of a glyph.

### Signature
`public delegate bool GlyphExtentsDelegate(Font font, object fontData, uint glyph, out GlyphExtents extents);`

### Parameters
- **font** (Font) - The font being queried.
- **fontData** (Object) - User-supplied font data.
- **glyph** (UInt32) - The glyph identifier.
- **extents** (GlyphExtents) - When this method returns, contains the glyph extents.

### Return Value
- **Boolean** - `true` if the extents were found; otherwise, `false`.
```

--------------------------------

### VariationGlyphDelegate Definition

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.variationglyphdelegate

The delegate signature for mapping Unicode code points with variation selectors to glyph identifiers.

```csharp
public delegate bool VariationGlyphDelegate(Font font, object fontData, uint unicode, uint variationSelector, out uint glyph);
```

--------------------------------

### Define OpenTypeMathGlyphPartFlags

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.opentypemathglyphpartflags

The enumeration definition for OpenType math glyph part flags.

```csharp
public enum OpenTypeMathGlyphPartFlags
```

--------------------------------

### Define MirroringDelegate in C#

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.mirroringdelegate

The delegate signature for retrieving a mirrored Unicode code point.

```C#
public delegate uint MirroringDelegate(UnicodeFunctions ufuncs, uint unicode);
```

--------------------------------

### FontExtentsDelegate Definition

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.fontextentsdelegate

The delegate signature for handling font extents retrieval.

```C#
public delegate bool FontExtentsDelegate(Font font, object fontData, out FontExtents extents);
```

--------------------------------

### operator ==(GlyphPosition, GlyphPosition)

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.glyphposition.op_equality

Determines whether two specified GlyphPosition objects are equal.

```APIDOC
## operator ==(HarfBuzzSharp.GlyphPosition, HarfBuzzSharp.GlyphPosition)

### Description
Determines whether two specified GlyphPosition objects are equal.

### Signature
`public static bool operator ==(HarfBuzzSharp.GlyphPosition left, HarfBuzzSharp.GlyphPosition right);`

### Parameters
- **left** (GlyphPosition) - The first GlyphPosition to compare.
- **right** (GlyphPosition) - The second GlyphPosition to compare.

### Returns
- **Boolean** - Returns true if the two GlyphPosition objects are equal; otherwise, false.
```

--------------------------------

### ScriptDelegate Delegate Definition

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.scriptdelegate

The signature for the ScriptDelegate callback used to query the script of a specific Unicode code point.

```APIDOC
## ScriptDelegate Delegate

### Definition
`public delegate HarfBuzzSharp.Script ScriptDelegate(UnicodeFunctions ufuncs, uint unicode);`

### Description
A callback delegate used to retrieve the script of a Unicode code point.

### Parameters
- **ufuncs** (UnicodeFunctions) - The UnicodeFunctions instance invoking this callback.
- **unicode** (UInt32) - The Unicode code point to query.

### Return Value
- **Script** - The Script for the specified code point.
```

--------------------------------

### GlyphNameDelegate Definition

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.glyphnamedelegate

The delegate signature used for retrieving glyph names in HarfBuzzSharp.

```csharp
public delegate bool GlyphNameDelegate(Font font, object fontData, uint glyph, out string name);
```

--------------------------------

### Language.Default Property

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.language.default

Retrieves the default language based on the current locale.

```APIDOC
## Language.Default Property

### Description
Gets the default language based on the current locale.

### Signature
`public static HarfBuzzSharp.Language Default { get; }`

### Property Value
- **Language** - The default language.
```

--------------------------------

### GlyphOriginDelegate

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.glyphorigindelegate

A callback delegate used to retrieve the origin coordinates of a glyph for horizontal or vertical layout.

```APIDOC
## GlyphOriginDelegate

### Description
A callback delegate used to retrieve the origin coordinates of a glyph for horizontal or vertical layout.

### Signature
`public delegate bool GlyphOriginDelegate(Font font, object fontData, uint glyph, out int x, out int y);`

### Parameters
- **font** (Font) - The Font instance invoking this callback.
- **fontData** (Object) - The user-specified font data associated with the font.
- **glyph** (UInt32) - The glyph identifier to query.
- **x** (Int32) - When this method returns, contains the X coordinate of the glyph origin in font units.
- **y** (Int32) - When this method returns, contains the Y coordinate of the glyph origin in font units.

### Return Value
- **Boolean** - `true` if the origin was found; otherwise, `false`.
```

--------------------------------

### Define GlyphContourPointDelegate

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.glyphcontourpointdelegate

The delegate signature for retrieving contour point coordinates from a font.

```csharp
public delegate bool GlyphContourPointDelegate(Font font, object fontData, uint glyph, uint pointIndex, out int x, out int y);
```

--------------------------------

### DisposeHandler Method Definition

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.nativeobject.disposehandler

The method signature for releasing unmanaged resources in HarfBuzzSharp.

```csharp
protected virtual void DisposeHandler();
```

--------------------------------

### Define GlyphAdvancesDelegate in C#

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.glyphadvancesdelegate

The delegate signature for retrieving glyph advances in a batch operation.

```C#
public delegate void GlyphAdvancesDelegate(Font font, object fontData, uint count, ReadOnlySpan<uint> glyphs, Span<int> advances);
```

--------------------------------

### Compare GlyphPosition equality in C#

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.glyphposition.op_equality

Use this operator to determine if two GlyphPosition instances are equal.

```C#
public static bool operator ==(HarfBuzzSharp.GlyphPosition left, HarfBuzzSharp.GlyphPosition right);
```

--------------------------------

### Define OpenTypeLayoutBaselineTag Enum

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.opentypelayoutbaselinetag

The base definition for the OpenTypeLayoutBaselineTag enumeration.

```C#
public enum OpenTypeLayoutBaselineTag
```

--------------------------------

### Define UnicodeCombiningClass Enum

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.unicodecombiningclass

The base definition for the UnicodeCombiningClass enumeration within the HarfBuzzSharp namespace.

```csharp
public enum UnicodeCombiningClass
```

--------------------------------

### NominalGlyphDelegate

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.nominalglyphdelegate

A callback delegate used to retrieve the nominal glyph identifier for a Unicode code point.

```APIDOC
## public delegate bool NominalGlyphDelegate(Font font, object fontData, uint unicode, out uint glyph);

### Description
A callback delegate used to retrieve the nominal glyph identifier for a Unicode code point.

### Parameters
- **font** (Font) - The Font instance invoking this callback.
- **fontData** (Object) - The user-specified font data associated with the font.
- **unicode** (UInt32) - The Unicode code point to map.
- **glyph** (UInt32) - When this method returns, contains the glyph identifier for the code point.

### Return Value
- **Boolean** - true if a glyph was found for the code point; otherwise, false.
```

--------------------------------

### Define NominalGlyphsDelegate

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.nominalglyphsdelegate

The delegate signature for mapping multiple Unicode code points to glyph identifiers in a single operation.

```C#
public delegate uint NominalGlyphsDelegate(Font font, object fontData, uint count, ReadOnlySpan<uint> codepoints, Span<uint> glyphs);
```

--------------------------------

### Define Feature.Value Property

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.feature.value

Represents the property definition for the feature value in C#.

```C#
public uint Value { get; set; }
```

--------------------------------

### Accessing the UnicodeFunctions property

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.buffer.unicodefunctions

Defines the UnicodeFunctions property within the HarfBuzzSharp namespace.

```C#
public HarfBuzzSharp.UnicodeFunctions UnicodeFunctions { get; set; }
```

--------------------------------

### Define ReleaseDelegate in C#

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.releasedelegate

The signature for the ReleaseDelegate, which takes no parameters and returns no value.

```C#
public delegate void ReleaseDelegate();
```

--------------------------------

### Access the Language property in C#

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.opentypenameentry.language

Defines the Language property as an IntPtr within the HarfBuzzSharp namespace.

```csharp
public IntPtr Language { get; set; }
```

--------------------------------

### VariationGlyphDelegate

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.variationglyphdelegate

A callback delegate used to retrieve the glyph identifier for a Unicode code point with a specific variation selector.

```APIDOC
## VariationGlyphDelegate

### Definition
`public delegate bool VariationGlyphDelegate(Font font, object fontData, uint unicode, uint variationSelector, out uint glyph);`

### Parameters
- **font** (Font) - The Font instance invoking this callback.
- **fontData** (object) - The user-specified font data associated with the font.
- **unicode** (uint) - The Unicode code point to map.
- **variationSelector** (uint) - The Unicode variation selector code point.
- **glyph** (uint) - When this method returns, contains the glyph identifier for the variation.

### Return Value
- **Boolean** - `true` if a variation glyph was found; otherwise, `false`.
```

--------------------------------

### GlyphContourPointDelegate

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.glyphcontourpointdelegate

A callback delegate used to retrieve the coordinates of a specific contour point within a glyph outline.

```APIDOC
## GlyphContourPointDelegate

### Signature
`public delegate bool GlyphContourPointDelegate(Font font, object fontData, uint glyph, uint pointIndex, out int x, out int y);`

### Description
A callback delegate used to retrieve the coordinates of a specific contour point within a glyph outline.

### Parameters
- **font** (Font) - The Font instance invoking this callback.
- **fontData** (object) - The user-specified font data associated with the font.
- **glyph** (uint) - The glyph identifier to query.
- **pointIndex** (uint) - The zero-based index of the contour point to retrieve.
- **x** (out int) - When this method returns, contains the X coordinate of the contour point in font units.
- **y** (out int) - When this method returns, contains the Y coordinate of the contour point in font units.

### Return Value
- **bool** - `true` if the contour point was found; otherwise, `false`.
```

--------------------------------

### GlyphFromNameDelegate

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.glyphfromnamedelegate

Represents a callback method that retrieves a glyph identifier from a glyph name.

```APIDOC
## GlyphFromNameDelegate

### Description
Represents a callback method that retrieves a glyph identifier from a glyph name.

### Signature
`public delegate bool GlyphFromNameDelegate(Font font, object fontData, string name, out uint glyph);`

### Parameters
- **font** (Font) - The font being queried.
- **fontData** (Object) - User-supplied font data.
- **name** (String) - The glyph name to look up.
- **glyph** (UInt32) - When this method returns, contains the glyph identifier if found.

### Return Value
- **Boolean** - `true` if the glyph was found; otherwise, `false`.
```

--------------------------------

### Blob.MakeImmutable()

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.blob.makeimmutable

Makes the blob immutable.

```APIDOC
## public void MakeImmutable()

### Description
Makes the blob immutable.

### Method
void MakeImmutable()

### Namespace
HarfBuzzSharp
```

--------------------------------

### ComposeDelegate Delegate Definition

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.composedelegate

A callback delegate used to compose two Unicode code points into a single code point using Unicode canonical composition.

```APIDOC
## public delegate bool ComposeDelegate(UnicodeFunctions ufuncs, uint a, uint b, out uint ab)

### Description
A callback delegate used to compose two Unicode code points into a single code point using Unicode canonical composition.

### Parameters
- **ufuncs** (UnicodeFunctions) - The UnicodeFunctions instance invoking this callback.
- **a** (UInt32) - The first Unicode code point to compose.
- **b** (UInt32) - The second Unicode code point to compose.
- **ab** (UInt32) - When this method returns, contains the composed Unicode code point.

### Return Value
- **Boolean** - true if the code points were successfully composed; otherwise, false.
```

--------------------------------

### Define SerializeFormat Enum

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.serializeformat

The definition of the SerializeFormat enumeration.

```C#
public enum SerializeFormat
```

--------------------------------

### Define OpenTypeMathKern Enum

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.opentypemathkern

The enumeration definition for specifying math kerning positions.

```C#
public enum OpenTypeMathKern
```

--------------------------------

### Define NominalGlyphDelegate

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.nominalglyphdelegate

The delegate signature for mapping a Unicode code point to a glyph identifier.

```C#
public delegate bool NominalGlyphDelegate(Font font, object fontData, uint unicode, out uint glyph);
```

--------------------------------

### MakeImmutable Method Definition

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.blob.makeimmutable

The method signature for making a blob immutable.

```C#
public void MakeImmutable();
```

--------------------------------

### Accessing the MinValue property

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.opentypevaraxisinfo.minvalue

Defines the MinValue property as a single-precision floating-point value.

```C#
public float MinValue { get; set; }
```

--------------------------------

### Define OpenTypeColorPaletteFlags

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.opentypecolorpaletteflags

The enumeration definition for OpenType color palette flags.

```C#
public enum OpenTypeColorPaletteFlags
```

--------------------------------

### GlyphAdvanceDelegate

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.glyphadvancedelegate

The delegate that is invoked when GetHorizontalGlyphAdvance(UInt32) or GetVerticalGlyphAdvance(UInt32) is invoked.

```APIDOC
## GlyphAdvanceDelegate

### Definition
`public delegate int GlyphAdvanceDelegate(Font font, object fontData, uint glyph);`

### Parameters
- **font** (Font) - The font.
- **fontData** (Object) - The additional data passed to SetFontFunctions(FontFunctions, Object, ReleaseDelegate) when the functions were set.
- **glyph** (UInt32) - The glyph.

### Return Value
- **Int32** - Returns the advance amount.
```

--------------------------------

### Define OpenTypeLayoutGlyphClass

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.opentypelayoutglyphclass

The enumeration definition for OpenType layout glyph classifications.

```C#
public enum OpenTypeLayoutGlyphClass
```

--------------------------------

### Define ComposeDelegate

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.composedelegate

The delegate signature for composing two Unicode code points.

```C#
public delegate bool ComposeDelegate(UnicodeFunctions ufuncs, uint a, uint b, out uint ab);
```

--------------------------------

### Define BufferDiffFlags Enum

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.bufferdiffflags

The base definition for the BufferDiffFlags enumeration in C#.

```C#
public enum BufferDiffFlags
```

--------------------------------

### Define OpenTypeMetaTag Enum

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.opentypemetatag

Represents the enumeration structure for OpenType meta table tags.

```csharp
public enum OpenTypeMetaTag
```

--------------------------------

### Define OpenTypeMathConstant Enum

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.opentypemathconstant

The base definition for the OpenTypeMathConstant enumeration.

```C#
public enum OpenTypeMathConstant
```

--------------------------------

### OpenTypeVarAxisFlags Definition

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.opentypevaraxisflags

The definition of the OpenTypeVarAxisFlags enumeration.

```C#
public enum OpenTypeVarAxisFlags
```

--------------------------------

### Define GlyphFlags Enum

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.glyphflags

The enumeration is decorated with the FlagsAttribute to support bitwise operations.

```csharp
[System.Flags]
public enum GlyphFlags
```

--------------------------------

### Define ClusterLevel Enum

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.clusterlevel

The base definition for the ClusterLevel enumeration.

```C#
public enum ClusterLevel
```

--------------------------------

### public static bool operator !=(HarfBuzzSharp.Variation left, HarfBuzzSharp.Variation right)

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.variation.op_inequality

Determines whether two specified Variation objects are not equal.

```APIDOC
## public static bool operator !=(HarfBuzzSharp.Variation left, HarfBuzzSharp.Variation right)

### Description
Determines whether two specified Variation objects are not equal.

### Parameters
- **left** (Variation) - The first Variation to compare.
- **right** (Variation) - The second Variation to compare.

### Returns
- **Boolean** - Returns true if the two Variation objects are not equal; otherwise, false.
```

--------------------------------

### GetYVariation Method Definition

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.opentypemetrics.getyvariation

Retrieves the vertical variation value for a specified OpenType metrics tag.

```csharp
public int GetYVariation(HarfBuzzSharp.OpenTypeMetricsTag metricsTag);
```

--------------------------------

### FontExtents.Inequality(FontExtents, FontExtents) Operator

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.fontextents.op_inequality

Determines whether two specified FontExtents objects are not equal.

```APIDOC
## public static bool operator !=(HarfBuzzSharp.FontExtents left, HarfBuzzSharp.FontExtents right)

### Description
Determines whether two specified FontExtents objects are not equal.

### Parameters
- **left** (FontExtents) - The first FontExtents to compare.
- **right** (FontExtents) - The second FontExtents to compare.

### Returns
- **Boolean** - Returns true if the two FontExtents objects are not equal; otherwise, false.
```

--------------------------------

### OpenTypeMetrics.GetYVariation(OpenTypeMetricsTag)

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.opentypemetrics.getyvariation

Retrieves the vertical variation value for the specified metrics tag.

```APIDOC
## public int GetYVariation(HarfBuzzSharp.OpenTypeMetricsTag metricsTag)

### Description
Gets the vertical variation value for the specified metrics tag.

### Parameters
- **metricsTag** (OpenTypeMetricsTag) - The metrics tag to query.

### Returns
- **Int32** - The vertical variation value in font units.
```

--------------------------------

### Define OpenTypeMetricsTag Enum

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.opentypemetricstag

The base definition for the OpenTypeMetricsTag enumeration.

```C#
public enum OpenTypeMetricsTag
```

--------------------------------

### Define UnicodeGeneralCategory Enum

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.unicodegeneralcategory

Represents the definition of the UnicodeGeneralCategory enumeration.

```C#
public enum UnicodeGeneralCategory
```

--------------------------------

### Define SerializeFlag Enum

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.serializeflag

The SerializeFlag enumeration is decorated with the FlagsAttribute to support bitwise combinations of its members.

```csharp
[System.Flags]
public enum SerializeFlag
```

--------------------------------

### Define ContentType Enum

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.contenttype

The enumeration used to represent the various types of buffer contents in HarfBuzzSharp.

```C#
public enum ContentType
```

--------------------------------

### Define OpenTypeNameId Enum

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.opentypenameid

The definition of the OpenTypeNameId enumeration within the HarfBuzzSharp namespace.

```csharp
public enum OpenTypeNameId
```

--------------------------------

### Inequality Operator Definition

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.fontextents.op_inequality

Defines the inequality operator for comparing two FontExtents objects.

```csharp
public static bool operator !=(HarfBuzzSharp.FontExtents left, HarfBuzzSharp.FontExtents right);
```

--------------------------------

### Define Direction Enum

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.direction

The Direction enumeration used to specify text flow orientation.

```C#
public enum Direction
```

--------------------------------

### DecomposeDelegate Definition

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.decomposedelegate

The delegate signature for decomposing a Unicode code point into two parts.

```C#
public delegate bool DecomposeDelegate(UnicodeFunctions ufuncs, uint ab, out uint a, out uint b);
```

--------------------------------

### Inequality Operator Definition

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.variation.op_inequality

Defines the inequality operator for the Variation class to determine if two instances are not equal.

```C#
public static bool operator !=(HarfBuzzSharp.Variation left, HarfBuzzSharp.Variation right);
```

--------------------------------

### Define MemoryMode Enum

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.memorymode

The MemoryMode enumeration defines the memory handling strategy for HarfBuzz blobs.

```csharp
public enum MemoryMode
```

--------------------------------

### VariationAxisInfos Property Definition

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.face.variationaxisinfos

Accesses the array of variation axis information for the font face.

```C#
public HarfBuzzSharp.OpenTypeVarAxisInfo[] VariationAxisInfos { get; }
```

--------------------------------

### Define BufferFlags Enum in C#

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.bufferflags

The BufferFlags enumeration is decorated with the FlagsAttribute to support bitwise combinations of its members.

```C#
[System.Flags]
public enum BufferFlags
```

--------------------------------

### VariationCoordsNormalized Property Definition

Source: https://learn.microsoft.com/en-us/dotnet/api/harfbuzzsharp.font.variationcoordsnormalized

Retrieves the current normalized variation coordinates for the font as an array of integers.

```csharp
public int[] VariationCoordsNormalized { get; }
```
Tokens:
Raw