TextServer

public Rid CreateFont();

Creates a new, empty font cache entry resource. To free the resulting resource, use the TextServer.FreeRid method.

public Rid CreateFontLinkedVariation(Rid fontRid);

Creates a new variation existing font which is reusing the same glyph cache and font data. To free the resulting resource, use the TextServer.FreeRid method.

public Rid CreateShapedText(TextServer.Direction direction = TextServer.Direction.Auto, TextServer.Orientation orientation = TextServer.Orientation.Horizontal);

Creates a new buffer for complex text layout, with the given direction and orientation. To free the resulting buffer, use TextServer.FreeRid method. Note: Direction is ignored if server does not support TextServer.Feature.BidiLayout feature (supported by TextServerAdvanced). Note: Orientation is ignored if server does not support TextServer.Feature.VerticalLayout feature (supported by TextServerAdvanced).

public void DrawHexCodeBox(Rid canvas, long size, Vector2 pos, long index, Color color);

Draws box displaying character hexadecimal code. Used for replacing missing characters.

public void FontClearGlyphs(Rid fontRid, Vector2I size);

Removes all rendered glyph information from the cache entry. Note: This function will not remove textures associated with the glyphs, use TextServer.FontRemoveTexture to remove them manually.

public void FontClearKerningMap(Rid fontRid, long size);

Removes all kerning overrides.

public void FontClearSizeCache(Rid fontRid);

Removes all font sizes from the cache entry.

public void FontClearSystemFallbackCache();

Frees all automatically loaded system fonts.

public void FontClearTextures(Rid fontRid, Vector2I size);

Removes all textures from font cache entry. Note: This function will not remove glyphs associated with the texture, use TextServer.FontRemoveGlyph to remove them manually.

public void FontDrawGlyph(Rid fontRid, Rid canvas, long size, Vector2 pos, long index, Color? color);

Draws single glyph into a canvas item at the position, using font_rid at the size size. If oversampling is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used. Note: Glyph index is specific to the font, use glyphs indices returned by TextServer.ShapedTextGetGlyphs or TextServer.FontGetGlyphIndex. Note: If there are pending glyphs to render, calling this function might trigger the texture cache update.

public void FontDrawGlyph(Rid fontRid, Rid canvas, long size, Vector2 pos, long index, Color? color = default, float oversampling = 0f);

Draws single glyph into a canvas item at the position, using font_rid at the size size. If oversampling is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used. Note: Glyph index is specific to the font, use glyphs indices returned by TextServer.ShapedTextGetGlyphs or TextServer.FontGetGlyphIndex. Note: If there are pending glyphs to render, calling this function might trigger the texture cache update.

public void FontDrawGlyphOutline(Rid fontRid, Rid canvas, long size, long outlineSize, Vector2 pos, long index, Color? color);

Draws single glyph outline of size outline_size into a canvas item at the position, using font_rid at the size size. If oversampling is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used. Note: Glyph index is specific to the font, use glyphs indices returned by TextServer.ShapedTextGetGlyphs or TextServer.FontGetGlyphIndex. Note: If there are pending glyphs to render, calling this function might trigger the texture cache update.

public void FontDrawGlyphOutline(Rid fontRid, Rid canvas, long size, long outlineSize, Vector2 pos, long index, Color? color = default, float oversampling = 0f);

Draws single glyph outline of size outline_size into a canvas item at the position, using font_rid at the size size. If oversampling is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used. Note: Glyph index is specific to the font, use glyphs indices returned by TextServer.ShapedTextGetGlyphs or TextServer.FontGetGlyphIndex. Note: If there are pending glyphs to render, calling this function might trigger the texture cache update.

public TextServer.FontAntialiasing FontGetAntialiasing(Rid fontRid);

Returns font anti-aliasing mode.

public double FontGetAscent(Rid fontRid, long size);

Returns the font ascent (number of pixels above the baseline).

public double FontGetBaselineOffset(Rid fontRid);

Returns extra baseline offset (as a fraction of font height).

public long FontGetCharFromGlyphIndex(Rid fontRid, long size, long glyphIndex);

