godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/servers/text_server.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

617 lines
30 KiB
C++
Raw Normal View History

One Copyright Update to rule them all As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see".
2023-01-05 12:25:55 +00:00
/**************************************************************************/
/* text_server.h */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/**************************************************************************/
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
#ifndef TEXT_SERVER_H
#define TEXT_SERVER_H
Rename Reference to RefCounted
2021-06-04 16:03:15 +00:00
#include "core/object/ref_counted.h"
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
#include "core/os/os.h"
#include "core/templates/rid.h"
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
#include "core/variant/native_ptr.h"
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
#include "core/variant/variant.h"
Replace Array return types with TypedArray
2022-08-05 01:41:48 +00:00
template <typename T>
class TypedArray;
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
struct Glyph;
struct CaretInfo;
class TextServer : public RefCounted {
GDCLASS(TextServer, RefCounted);
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
public:
Add font LCD sub-pixel anti-aliasing support.
2022-08-12 11:03:28 +00:00
enum FontAntialiasing {
FONT_ANTIALIASING_NONE,
FONT_ANTIALIASING_GRAY,
FONT_ANTIALIASING_LCD,
};
enum FontLCDSubpixelLayout {
FONT_LCD_SUBPIXEL_LAYOUT_NONE,
FONT_LCD_SUBPIXEL_LAYOUT_HRGB,
FONT_LCD_SUBPIXEL_LAYOUT_HBGR,
FONT_LCD_SUBPIXEL_LAYOUT_VRGB,
FONT_LCD_SUBPIXEL_LAYOUT_VBGR,
FONT_LCD_SUBPIXEL_LAYOUT_MAX,
};
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
enum Direction {
DIRECTION_AUTO,
DIRECTION_LTR,
Implement BiDi override mode for GDScript source.
2023-01-18 07:33:35 +00:00
DIRECTION_RTL,
DIRECTION_INHERITED,
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
};
enum Orientation {
ORIENTATION_HORIZONTAL,
ORIENTATION_VERTICAL
};
enum JustificationFlag {
JUSTIFICATION_NONE = 0,
JUSTIFICATION_KASHIDA = 1 << 0,
JUSTIFICATION_WORD_BOUND = 1 << 1,
JUSTIFICATION_TRIM_EDGE_SPACES = 1 << 2,
Various text layout improvements (TextLine, TextParagraph, Label, TextServer)
2021-08-10 22:09:48 +00:00
JUSTIFICATION_AFTER_LAST_TAB = 1 << 3,
JUSTIFICATION_CONSTRAIN_ELLIPSIS = 1 << 4,
Expose TextServer justification flags to Label, Label3D, TextMesh and RTL. Add flags to control last/single line justification.
2023-03-23 09:22:37 +00:00
JUSTIFICATION_SKIP_LAST_LINE = 1 << 5,
JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS = 1 << 6,
JUSTIFICATION_DO_NOT_SKIP_SINGLE_LINE = 1 << 7,
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
};
Move duplicate AutoWrap, Overrun and VisibleChar behavior enums to the TextServer.
2022-06-15 08:01:45 +00:00
enum VisibleCharactersBehavior {
VC_CHARS_BEFORE_SHAPING,
VC_CHARS_AFTER_SHAPING,
VC_GLYPHS_AUTO,
VC_GLYPHS_LTR,
VC_GLYPHS_RTL,
};
enum AutowrapMode {
AUTOWRAP_OFF,
AUTOWRAP_ARBITRARY,
AUTOWRAP_WORD,
AUTOWRAP_WORD_SMART
};
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
enum LineBreakFlag {
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
BREAK_NONE = 0,
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
BREAK_MANDATORY = 1 << 0,
BREAK_WORD_BOUND = 1 << 1,
BREAK_GRAPHEME_BOUND = 1 << 2,
BREAK_ADAPTIVE = 1 << 3,
[TextServer] Add support for trimming edge spaces on line break.
2022-08-30 08:56:17 +00:00
BREAK_TRIM_EDGE_SPACES = 1 << 4,
Improvements to Label's layout options - Added options to trim the text in case it overruns - Added more autowrap modes - Improved line breaking, which ignores trailing spaces
2021-07-04 14:43:55 +00:00
};
Move duplicate AutoWrap, Overrun and VisibleChar behavior enums to the TextServer.
2022-06-15 08:01:45 +00:00
enum OverrunBehavior {
OVERRUN_NO_TRIMMING,
OVERRUN_TRIM_CHAR,
OVERRUN_TRIM_WORD,
OVERRUN_TRIM_ELLIPSIS,
OVERRUN_TRIM_WORD_ELLIPSIS,
};
Improvements to Label's layout options - Added options to trim the text in case it overruns - Added more autowrap modes - Improved line breaking, which ignores trailing spaces
2021-07-04 14:43:55 +00:00
enum TextOverrunFlag {
Move duplicate AutoWrap, Overrun and VisibleChar behavior enums to the TextServer.
2022-06-15 08:01:45 +00:00
OVERRUN_NO_TRIM = 0,
Improvements to Label's layout options - Added options to trim the text in case it overruns - Added more autowrap modes - Improved line breaking, which ignores trailing spaces
2021-07-04 14:43:55 +00:00
OVERRUN_TRIM = 1 << 0,
OVERRUN_TRIM_WORD_ONLY = 1 << 1,
OVERRUN_ADD_ELLIPSIS = 1 << 2,
Various text layout improvements (TextLine, TextParagraph, Label, TextServer)
2021-08-10 22:09:48 +00:00
OVERRUN_ENFORCE_ELLIPSIS = 1 << 3,
OVERRUN_JUSTIFICATION_AWARE = 1 << 4,
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
};
enum GraphemeFlag {
[TextServer] Use dedicated flag for object replacement characters.
2023-04-12 07:08:51 +00:00
GRAPHEME_IS_VALID = 1 << 0, // Grapheme is valid.
GRAPHEME_IS_RTL = 1 << 1, // Grapheme is right-to-left.
GRAPHEME_IS_VIRTUAL = 1 << 2, // Grapheme is not part of source string (added by fit_to_width function, do not affect caret movement).
Add word breaks on punctuation characters.
2020-12-14 08:30:32 +00:00
GRAPHEME_IS_SPACE = 1 << 3, // Is whitespace (for justification and word breaks).
GRAPHEME_IS_BREAK_HARD = 1 << 4, // Is line break (mandatory break, e.g. "\n").
GRAPHEME_IS_BREAK_SOFT = 1 << 5, // Is line break (optional break, e.g. space).
GRAPHEME_IS_TAB = 1 << 6, // Is tab or vertical tab.
[TextServer] Use dedicated flag for object replacement characters.
2023-04-12 07:08:51 +00:00
GRAPHEME_IS_ELONGATION = 1 << 7, // Elongation (e.g. kashida), grapheme can be duplicated or truncated to fit line to width.
Separate underscore from grapheme punctuation to enable doubleclick and caret jump over snakecase variables in editor
2021-04-03 15:17:51 +00:00
GRAPHEME_IS_PUNCTUATION = 1 << 8, // Punctuation, except underscore (can be used as word break, but not line break or justifiction).
GRAPHEME_IS_UNDERSCORE = 1 << 9, // Underscore (can be used as word break).
Add flag to connected grapheme. Apply RTL displacement FX only to the whole connected grapheme. Pass more glyph info to the custom RTL FX.
2021-09-21 09:27:06 +00:00
GRAPHEME_IS_CONNECTED = 1 << 10, // Connected to previous grapheme.
HarfBuzz: Update to version 5.1.0, use new FLAG_SAFE_TO_INSERT_TATWEEL flag to improve justification.
2022-08-04 05:16:56 +00:00
GRAPHEME_IS_SAFE_TO_INSERT_TATWEEL = 1 << 11, // It is safe to insert a U+0640 before this grapheme for elongation.
[TextServer] Use dedicated flag for object replacement characters.
2023-04-12 07:08:51 +00:00
GRAPHEME_IS_EMBEDDED_OBJECT = 1 << 12, // Grapheme is an object replacement character for the embedded object.
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
};
enum Hinting {
HINTING_NONE,
HINTING_LIGHT,
HINTING_NORMAL
};
Add sub-pixel glyph positioning support.
2022-01-10 08:13:22 +00:00
enum SubpixelPositioning {
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
SUBPIXEL_POSITIONING_DISABLED = 0,
SUBPIXEL_POSITIONING_AUTO = 1,
SUBPIXEL_POSITIONING_ONE_HALF = 2,
SUBPIXEL_POSITIONING_ONE_QUARTER = 3,
Add sub-pixel glyph positioning support.
2022-01-10 08:13:22 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE = 20,
SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE = 16,
};
Add sub-pixel glyph positioning support.
2022-01-10 08:13:22 +00:00
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
enum Feature {
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
FEATURE_SIMPLE_LAYOUT = 1 << 0,
FEATURE_BIDI_LAYOUT = 1 << 1,
FEATURE_VERTICAL_LAYOUT = 1 << 2,
FEATURE_SHAPING = 1 << 3,
FEATURE_KASHIDA_JUSTIFICATION = 1 << 4,
FEATURE_BREAK_ITERATORS = 1 << 5,
FEATURE_FONT_BITMAP = 1 << 6,
FEATURE_FONT_DYNAMIC = 1 << 7,
FEATURE_FONT_MSDF = 1 << 8,
FEATURE_FONT_SYSTEM = 1 << 9,
FEATURE_FONT_VARIABLE = 1 << 10,
FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION = 1 << 11,
FEATURE_USE_SUPPORT_DATA = 1 << 12,
[TextServer] Implement ICU/UAX 31 based `is_valid_identifier` function.
2021-10-18 12:07:11 +00:00
FEATURE_UNICODE_IDENTIFIERS = 1 << 13,
[TextServer] Add ICU Unicode security and spoofing detection.
2021-11-12 08:12:37 +00:00
FEATURE_UNICODE_SECURITY = 1 << 14,
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
};
[Complex Text Layouts] Provide access to glyph contour points.
2020-12-10 15:30:25 +00:00
enum ContourPointTag {
CONTOUR_CURVE_TAG_ON = 0x01,
CONTOUR_CURVE_TAG_OFF_CONIC = 0x00,
CONTOUR_CURVE_TAG_OFF_CUBIC = 0x02
};
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
enum SpacingType {
SPACING_GLYPH,
SPACING_SPACE,
SPACING_TOP,
SPACING_BOTTOM,
Refactor Font configuration and import UI, and Font resources.
2022-05-09 09:47:10 +00:00
SPACING_MAX,
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
};
Add functions for getting name and font style from dynamic and bitmap fonts. Add font selection toolbar editor plugin.
2021-10-26 06:40:11 +00:00
enum FontStyle {
FONT_BOLD = 1 << 0,
FONT_ITALIC = 1 << 1,
FONT_FIXED_WIDTH = 1 << 2,
};
Implement Label3D node. Add "generate_mipmap" font import option. Add some missing features to the Sprite3D. Move BiDi override code from Control to TextServer. Add functions to access TextServer font cache textures. Add MSDF related flags and shader to the standard material. Change standard material cache to use HashMap instead of Vector.
2022-04-19 10:27:18 +00:00
enum StructuredTextParser {
STRUCTURED_TEXT_DEFAULT,
STRUCTURED_TEXT_URI,
STRUCTURED_TEXT_FILE,
STRUCTURED_TEXT_EMAIL,
STRUCTURED_TEXT_LIST,
Implement BiDi override mode for GDScript source.
2023-01-18 07:33:35 +00:00
STRUCTURED_TEXT_GDSCRIPT,
Implement Label3D node. Add "generate_mipmap" font import option. Add some missing features to the Sprite3D. Move BiDi override code from Control to TextServer. Add functions to access TextServer font cache textures. Add MSDF related flags and shader to the standard material. Change standard material cache to use HashMap instead of Vector.
2022-04-19 10:27:18 +00:00
STRUCTURED_TEXT_CUSTOM
};
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
void _draw_hex_code_box_number(const RID &p_canvas, int64_t p_size, const Vector2 &p_pos, uint8_t p_index, const Color &p_color) const;
Remove Scene dependency from the TextServer, use scalable hex box font instead of built-in bitmap one.
2021-10-02 19:06:20 +00:00
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
protected:
Replace most uses of Map by HashMap * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-05-13 13:04:37 +00:00
HashMap<char32_t, char32_t> diacritics_map;
Implement TextServer `strip_diacritics` function.
2021-10-12 18:36:08 +00:00
void _diacritics_map_add(const String &p_from, char32_t p_to);
void _init_diacritics_map();
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
static void _bind_methods();
public:
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
virtual bool has_feature(Feature p_feature) const = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
virtual String get_name() const = 0;
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual int64_t get_features() const = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void free_rid(const RID &p_rid) = 0;
virtual bool has(const RID &p_rid) = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
virtual bool load_support_data(const String &p_filename) = 0;
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
virtual String get_support_data_filename() const = 0;
virtual String get_support_data_info() const = 0;
virtual bool save_support_data(const String &p_filename) const = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
virtual bool is_locale_right_to_left(const String &p_locale) const = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual int64_t name_to_tag(const String &p_name) const { return 0; };
virtual String tag_to_name(int64_t p_tag) const { return ""; };
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
/* Font interface */
[GDExtension] Use function names with underscore for TextServer extension, add macros to generate wrappers for module functions.
2022-09-27 08:23:34 +00:00
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
virtual RID create_font() = 0;
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void font_set_data(const RID &p_font_rid, const PackedByteArray &p_data) = 0;
virtual void font_set_data_ptr(const RID &p_font_rid, const uint8_t *p_data_ptr, int64_t p_data_size) = 0;
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
[TextServer] Adds support for TrueType / OpenType collection files (*.TTC, *.OTC).
2022-06-07 08:35:59 +00:00
virtual void font_set_face_index(const RID &p_font_rid, int64_t p_index) = 0;
virtual int64_t font_get_face_index(const RID &p_font_rid) const = 0;
virtual int64_t font_get_face_count(const RID &p_font_rid) const = 0;
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
virtual void font_set_style(const RID &p_font_rid, BitField<FontStyle> p_style) = 0;
virtual BitField<FontStyle> font_get_style(const RID &p_font_rid) const = 0;
Add functions for getting name and font style from dynamic and bitmap fonts. Add font selection toolbar editor plugin.
2021-10-26 06:40:11 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void font_set_name(const RID &p_font_rid, const String &p_name) = 0;
virtual String font_get_name(const RID &p_font_rid) const = 0;
Add functions for getting name and font style from dynamic and bitmap fonts. Add font selection toolbar editor plugin.
2021-10-26 06:40:11 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void font_set_style_name(const RID &p_font_rid, const String &p_name) = 0;
virtual String font_get_style_name(const RID &p_font_rid) const = 0;
Add functions for getting name and font style from dynamic and bitmap fonts. Add font selection toolbar editor plugin.
2021-10-26 06:40:11 +00:00
Use system fonts as fallback and improve system font handling. Add support for font weight and stretch selection when using system fonts. Add function to get system fallback font from a font name, style, text, and language code. Implement system font support for Android. Use system fonts as a last resort fallback.
2022-11-21 13:04:01 +00:00
virtual void font_set_weight(const RID &p_font_rid, int64_t p_weight) = 0;
virtual int64_t font_get_weight(const RID &p_font_rid) const = 0;
virtual void font_set_stretch(const RID &p_font_rid, int64_t p_stretch) = 0;
virtual int64_t font_get_stretch(const RID &p_font_rid) const = 0;
[GDExtension] Use function names with underscore for TextServer extension, add macros to generate wrappers for module functions.
2022-09-27 08:23:34 +00:00
virtual void font_set_antialiasing(const RID &p_font_rid, FontAntialiasing p_antialiasing) = 0;
virtual FontAntialiasing font_get_antialiasing(const RID &p_font_rid) const = 0;
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
Implement Label3D node. Add "generate_mipmap" font import option. Add some missing features to the Sprite3D. Move BiDi override code from Control to TextServer. Add functions to access TextServer font cache textures. Add MSDF related flags and shader to the standard material. Change standard material cache to use HashMap instead of Vector.
2022-04-19 10:27:18 +00:00
virtual void font_set_generate_mipmaps(const RID &p_font_rid, bool p_generate_mipmaps) = 0;
virtual bool font_get_generate_mipmaps(const RID &p_font_rid) const = 0;
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void font_set_multichannel_signed_distance_field(const RID &p_font_rid, bool p_msdf) = 0;
virtual bool font_is_multichannel_signed_distance_field(const RID &p_font_rid) const = 0;
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void font_set_msdf_pixel_range(const RID &p_font_rid, int64_t p_msdf_pixel_range) = 0;
virtual int64_t font_get_msdf_pixel_range(const RID &p_font_rid) const = 0;
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void font_set_msdf_size(const RID &p_font_rid, int64_t p_msdf_size) = 0;
virtual int64_t font_get_msdf_size(const RID &p_font_rid) const = 0;
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void font_set_fixed_size(const RID &p_font_rid, int64_t p_fixed_size) = 0;
virtual int64_t font_get_fixed_size(const RID &p_font_rid) const = 0;
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
Use system fonts as fallback and improve system font handling. Add support for font weight and stretch selection when using system fonts. Add function to get system fallback font from a font name, style, text, and language code. Implement system font support for Android. Use system fonts as a last resort fallback.
2022-11-21 13:04:01 +00:00
virtual void font_set_allow_system_fallback(const RID &p_font_rid, bool p_allow_system_fallback) = 0;
virtual bool font_is_allow_system_fallback(const RID &p_font_rid) const = 0;
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void font_set_force_autohinter(const RID &p_font_rid, bool p_force_autohinter) = 0;
virtual bool font_is_force_autohinter(const RID &p_font_rid) const = 0;
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void font_set_hinting(const RID &p_font_rid, Hinting p_hinting) = 0;
virtual Hinting font_get_hinting(const RID &p_font_rid) const = 0;
[Text Server] Restores bitmap font dynamic construction functions.
2021-02-06 14:34:06 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void font_set_subpixel_positioning(const RID &p_font_rid, SubpixelPositioning p_subpixel) = 0;
virtual SubpixelPositioning font_get_subpixel_positioning(const RID &p_font_rid) const = 0;
Add sub-pixel glyph positioning support.
2022-01-10 08:13:22 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void font_set_embolden(const RID &p_font_rid, double p_strength) = 0;
virtual double font_get_embolden(const RID &p_font_rid) const = 0;
Add options to embolden and transform font outlines to simulate bold and italic typefaces.
2022-03-11 07:31:16 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void font_set_transform(const RID &p_font_rid, const Transform2D &p_transform) = 0;
virtual Transform2D font_get_transform(const RID &p_font_rid) const = 0;
Add options to embolden and transform font outlines to simulate bold and italic typefaces.
2022-03-11 07:31:16 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void font_set_variation_coordinates(const RID &p_font_rid, const Dictionary &p_variation_coordinates) = 0;
virtual Dictionary font_get_variation_coordinates(const RID &p_font_rid) const = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void font_set_oversampling(const RID &p_font_rid, double p_oversampling) = 0;
virtual double font_get_oversampling(const RID &p_font_rid) const = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Replace Array return types with TypedArray
2022-08-05 01:41:48 +00:00
virtual TypedArray<Vector2i> font_get_size_cache_list(const RID &p_font_rid) const = 0;
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void font_clear_size_cache(const RID &p_font_rid) = 0;
virtual void font_remove_size_cache(const RID &p_font_rid, const Vector2i &p_size) = 0;
[TextServer] Restore character and space extra spacing support.
2021-02-15 08:46:23 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void font_set_ascent(const RID &p_font_rid, int64_t p_size, double p_ascent) = 0;
virtual double font_get_ascent(const RID &p_font_rid, int64_t p_size) const = 0;
[TextServer] Restore character and space extra spacing support.
2021-02-15 08:46:23 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void font_set_descent(const RID &p_font_rid, int64_t p_size, double p_descent) = 0;
virtual double font_get_descent(const RID &p_font_rid, int64_t p_size) const = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void font_set_underline_position(const RID &p_font_rid, int64_t p_size, double p_underline_position) = 0;
virtual double font_get_underline_position(const RID &p_font_rid, int64_t p_size) const = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void font_set_underline_thickness(const RID &p_font_rid, int64_t p_size, double p_underline_thickness) = 0;
virtual double font_get_underline_thickness(const RID &p_font_rid, int64_t p_size) const = 0;
[Complex Text Layouts] Add variable fonts support.
2020-10-22 16:40:18 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void font_set_scale(const RID &p_font_rid, int64_t p_size, double p_scale) = 0;
virtual double font_get_scale(const RID &p_font_rid, int64_t p_size) const = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual int64_t font_get_texture_count(const RID &p_font_rid, const Vector2i &p_size) const = 0;
virtual void font_clear_textures(const RID &p_font_rid, const Vector2i &p_size) = 0;
virtual void font_remove_texture(const RID &p_font_rid, const Vector2i &p_size, int64_t p_texture_index) = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void font_set_texture_image(const RID &p_font_rid, const Vector2i &p_size, int64_t p_texture_index, const Ref<Image> &p_image) = 0;
virtual Ref<Image> font_get_texture_image(const RID &p_font_rid, const Vector2i &p_size, int64_t p_texture_index) const = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void font_set_texture_offsets(const RID &p_font_rid, const Vector2i &p_size, int64_t p_texture_index, const PackedInt32Array &p_offset) = 0;
virtual PackedInt32Array font_get_texture_offsets(const RID &p_font_rid, const Vector2i &p_size, int64_t p_texture_index) const = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Replace Array return types with TypedArray
2022-08-05 01:41:48 +00:00
virtual PackedInt32Array font_get_glyph_list(const RID &p_font_rid, const Vector2i &p_size) const = 0;
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void font_clear_glyphs(const RID &p_font_rid, const Vector2i &p_size) = 0;
virtual void font_remove_glyph(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph) = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual Vector2 font_get_glyph_advance(const RID &p_font_rid, int64_t p_size, int64_t p_glyph) const = 0;
virtual void font_set_glyph_advance(const RID &p_font_rid, int64_t p_size, int64_t p_glyph, const Vector2 &p_advance) = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual Vector2 font_get_glyph_offset(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph) const = 0;
virtual void font_set_glyph_offset(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph, const Vector2 &p_offset) = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual Vector2 font_get_glyph_size(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph) const = 0;
virtual void font_set_glyph_size(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph, const Vector2 &p_gl_size) = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual Rect2 font_get_glyph_uv_rect(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph) const = 0;
virtual void font_set_glyph_uv_rect(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph, const Rect2 &p_uv_rect) = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual int64_t font_get_glyph_texture_idx(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph) const = 0;
virtual void font_set_glyph_texture_idx(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph, int64_t p_texture_idx) = 0;
Implement Label3D node. Add "generate_mipmap" font import option. Add some missing features to the Sprite3D. Move BiDi override code from Control to TextServer. Add functions to access TextServer font cache textures. Add MSDF related flags and shader to the standard material. Change standard material cache to use HashMap instead of Vector.
2022-04-19 10:27:18 +00:00
virtual RID font_get_glyph_texture_rid(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph) const = 0;
virtual Size2 font_get_glyph_texture_size(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph) const = 0;
[Complex Text Layouts] Provide access to glyph contour points.
2020-12-10 15:30:25 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual Dictionary font_get_glyph_contours(const RID &p_font, int64_t p_size, int64_t p_index) const = 0;
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
Replace Array return types with TypedArray
2022-08-05 01:41:48 +00:00
virtual TypedArray<Vector2i> font_get_kerning_list(const RID &p_font_rid, int64_t p_size) const = 0;
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void font_clear_kerning_map(const RID &p_font_rid, int64_t p_size) = 0;
virtual void font_remove_kerning(const RID &p_font_rid, int64_t p_size, const Vector2i &p_glyph_pair) = 0;
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void font_set_kerning(const RID &p_font_rid, int64_t p_size, const Vector2i &p_glyph_pair, const Vector2 &p_kerning) = 0;
virtual Vector2 font_get_kerning(const RID &p_font_rid, int64_t p_size, const Vector2i &p_glyph_pair) const = 0;
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual int64_t font_get_glyph_index(const RID &p_font_rid, int64_t p_size, int64_t p_char, int64_t p_variation_selector) const = 0;
[Font] Implement `get_char_from_glyph_index` function.
2023-02-27 14:21:28 +00:00
virtual int64_t font_get_char_from_glyph_index(const RID &p_font_rid, int64_t p_size, int64_t p_glyph_index) const = 0;
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual bool font_has_char(const RID &p_font_rid, int64_t p_char) const = 0;
virtual String font_get_supported_chars(const RID &p_font_rid) const = 0;
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void font_render_range(const RID &p_font, const Vector2i &p_size, int64_t p_start, int64_t p_end) = 0;
virtual void font_render_glyph(const RID &p_font_rid, const Vector2i &p_size, int64_t p_index) = 0;
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void font_draw_glyph(const RID &p_font, const RID &p_canvas, int64_t p_size, const Vector2 &p_pos, int64_t p_index, const Color &p_color = Color(1, 1, 1)) const = 0;
virtual void font_draw_glyph_outline(const RID &p_font, const RID &p_canvas, int64_t p_size, int64_t p_outline_size, const Vector2 &p_pos, int64_t p_index, const Color &p_color = Color(1, 1, 1)) const = 0;
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual bool font_is_language_supported(const RID &p_font_rid, const String &p_language) const = 0;
virtual void font_set_language_support_override(const RID &p_font_rid, const String &p_language, bool p_supported) = 0;
virtual bool font_get_language_support_override(const RID &p_font_rid, const String &p_language) = 0;
virtual void font_remove_language_support_override(const RID &p_font_rid, const String &p_language) = 0;
virtual PackedStringArray font_get_language_support_overrides(const RID &p_font_rid) = 0;
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual bool font_is_script_supported(const RID &p_font_rid, const String &p_script) const = 0;
virtual void font_set_script_support_override(const RID &p_font_rid, const String &p_script, bool p_supported) = 0;
virtual bool font_get_script_support_override(const RID &p_font_rid, const String &p_script) = 0;
virtual void font_remove_script_support_override(const RID &p_font_rid, const String &p_script) = 0;
virtual PackedStringArray font_get_script_support_overrides(const RID &p_font_rid) = 0;
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void font_set_opentype_feature_overrides(const RID &p_font_rid, const Dictionary &p_overrides) = 0;
virtual Dictionary font_get_opentype_feature_overrides(const RID &p_font_rid) const = 0;
[TextServer] Improve ligature cursor handling. Fix mid-grapheme hit test. Fix OpenType features property handling, add default features override option. Enable mid-grapheme cursor by default.
2021-11-18 21:36:22 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual Dictionary font_supported_feature_list(const RID &p_font_rid) const = 0;
virtual Dictionary font_supported_variation_list(const RID &p_font_rid) const = 0;
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual double font_get_global_oversampling() const = 0;
virtual void font_set_global_oversampling(double p_oversampling) = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual Vector2 get_hex_code_box_size(int64_t p_size, int64_t p_index) const;
virtual void draw_hex_code_box(const RID &p_canvas, int64_t p_size, const Vector2 &p_pos, int64_t p_index, const Color &p_color) const;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
/* Shaped text buffer interface */
virtual RID create_shaped_text(Direction p_direction = DIRECTION_AUTO, Orientation p_orientation = ORIENTATION_HORIZONTAL) = 0;
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void shaped_text_clear(const RID &p_shaped) = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void shaped_text_set_direction(const RID &p_shaped, Direction p_direction = DIRECTION_AUTO) = 0;
virtual Direction shaped_text_get_direction(const RID &p_shaped) const = 0;
virtual Direction shaped_text_get_inferred_direction(const RID &p_shaped) const = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void shaped_text_set_bidi_override(const RID &p_shaped, const Array &p_override) = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void shaped_text_set_custom_punctuation(const RID &p_shaped, const String &p_punct) = 0;
virtual String shaped_text_get_custom_punctuation(const RID &p_shaped) const = 0;
[Text Server] Add support for user defined punctuation list, used for word breaking.
2021-03-06 09:52:16 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void shaped_text_set_orientation(const RID &p_shaped, Orientation p_orientation = ORIENTATION_HORIZONTAL) = 0;
virtual Orientation shaped_text_get_orientation(const RID &p_shaped) const = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void shaped_text_set_preserve_invalid(const RID &p_shaped, bool p_enabled) = 0;
virtual bool shaped_text_get_preserve_invalid(const RID &p_shaped) const = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void shaped_text_set_preserve_control(const RID &p_shaped, bool p_enabled) = 0;
virtual bool shaped_text_get_preserve_control(const RID &p_shaped) const = 0;
Refactor Font configuration and import UI, and Font resources.
2022-05-09 09:47:10 +00:00
virtual void shaped_text_set_spacing(const RID &p_shaped, SpacingType p_spacing, int64_t p_value) = 0;
virtual int64_t shaped_text_get_spacing(const RID &p_shaped, SpacingType p_spacing) const = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Change Array arguments to TypedArray
2022-08-31 17:24:04 +00:00
virtual bool shaped_text_add_string(const RID &p_shaped, const String &p_text, const TypedArray<RID> &p_fonts, int64_t p_size, const Dictionary &p_opentype_features = Dictionary(), const String &p_language = "", const Variant &p_meta = Variant()) = 0;
Fix text server GDExtension build.
2023-01-31 09:08:11 +00:00
virtual bool shaped_text_add_object(const RID &p_shaped, const Variant &p_key, const Size2 &p_size, InlineAlignment p_inline_align = INLINE_ALIGNMENT_CENTER, int64_t p_length = 1, double p_baseline = 0.0) = 0;
virtual bool shaped_text_resize_object(const RID &p_shaped, const Variant &p_key, const Size2 &p_size, InlineAlignment p_inline_align = INLINE_ALIGNMENT_CENTER, double p_baseline = 0.0) = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual int64_t shaped_get_span_count(const RID &p_shaped) const = 0;
virtual Variant shaped_get_span_meta(const RID &p_shaped, int64_t p_index) const = 0;
Change Array arguments to TypedArray
2022-08-31 17:24:04 +00:00
virtual void shaped_set_span_update_font(const RID &p_shaped, int64_t p_index, const TypedArray<RID> &p_fonts, int64_t p_size, const Dictionary &p_opentype_features = Dictionary()) = 0;
[TextServer] Add function to change font, font size, and OpenType features without invalidating line break points, justification points, or recreating shaped text buffer.
2022-01-20 07:30:42 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual RID shaped_text_substr(const RID &p_shaped, int64_t p_start, int64_t p_length) const = 0; // Copy shaped substring (e.g. line break) without reshaping, but correctly reordered, preservers range.
virtual RID shaped_text_get_parent(const RID &p_shaped) const = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
virtual double shaped_text_fit_to_width(const RID &p_shaped, double p_width, BitField<TextServer::JustificationFlag> p_jst_flags = JUSTIFICATION_WORD_BOUND | JUSTIFICATION_KASHIDA) = 0;
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual double shaped_text_tab_align(const RID &p_shaped, const PackedFloat32Array &p_tab_stops) = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual bool shaped_text_shape(const RID &p_shaped) = 0;
virtual bool shaped_text_update_breaks(const RID &p_shaped) = 0;
virtual bool shaped_text_update_justification_ops(const RID &p_shaped) = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual bool shaped_text_is_ready(const RID &p_shaped) const = 0;
Expose TextServer justification flags to Label, Label3D, TextMesh and RTL. Add flags to control last/single line justification.
2023-03-23 09:22:37 +00:00
bool shaped_text_has_visible_chars(const RID &p_shaped) const;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual const Glyph *shaped_text_get_glyphs(const RID &p_shaped) const = 0;
Replace Array return types with TypedArray 3
2022-08-07 22:52:20 +00:00
TypedArray<Dictionary> _shaped_text_get_glyphs_wrapper(const RID &p_shaped) const;
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual const Glyph *shaped_text_sort_logical(const RID &p_shaped) = 0;
Replace Array return types with TypedArray 3
2022-08-07 22:52:20 +00:00
TypedArray<Dictionary> _shaped_text_sort_logical_wrapper(const RID &p_shaped);
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual int64_t shaped_text_get_glyph_count(const RID &p_shaped) const = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual Vector2i shaped_text_get_range(const RID &p_shaped) const = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
virtual PackedInt32Array shaped_text_get_line_breaks_adv(const RID &p_shaped, const PackedFloat32Array &p_width, int64_t p_start = 0, bool p_once = true, BitField<TextServer::LineBreakFlag> p_break_flags = BREAK_MANDATORY | BREAK_WORD_BOUND) const;
virtual PackedInt32Array shaped_text_get_line_breaks(const RID &p_shaped, double p_width, int64_t p_start = 0, BitField<TextServer::LineBreakFlag> p_break_flags = BREAK_MANDATORY | BREAK_WORD_BOUND) const;
virtual PackedInt32Array shaped_text_get_word_breaks(const RID &p_shaped, BitField<TextServer::GraphemeFlag> p_grapheme_flags = GRAPHEME_IS_SPACE | GRAPHEME_IS_PUNCTUATION) const;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual int64_t shaped_text_get_trim_pos(const RID &p_shaped) const = 0;
virtual int64_t shaped_text_get_ellipsis_pos(const RID &p_shaped) const = 0;
virtual const Glyph *shaped_text_get_ellipsis_glyphs(const RID &p_shaped) const = 0;
Replace Array return types with TypedArray 3
2022-08-07 22:52:20 +00:00
TypedArray<Dictionary> _shaped_text_get_ellipsis_glyphs_wrapper(const RID &p_shaped) const;
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual int64_t shaped_text_get_ellipsis_glyph_count(const RID &p_shaped) const = 0;
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
virtual void shaped_text_overrun_trim_to_width(const RID &p_shaped, double p_width, BitField<TextServer::TextOverrunFlag> p_trim_flags) = 0;
Improvements to Label's layout options - Added options to trim the text in case it overruns - Added more autowrap modes - Improved line breaking, which ignores trailing spaces
2021-07-04 14:43:55 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual Array shaped_text_get_objects(const RID &p_shaped) const = 0;
virtual Rect2 shaped_text_get_object_rect(const RID &p_shaped, const Variant &p_key) const = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual Size2 shaped_text_get_size(const RID &p_shaped) const = 0;
virtual double shaped_text_get_ascent(const RID &p_shaped) const = 0;
virtual double shaped_text_get_descent(const RID &p_shaped) const = 0;
virtual double shaped_text_get_width(const RID &p_shaped) const = 0;
virtual double shaped_text_get_underline_position(const RID &p_shaped) const = 0;
virtual double shaped_text_get_underline_thickness(const RID &p_shaped) const = 0;
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual Direction shaped_text_get_dominant_direction_in_range(const RID &p_shaped, int64_t p_start, int64_t p_end) const;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual CaretInfo shaped_text_get_carets(const RID &p_shaped, int64_t p_position) const;
Dictionary _shaped_text_get_carets_wrapper(const RID &p_shaped, int64_t p_position) const;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual Vector<Vector2> shaped_text_get_selection(const RID &p_shaped, int64_t p_start, int64_t p_end) const;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual int64_t shaped_text_hit_test_grapheme(const RID &p_shaped, double p_coords) const; // Return grapheme index.
virtual int64_t shaped_text_hit_test_position(const RID &p_shaped, double p_coords) const; // Return caret/selection position.
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual Vector2 shaped_text_get_grapheme_bounds(const RID &p_shaped, int64_t p_pos) const;
virtual int64_t shaped_text_next_grapheme_pos(const RID &p_shaped, int64_t p_pos) const;
virtual int64_t shaped_text_prev_grapheme_pos(const RID &p_shaped, int64_t p_pos) const;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
// The pen position is always placed on the baseline and moveing left to right.
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual void shaped_text_draw(const RID &p_shaped, const RID &p_canvas, const Vector2 &p_pos, double p_clip_l = -1.0, double p_clip_r = -1.0, const Color &p_color = Color(1, 1, 1)) const;
virtual void shaped_text_draw_outline(const RID &p_shaped, const RID &p_canvas, const Vector2 &p_pos, double p_clip_l = -1.0, double p_clip_r = -1.0, int64_t p_outline_size = 1, const Color &p_color = Color(1, 1, 1)) const;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
// Number conversion.
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
virtual String format_number(const String &p_string, const String &p_language = "") const = 0;
virtual String parse_number(const String &p_string, const String &p_language = "") const = 0;
virtual String percent_sign(const String &p_language = "") const = 0;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Implement text-to-speech support on Android, iOS, HTML5, Linux, macOS and Windows. Implement TextServer word break method.
2021-11-04 12:33:37 +00:00
// String functions.
Fix text server GDExtension build.
2023-01-31 09:08:11 +00:00
virtual PackedInt32Array string_get_word_breaks(const String &p_string, const String &p_language = "", int64_t p_chars_per_line = 0) const = 0;
Implement text-to-speech support on Android, iOS, HTML5, Linux, macOS and Windows. Implement TextServer word break method.
2021-11-04 12:33:37 +00:00
[GDExtension] Implement support for typed arrays.
2022-08-25 09:35:30 +00:00
virtual int64_t is_confusable(const String &p_string, const PackedStringArray &p_dict) const { return -1; };
[TextServer] Add ICU Unicode security and spoofing detection.
2021-11-12 08:12:37 +00:00
virtual bool spoof_check(const String &p_string) const { return false; };
Implement TextServer `strip_diacritics` function.
2021-10-12 18:36:08 +00:00
virtual String strip_diacritics(const String &p_string) const;
[TextServer] Implement ICU/UAX 31 based `is_valid_identifier` function.
2021-10-18 12:07:11 +00:00
virtual bool is_valid_identifier(const String &p_string) const;
Implement TextServer `strip_diacritics` function.
2021-10-12 18:36:08 +00:00
[TextServer] Implement locale and context sensitive case conversion functions.
2022-01-17 08:54:45 +00:00
// Other string operations.
virtual String string_to_upper(const String &p_string, const String &p_language = "") const = 0;
virtual String string_to_lower(const String &p_string, const String &p_language = "") const = 0;
Implement BiDi override mode for GDScript source.
2023-01-18 07:33:35 +00:00
TypedArray<Vector3i> parse_structured_text(StructuredTextParser p_parser_type, const Array &p_args, const String &p_text) const;
Implement Label3D node. Add "generate_mipmap" font import option. Add some missing features to the Sprite3D. Move BiDi override code from Control to TextServer. Add functions to access TextServer font cache textures. Add MSDF related flags and shader to the standard material. Change standard material cache to use HashMap instead of Vector.
2022-04-19 10:27:18 +00:00
Use system fonts as fallback and improve system font handling. Add support for font weight and stretch selection when using system fonts. Add function to get system fallback font from a font name, style, text, and language code. Implement system font support for Android. Use system fonts as a last resort fallback.
2022-11-21 13:04:01 +00:00
virtual void cleanup() {}
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
TextServer();
~TextServer();
};
/*************************************************************************/
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
struct Glyph {
int start = -1; // Start offset in the source string.
int end = -1; // End offset in the source string.
[Complex Text Layouts] Provide access to glyph contour points.
2020-12-10 15:30:25 +00:00
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
uint8_t count = 0; // Number of glyphs in the grapheme, set in the first glyph only.
uint8_t repeat = 1; // Draw multiple times in the row.
uint16_t flags = 0; // Grapheme flags (valid, rtl, virtual), set in the first glyph only.
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
float x_off = 0.f; // Offset from the origin of the glyph on baseline.
float y_off = 0.f;
float advance = 0.f; // Advance to the next glyph along baseline(x for horizontal layout, y for vertical).
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
RID font_rid; // Font resource.
int font_size = 0; // Font size;
int32_t index = 0; // Glyph index (font specific) or UTF-32 codepoint (for the invalid glyphs).
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
bool operator==(const Glyph &p_a) const;
bool operator!=(const Glyph &p_a) const;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
bool operator<(const Glyph &p_a) const;
bool operator>(const Glyph &p_a) const;
};
struct CaretInfo {
Rect2 l_caret;
Rect2 t_caret;
TextServer::Direction l_dir;
TextServer::Direction t_dir;
};
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
/*************************************************************************/
class TextServerManager : public Object {
GDCLASS(TextServerManager, Object);
protected:
static void _bind_methods();
private:
static TextServerManager *singleton;
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
Ref<TextServer> primary_interface;
Vector<Ref<TextServer>> interfaces;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
public:
_FORCE_INLINE_ static TextServerManager *get_singleton() {
return singleton;
}
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
void add_interface(const Ref<TextServer> &p_interface);
void remove_interface(const Ref<TextServer> &p_interface);
int get_interface_count() const;
Ref<TextServer> get_interface(int p_index) const;
Ref<TextServer> find_interface(const String &p_name) const;
Replace Array return types with TypedArray 3
2022-08-07 22:52:20 +00:00
TypedArray<Dictionary> get_interfaces() const;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
_FORCE_INLINE_ Ref<TextServer> get_primary_interface() const {
return primary_interface;
}
void set_primary_interface(const Ref<TextServer> &p_primary_interface);
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
TextServerManager();
~TextServerManager();
};
/*************************************************************************/
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
#define TS TextServerManager::get_singleton()->get_primary_interface()
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Move duplicate AutoWrap, Overrun and VisibleChar behavior enums to the TextServer.
2022-06-15 08:01:45 +00:00
VARIANT_ENUM_CAST(TextServer::VisibleCharactersBehavior);
VARIANT_ENUM_CAST(TextServer::AutowrapMode);
VARIANT_ENUM_CAST(TextServer::OverrunBehavior);
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
VARIANT_ENUM_CAST(TextServer::Direction);
VARIANT_ENUM_CAST(TextServer::Orientation);
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
VARIANT_BITFIELD_CAST(TextServer::JustificationFlag);
VARIANT_BITFIELD_CAST(TextServer::LineBreakFlag);
VARIANT_BITFIELD_CAST(TextServer::TextOverrunFlag);
VARIANT_BITFIELD_CAST(TextServer::GraphemeFlag);
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
VARIANT_ENUM_CAST(TextServer::Hinting);
Add sub-pixel glyph positioning support.
2022-01-10 08:13:22 +00:00
VARIANT_ENUM_CAST(TextServer::SubpixelPositioning);
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
VARIANT_ENUM_CAST(TextServer::Feature);
[Complex Text Layouts] Provide access to glyph contour points.
2020-12-10 15:30:25 +00:00
VARIANT_ENUM_CAST(TextServer::ContourPointTag);
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
VARIANT_ENUM_CAST(TextServer::SpacingType);
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
VARIANT_BITFIELD_CAST(TextServer::FontStyle);
Implement Label3D node. Add "generate_mipmap" font import option. Add some missing features to the Sprite3D. Move BiDi override code from Control to TextServer. Add functions to access TextServer font cache textures. Add MSDF related flags and shader to the standard material. Change standard material cache to use HashMap instead of Vector.
2022-04-19 10:27:18 +00:00
VARIANT_ENUM_CAST(TextServer::StructuredTextParser);
Add font LCD sub-pixel anti-aliasing support.
2022-08-12 11:03:28 +00:00
VARIANT_ENUM_CAST(TextServer::FontAntialiasing);
VARIANT_ENUM_CAST(TextServer::FontLCDSubpixelLayout);
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
GDVIRTUAL_NATIVE_PTR(Glyph);
GDVIRTUAL_NATIVE_PTR(CaretInfo);
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
#endif // TEXT_SERVER_H