Struct FluentGlyphRangeBuilder
A fluent ImGui glyph range builder.
Assembly: Dalamud.dll
public struct FluentGlyphRangeBuilder
Methods
Clear()
Clears the builder.
public FluentGlyphRangeBuilder Clear()
Returns
Dalamud.Interface.ManagedFontAtlas.FluentGlyphRangeBuilder: this for method chaining.
Remarks
A builder is in cleared state on first use.
With(char)
Adds a single codepoint to the builder.
public FluentGlyphRangeBuilder With(char codepoint)
Returns
Dalamud.Interface.ManagedFontAtlas.FluentGlyphRangeBuilder: this for method chaining.
Parameters
| Type | Name | Description |
|---|---|---|
System.Char | codepoint | The codepoint to add. |
Remarks
Unsupported codepoints will be ignored.
With(uint)
Adds a single codepoint to the builder.
public FluentGlyphRangeBuilder With(uint codepoint)
Returns
Dalamud.Interface.ManagedFontAtlas.FluentGlyphRangeBuilder: this for method chaining.
Parameters
| Type | Name | Description |
|---|---|---|
System.UInt32 | codepoint | The codepoint to add. |
Remarks
Unsupported codepoints will be ignored.
With(int)
Adds a single codepoint to the builder.
public FluentGlyphRangeBuilder With(int codepoint)
Returns
Dalamud.Interface.ManagedFontAtlas.FluentGlyphRangeBuilder: this for method chaining.
Parameters
| Type | Name | Description |
|---|---|---|
System.Int32 | codepoint | The codepoint to add. |
Remarks
Unsupported codepoints will be ignored.
With(UnicodeRange)
Adds a unicode range to the builder.
public FluentGlyphRangeBuilder With(UnicodeRange range)
Returns
Dalamud.Interface.ManagedFontAtlas.FluentGlyphRangeBuilder: this for method chaining.
Parameters
| Type | Name | Description |
|---|---|---|
System.Text.Unicode.UnicodeRange | range | The unicode range to add. |
Remarks
Unsupported codepoints will be ignored.
With(UnicodeRange, UnicodeRange)
Adds unicode ranges to the builder.
public FluentGlyphRangeBuilder With(UnicodeRange range1, UnicodeRange range2)
Returns
Dalamud.Interface.ManagedFontAtlas.FluentGlyphRangeBuilder: this for method chaining.
Parameters
| Type | Name | Description |
|---|---|---|
System.Text.Unicode.UnicodeRange | range1 | The 1st unicode range to add. |
System.Text.Unicode.UnicodeRange | range2 | The 2st unicode range to add. |
Remarks
Unsupported codepoints will be ignored.
With(UnicodeRange, UnicodeRange, UnicodeRange)
Adds unicode ranges to the builder.
public FluentGlyphRangeBuilder With(UnicodeRange range1, UnicodeRange range2, UnicodeRange range3)
Returns
Dalamud.Interface.ManagedFontAtlas.FluentGlyphRangeBuilder: this for method chaining.
Parameters
| Type | Name | Description |
|---|---|---|
System.Text.Unicode.UnicodeRange | range1 | The 1st unicode range to add. |
System.Text.Unicode.UnicodeRange | range2 | The 2st unicode range to add. |
System.Text.Unicode.UnicodeRange | range3 | The 3rd unicode range to add. |
Remarks
Unsupported codepoints will be ignored.
With(UnicodeRange, UnicodeRange, UnicodeRange, UnicodeRange, params UnicodeRange[])
Adds unicode ranges to the builder.
public FluentGlyphRangeBuilder With(UnicodeRange range1, UnicodeRange range2, UnicodeRange range3, UnicodeRange range4, params UnicodeRange[] evenMoreRanges)
Returns
Dalamud.Interface.ManagedFontAtlas.FluentGlyphRangeBuilder: this for method chaining.
Parameters
| Type | Name | Description |
|---|---|---|
System.Text.Unicode.UnicodeRange | range1 | The 1st unicode range to add. |
System.Text.Unicode.UnicodeRange | range2 | The 2st unicode range to add. |
System.Text.Unicode.UnicodeRange | range3 | The 3rd unicode range to add. |
System.Text.Unicode.UnicodeRange | range4 | The 4th unicode range to add. |
System.Text.Unicode.UnicodeRange[] | evenMoreRanges | Even more unicode ranges to add. |
Remarks
Unsupported codepoints will be ignored.
With(IEnumerable<UnicodeRange>)
Adds unicode ranges to the builder.
public FluentGlyphRangeBuilder With(IEnumerable<UnicodeRange> ranges)
Returns
Dalamud.Interface.ManagedFontAtlas.FluentGlyphRangeBuilder: this for method chaining.
Parameters
| Type | Name | Description |
|---|---|---|
System.Collections.Generic.IEnumerable<System.Text.Unicode.UnicodeRange> | ranges | Unicode ranges to add. |
Remarks
Unsupported codepoints will be ignored.
With(char, char)
Adds a range of characters to the builder.
public FluentGlyphRangeBuilder With(char from, char to)
Returns
Dalamud.Interface.ManagedFontAtlas.FluentGlyphRangeBuilder: this for method chaining.
Parameters
| Type | Name | Description |
|---|---|---|
System.Char | from | The first codepoint, inclusive. |
System.Char | to | The last codepoint, inclusive. |
Remarks
<p>Unsupported codepoints will be ignored.</p> <p>If <code class="paramref">from</code> is more than <code class="paramref">to</code>, then they will be swapped.</p>
With(uint, uint)
Adds a range of characters to the builder.
public FluentGlyphRangeBuilder With(uint from, uint to)
Returns
Dalamud.Interface.ManagedFontAtlas.FluentGlyphRangeBuilder: this for method chaining.
Parameters
| Type | Name | Description |
|---|---|---|
System.UInt32 | from | The first codepoint, inclusive. |
System.UInt32 | to | The last codepoint, inclusive. |
Remarks
<p>Unsupported codepoints will be ignored.</p> <p>If <code class="paramref">from</code> is more than <code class="paramref">to</code>, then they will be swapped.</p>
With(int, int)
Adds a range of characters to the builder.
public FluentGlyphRangeBuilder With(int from, int to)
Returns
Dalamud.Interface.ManagedFontAtlas.FluentGlyphRangeBuilder: this for method chaining.
Parameters
| Type | Name | Description |
|---|---|---|
System.Int32 | from | The first codepoint, inclusive. |
System.Int32 | to | The last codepoint, inclusive. |
Remarks
<p>Unsupported codepoints will be ignored.</p> <p>If <code class="paramref">from</code> is more than <code class="paramref">to</code>, then they will be swapped.</p>
With(ReadOnlySpan<byte>)
Adds characters from a UTF-8 character sequence.
public FluentGlyphRangeBuilder With(ReadOnlySpan<byte> utf8Sequence)
Returns
Dalamud.Interface.ManagedFontAtlas.FluentGlyphRangeBuilder: this for method chaining.
Parameters
| Type | Name | Description |
|---|---|---|
System.ReadOnlySpan<System.Byte> | utf8Sequence | The sequence. |
Remarks
Unsupported codepoints will be ignored.
With(IEnumerable<byte>)
Adds characters from a UTF-8 character sequence.
public FluentGlyphRangeBuilder With(IEnumerable<byte> utf8Sequence)
Returns
Dalamud.Interface.ManagedFontAtlas.FluentGlyphRangeBuilder: this for method chaining.
Parameters
| Type | Name | Description |
|---|---|---|
System.Collections.Generic.IEnumerable<System.Byte> | utf8Sequence | The sequence. |
Remarks
Unsupported codepoints will be ignored.
With(ReadOnlySpan<char>)
Adds characters from a UTF-16 character sequence.
public FluentGlyphRangeBuilder With(ReadOnlySpan<char> utf16Sequence)
Returns
Dalamud.Interface.ManagedFontAtlas.FluentGlyphRangeBuilder: this for method chaining.
Parameters
| Type | Name | Description |
|---|---|---|
System.ReadOnlySpan<System.Char> | utf16Sequence | The sequence. |
Remarks
Unsupported codepoints will be ignored.
With(IEnumerable<char>)
Adds characters from a UTF-16 character sequence.
public FluentGlyphRangeBuilder With(IEnumerable<char> utf16Sequence)
Returns
Dalamud.Interface.ManagedFontAtlas.FluentGlyphRangeBuilder: this for method chaining.
Parameters
| Type | Name | Description |
|---|---|---|
System.Collections.Generic.IEnumerable<System.Char> | utf16Sequence | The sequence. |
Remarks
Unsupported codepoints will be ignored.
With(string)
Adds characters from a string.
public FluentGlyphRangeBuilder With(string @string)
Returns
Dalamud.Interface.ManagedFontAtlas.FluentGlyphRangeBuilder: this for method chaining.
Parameters
| Type | Name | Description |
|---|---|---|
System.String | string | The string. |
Remarks
Unsupported codepoints will be ignored.
WithLanguage(CultureInfo)
Adds glyphs that are likely to be used in the given culture to the builder.
public FluentGlyphRangeBuilder WithLanguage(CultureInfo cultureInfo)
Returns
Dalamud.Interface.ManagedFontAtlas.FluentGlyphRangeBuilder: this for method chaining.
Parameters
| Type | Name | Description |
|---|---|---|
System.Globalization.CultureInfo | cultureInfo | A culture info. |
Remarks
Unsupported codepoints will be ignored. Unsupported culture will do nothing. Do make a PR if you need more.
WithLanguage(string)
Adds glyphs that are likely to be used in the given culture to the builder.
public FluentGlyphRangeBuilder WithLanguage(string languageTag)
Returns
Dalamud.Interface.ManagedFontAtlas.FluentGlyphRangeBuilder: this for method chaining.
Parameters
| Type | Name | Description |
|---|---|---|
System.String | languageTag | A language tag that will be used to locate the culture info. |
Remarks
See System.Globalization.CultureInfo.GetCultureInfo(System.String) documentation for supported language tags.
Build(bool, bool)
Builds the accumulated data into an ImGui glyph range.
public ushort[] Build(bool addFallbackCodepoints = true, bool addEllipsisCodepoints = true)
Returns
System.UInt16[]: The built ImGui glyph ranges.
Parameters
| Type | Name | Description |
|---|---|---|
System.Boolean | addFallbackCodepoints | Whether to add the default fallback codepoints to the range. |
System.Boolean | addEllipsisCodepoints | Whether to add the default ellipsis codepoints to the range. |
BuildExact()
Builds the accumulated data into an ImGui glyph range, exactly as specified.
public ushort[] BuildExact()
Returns
System.UInt16[]: The built ImGui glyph ranges.