Returns character code associated with glyph_index, or 0 if glyph_index is invalid. See TextServer.FontGetGlyphIndex.

public double FontGetDescent(Rid fontRid, long size);

Returns the font descent (number of pixels below the baseline).

public bool FontGetDisableEmbeddedBitmaps(Rid fontRid);

Returns whether the font's embedded bitmap loading is disabled.

public double FontGetEmbolden(Rid fontRid);

Returns font embolden strength.

public long FontGetFaceCount(Rid fontRid);

Returns number of faces in the TrueType / OpenType collection.

public long FontGetFaceIndex(Rid fontRid);

Returns an active face index in the TrueType / OpenType collection.

public long FontGetFixedSize(Rid fontRid);

Returns bitmap font fixed size.

public TextServer.FixedSizeScaleMode FontGetFixedSizeScaleMode(Rid fontRid);

Returns bitmap font scaling mode.

public bool FontGetGenerateMipmaps(Rid fontRid);

Returns true if font texture mipmap generation is enabled.

public double FontGetGlobalOversampling();

This method does nothing and always returns 1.0.

public Vector2 FontGetGlyphAdvance(Rid fontRid, long size, long glyph);

Returns glyph advance (offset of the next glyph). Note: Advance for glyphs outlines is the same as the base glyph advance and is not saved.

public Reckfell.Collections.Dictionary FontGetGlyphContours(Rid font, long size, long index);

Returns outline contours of the glyph as a Reckfell.Collections.Dictionary with the following contents: points - Vector3[], containing outline points. x and y are point coordinates. z is the type of the point, using the TextServer.ContourPointTag values. contours - int[], containing indices the end points of each contour. orientation - [bool], contour orientation. If true, clockwise contours must be filled.

• Two successive TextServer.ContourPointTag.On points indicate a line segment.
• One TextServer.ContourPointTag.OffConic point between two TextServer.ContourPointTag.On points indicates a single conic (quadratic) Bézier arc.
• Two TextServer.ContourPointTag.OffCubic points between two TextServer.ContourPointTag.On points indicate a single cubic Bézier arc.
• Two successive TextServer.ContourPointTag.OffConic points indicate two successive conic (quadratic) Bézier arcs with a virtual TextServer.ContourPointTag.On point at their middle.
• Each contour is closed. The last point of a contour uses the first point of a contour as its next point, and vice versa. The first point can be TextServer.ContourPointTag.OffConic point.

public long FontGetGlyphIndex(Rid fontRid, long size, long @char, long variationSelector);

Returns the glyph index of a char, optionally modified by the variation_selector. See TextServer.FontGetCharFromGlyphIndex.

public int[] FontGetGlyphList(Rid fontRid, Vector2I size);

Returns list of rendered glyphs in the cache entry.

public Vector2 FontGetGlyphOffset(Rid fontRid, Vector2I size, long glyph);

Returns glyph offset from the baseline.

public Vector2 FontGetGlyphSize(Rid fontRid, Vector2I size, long glyph);

Returns size of the glyph.

public long FontGetGlyphTextureIdx(Rid fontRid, Vector2I size, long glyph);

Returns index of the cache texture containing the glyph.

public Rid FontGetGlyphTextureRid(Rid fontRid, Vector2I size, long glyph);

Returns resource ID of the cache texture containing the glyph. Note: If there are pending glyphs to render, calling this function might trigger the texture cache update.

public Vector2 FontGetGlyphTextureSize(Rid fontRid, Vector2I size, long glyph);

Returns size of the cache texture containing the glyph. Note: If there are pending glyphs to render, calling this function might trigger the texture cache update.

public Rect2 FontGetGlyphUVRect(Rid fontRid, Vector2I size, long glyph);

Returns rectangle in the cache texture containing the glyph.

public TextServer.Hinting FontGetHinting(Rid fontRid);

Returns the font hinting mode. Used by dynamic fonts only.

public bool FontGetKeepRoundingRemainders(Rid fontRid);

Returns glyph position rounding behavior. If set to true, when aligning glyphs to the pixel boundaries rounding remainders are accumulated to ensure more uniform glyph distribution. This setting has no effect if subpixel positioning is enabled.

public Vector2 FontGetKerning(Rid fontRid, long size, Vector2I glyphPair);

Returns kerning for the pair of glyphs.

public Reckfell.Collections.Array<Vector2I> FontGetKerningList(Rid fontRid, long size);

Returns list of the kerning overrides.

public bool FontGetLanguageSupportOverride(Rid fontRid, string language);

Returns true if support override is enabled for the language.

public string[] FontGetLanguageSupportOverrides(Rid fontRid);

Returns list of language support overrides.

public long FontGetMsdfPixelRange(Rid fontRid);

Returns the width of the range around the shape between the minimum and maximum representable signed distance.

public long FontGetMsdfSize(Rid fontRid);

Returns source font size used to generate MSDF textures.

public string FontGetName(Rid fontRid);

Returns font family name.

public Reckfell.Collections.Dictionary FontGetOpentypeFeatureOverrides(Rid fontRid);

Returns font OpenType feature set override.

public Reckfell.Collections.Dictionary FontGetOtNameStrings(Rid fontRid);

Returns Reckfell.Collections.Dictionary with OpenType font name strings (localized font names, version, description, license information, sample text, etc.).

public double FontGetOversampling(Rid fontRid);

Returns oversampling factor override. If set to a positive value, overrides the oversampling factor of the viewport this font is used in. See Viewport.Oversampling. This value doesn't override the [code skip-lint]oversampling parameter of [code skip-lint]draw_* methods. Used by dynamic fonts only.

public Color[] FontGetPaletteColors(Rid fontRid, long index);

Returns the array in the predefined color palette at index. Palette contains all colors used to render font glyphs. Each palette has the same number of colors. Colors can be overridden using TextServer.FontSetPaletteCustomColors.

public long FontGetPaletteCount(Rid fontRid);

Returns the number of predefined color palettes. Palette contains all colors used to render font glyphs. Each palette has the same number of colors.

public Color[] FontGetPaletteCustomColors(Rid fontRid);

Returns array of custom colors to override predefined palette.

public string FontGetPaletteName(Rid fontRid, long index);

Returns the name of the predefined color palette at index. Palette contains all colors used to render font glyphs. Each palette has the same number of colors.

public double FontGetScale(Rid fontRid, long size);

Returns scaling factor of the color bitmap font.

public bool FontGetScriptSupportOverride(Rid fontRid, string script);

Returns true if support override is enabled for the script.

public string[] FontGetScriptSupportOverrides(Rid fontRid);

Returns list of script support overrides.

public Reckfell.Collections.Array<Reckfell.Collections.Dictionary> FontGetSizeCacheInfo(Rid fontRid);

Returns font cache information, each entry contains the following fields: Vector2i size_px - font size in pixels, float viewport_oversampling - viewport oversampling factor, int glyphs - number of rendered glyphs, int textures - number of used textures, int textures_size - size of texture data in bytes.

public Reckfell.Collections.Array<Vector2I> FontGetSizeCacheList(Rid fontRid);

Returns list of the font sizes in the cache. Each size is Vector2I with font size and outline size.

public long FontGetSpacing(Rid fontRid, TextServer.SpacingType spacing);

Returns the spacing for spacing in pixels (not relative to the font size).

public long FontGetStretch(Rid fontRid);

Returns font stretch amount, compared to a normal width. A percentage value between 50% and 200%.

public TextServer.FontStyle FontGetStyle(Rid fontRid);

Returns font style flags.

public string FontGetStyleName(Rid fontRid);

Returns font style name.

public TextServer.SubpixelPositioning FontGetSubpixelPositioning(Rid fontRid);

Returns font subpixel glyph positioning mode.

public string FontGetSupportedChars(Rid fontRid);

Returns a string containing all the characters available in the font.

public int[] FontGetSupportedGlyphs(Rid fontRid);

Returns an array containing all glyph indices in the font.

public long FontGetTextureCount(Rid fontRid, Vector2I size);

Returns number of textures used by font cache entry.

public Image FontGetTextureImage(Rid fontRid, Vector2I size, long textureIndex);

Returns font cache texture image data.

public int[] FontGetTextureOffsets(Rid fontRid, Vector2I size, long textureIndex);

Returns array containing glyph packing data.

public Transform2D FontGetTransform(Rid fontRid);

Returns 2D transform applied to the font outlines.

public double FontGetUnderlinePosition(Rid fontRid, long size);

Returns pixel offset of the underline below the baseline.

public double FontGetUnderlineThickness(Rid fontRid, long size);

Returns thickness of the underline in pixels.

public long FontGetUsedPalette(Rid fontRid);

Returns used palette index.

public Reckfell.Collections.Dictionary FontGetVariationCoordinates(Rid fontRid);

Returns variation coordinates for the specified font cache entry. See TextServer.FontSupportedVariationList for more info.

public long FontGetWeight(Rid fontRid);

Returns weight (boldness) of the font. A value in the 100...999 range, normal font weight is 400, bold font weight is 700.

public bool FontHasChar(Rid fontRid, long @char);

Returns true if a Unicode char is available in the font.

public bool FontIsAllowSystemFallback(Rid fontRid);

Returns true if system fonts can be automatically used as fallbacks.

public bool FontIsForceAutohinter(Rid fontRid);

Returns true if auto-hinting is supported and preferred over font built-in hinting. Used by dynamic fonts only.

public bool FontIsLanguageSupported(Rid fontRid, string language);

Returns true if the font supports the given language (as a ISO 639 code).

public bool FontIsModulateColorGlyphs(Rid fontRid);

Returns true if color modulation is applied when drawing the font's colored glyphs.

public bool FontIsMultichannelSignedDistanceField(Rid fontRid);

Returns true if glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data.

public bool FontIsScriptSupported(Rid fontRid, string script);

Returns true if the font supports the given script (as a ISO 15924 code).

public void FontRemoveGlyph(Rid fontRid, Vector2I size, long glyph);

Removes specified rendered glyph information from the cache entry. Note: This function will not remove textures associated with the glyphs, use TextServer.FontRemoveTexture to remove them manually.

public void FontRemoveKerning(Rid fontRid, long size, Vector2I glyphPair);

Removes kerning override for the pair of glyphs.

public void FontRemoveLanguageSupportOverride(Rid fontRid, string language);

Remove language support override.

public void FontRemoveScriptSupportOverride(Rid fontRid, string script);

Removes script support override.

public void FontRemoveSizeCache(Rid fontRid, Vector2I size);

Removes specified font size from the cache entry.

public void FontRemoveTexture(Rid fontRid, Vector2I size, long textureIndex);

Removes specified texture from the cache entry. Note: This function will not remove glyphs associated with the texture, remove them manually, using TextServer.FontRemoveGlyph.

public void FontRenderGlyph(Rid fontRid, Vector2I size, long index);

Renders specified glyph to the font cache texture.

public void FontRenderRange(Rid fontRid, Vector2I size, long start, long end);

Renders the range of characters to the font cache texture.

public void FontSetAllowSystemFallback(Rid fontRid, bool allowSystemFallback);

If set to true, system fonts can be automatically used as fallbacks.

public void FontSetAntialiasing(Rid fontRid, TextServer.FontAntialiasing antialiasing);

Sets font anti-aliasing mode.

public void FontSetAscent(Rid fontRid, long size, double ascent);

Sets the font ascent (number of pixels above the baseline).

public void FontSetBaselineOffset(Rid fontRid, double baselineOffset);

Sets extra baseline offset (as a fraction of font height).

public void FontSetData(Rid fontRid, byte[] data);

Sets font source data, e.g contents of the dynamic font source file.

public void FontSetData(Rid fontRid, ReadOnlySpan<byte> data);

Sets font source data, e.g contents of the dynamic font source file.

public void FontSetDescent(Rid fontRid, long size, double descent);

Sets the font descent (number of pixels below the baseline).

public void FontSetDisableEmbeddedBitmaps(Rid fontRid, bool disableEmbeddedBitmaps);

If set to true, embedded font bitmap loading is disabled (bitmap-only and color fonts ignore this property).

public void FontSetEmbolden(Rid fontRid, double strength);

Sets font embolden strength. If strength is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness.

public void FontSetFaceIndex(Rid fontRid, long faceIndex);

Sets an active face index in the TrueType / OpenType collection.

public void FontSetFixedSize(Rid fontRid, long fixedSize);

Sets bitmap font fixed size. If set to value greater than zero, same cache entry will be used for all font sizes.

public void FontSetFixedSizeScaleMode(Rid fontRid, TextServer.FixedSizeScaleMode fixedSizeScaleMode);

Sets bitmap font scaling mode. This property is used only if fixed_size is greater than zero.

public void FontSetForceAutohinter(Rid fontRid, bool forceAutohinter);

If set to true auto-hinting is preferred over font built-in hinting.

public void FontSetGenerateMipmaps(Rid fontRid, bool generateMipmaps);

If set to true font texture mipmap generation is enabled.

public void FontSetGlobalOversampling(double oversampling);

This method does nothing.

public void FontSetGlyphAdvance(Rid fontRid, long size, long glyph, Vector2 advance);

Sets glyph advance (offset of the next glyph). Note: Advance for glyphs outlines is the same as the base glyph advance and is not saved.

public void FontSetGlyphOffset(Rid fontRid, Vector2I size, long glyph, Vector2 offset);

Sets glyph offset from the baseline.

public void FontSetGlyphSize(Rid fontRid, Vector2I size, long glyph, Vector2 glSize);

Sets size of the glyph.

public void FontSetGlyphTextureIdx(Rid fontRid, Vector2I size, long glyph, long textureIdx);

Sets index of the cache texture containing the glyph.

public void FontSetGlyphUVRect(Rid fontRid, Vector2I size, long glyph, Rect2 uVRect);

Sets rectangle in the cache texture containing the glyph.

public void FontSetHinting(Rid fontRid, TextServer.Hinting hinting);

Sets font hinting mode. Used by dynamic fonts only.

public void FontSetKeepRoundingRemainders(Rid fontRid, bool keepRoundingRemainders);

Sets glyph position rounding behavior. If set to true, when aligning glyphs to the pixel boundaries rounding remainders are accumulated to ensure more uniform glyph distribution. This setting has no effect if subpixel positioning is enabled.

public void FontSetKerning(Rid fontRid, long size, Vector2I glyphPair, Vector2 kerning);

Sets kerning for the pair of glyphs.

public void FontSetLanguageSupportOverride(Rid fontRid, string language, bool supported);

Adds override for TextServer.FontIsLanguageSupported.

public void FontSetModulateColorGlyphs(Rid fontRid, bool modulate);

If set to true, color modulation is applied when drawing colored glyphs, otherwise it's applied to the monochrome glyphs only.

public void FontSetMsdfPixelRange(Rid fontRid, long msdfPixelRange);

Sets the width of the range around the shape between the minimum and maximum representable signed distance.

public void FontSetMsdfSize(Rid fontRid, long msdfSize);

Sets source font size used to generate MSDF textures.

public void FontSetMultichannelSignedDistanceField(Rid fontRid, bool msdf);

If set to true, glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data. MSDF rendering allows displaying the font at any scaling factor without blurriness, and without incurring a CPU cost when the font size changes (since the font no longer needs to be rasterized on the CPU). As a downside, font hinting is not available with MSDF. The lack of font hinting may result in less crisp and less readable fonts at small sizes. Note: MSDF font rendering does not render glyphs with overlapping shapes correctly. Overlapping shapes are not valid per the OpenType standard, but are still commonly found in many font files, especially those converted by Google Fonts. To avoid issues with overlapping glyphs, consider downloading the font file directly from the type foundry instead of relying on Google Fonts.

public void FontSetName(Rid fontRid, string name);

Sets the font family name.

public void FontSetOpentypeFeatureOverrides(Rid fontRid, Reckfell.Collections.Dictionary overrides);

Sets font OpenType feature set override.

public void FontSetOversampling(Rid fontRid, double oversampling);

If set to a positive value, overrides the oversampling factor of the viewport this font is used in. See Viewport.Oversampling. This value doesn't override the [code skip-lint]oversampling parameter of [code skip-lint]draw_* methods. Used by dynamic fonts only.

public void FontSetPaletteCustomColors(Rid fontRid, Color[] colors);

Sets array of custom colors to override predefined palette. Set to empty array to reset overrides. Use Color(0, 0, 0, 0), to keep predefined palette color at specific position.

public void FontSetPaletteCustomColors(Rid fontRid, ReadOnlySpan<Color> colors);

Sets array of custom colors to override predefined palette. Set to empty array to reset overrides. Use Color(0, 0, 0, 0), to keep predefined palette color at specific position.

public void FontSetScale(Rid fontRid, long size, double scale);

Sets scaling factor of the color bitmap font.

public void FontSetScriptSupportOverride(Rid fontRid, string script, bool supported);

Adds override for TextServer.FontIsScriptSupported.

public void FontSetSpacing(Rid fontRid, TextServer.SpacingType spacing, long value);

Sets the spacing for spacing to value in pixels (not relative to the font size).

public void FontSetStretch(Rid fontRid, long weight);

Sets font stretch amount, compared to a normal width. A percentage value between 50% and 200%. Note: This value is used for font matching only and will not affect font rendering. Use TextServer.FontSetFaceIndex, TextServer.FontSetVariationCoordinates, or TextServer.FontSetTransform instead.

public void FontSetStyle(Rid fontRid, TextServer.FontStyle style);

Sets the font style flags. Note: This value is used for font matching only and will not affect font rendering. Use TextServer.FontSetFaceIndex, TextServer.FontSetVariationCoordinates, TextServer.FontSetEmbolden, or TextServer.FontSetTransform instead.

public void FontSetStyleName(Rid fontRid, string name);

Sets the font style name.

public void FontSetSubpixelPositioning(Rid fontRid, TextServer.SubpixelPositioning subpixelPositioning);

Sets font subpixel glyph positioning mode.

public void FontSetTextureImage(Rid fontRid, Vector2I size, long textureIndex, Image image);

Sets font cache texture image data.

public void FontSetTextureOffsets(Rid fontRid, Vector2I size, long textureIndex, int[] offset);

Sets array containing glyph packing data.

public void FontSetTextureOffsets(Rid fontRid, Vector2I size, long textureIndex, ReadOnlySpan<int> offset);

Sets array containing glyph packing data.

public void FontSetTransform(Rid fontRid, Transform2D transform);

Sets 2D transform, applied to the font outlines, can be used for slanting, flipping, and rotating glyphs. For example, to simulate italic typeface by slanting, apply the following transform Transform2D(1.0, slant, 0.0, 1.0, 0.0, 0.0).

public void FontSetUnderlinePosition(Rid fontRid, long size, double underlinePosition);

Sets pixel offset of the underline below the baseline.

public void FontSetUnderlineThickness(Rid fontRid, long size, double underlineThickness);

Sets thickness of the underline in pixels.

public void FontSetUsedPalette(Rid fontRid, long index);

Sets used palette index.

public void FontSetVariationCoordinates(Rid fontRid, Reckfell.Collections.Dictionary variationCoordinates);

Sets variation coordinates for the specified font cache entry. See TextServer.FontSupportedVariationList for more info.

public void FontSetWeight(Rid fontRid, long weight);

Sets weight (boldness) of the font. A value in the 100...999 range, normal font weight is 400, bold font weight is 700. Note: This value is used for font matching only and will not affect font rendering. Use TextServer.FontSetFaceIndex, TextServer.FontSetVariationCoordinates, or TextServer.FontSetEmbolden instead.

public Reckfell.Collections.Dictionary FontSupportedFeatureList(Rid fontRid);

Returns the dictionary of the supported OpenType features.