mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-12-27 11:24:59 +08:00
Code Issues Packages Projects Releases Wiki Activity
4457b11ff0
godot/scene/resources/font.h

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

557 lines
27 KiB
C++
Raw Normal View History

GODOT IS OPEN SOURCE
2014-02-10 09:10:30 +08:00
/**************************************************************************/
/* font.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. */
/**************************************************************************/
Add missing copyright headers and fix formatting Using `misc/scripts/fix_headers.py` on all Godot files. Some missing header guards were added, and the header inclusion order was fixed in the Bullet module.
2018-01-05 07:50:27 +08:00
GODOT IS OPEN SOURCE
2014-02-10 09:10:30 +08:00
#ifndef FONT_H
#define FONT_H
Reorganized core/ directory, it was too fatty already -Removed FuncRef, since Callable makes it obsolete -Removed int_types.h as its obsolete in c++11+ -Changed color names code
2020-11-08 06:33:38 +08:00
#include "core/io/resource.h"
[Complex Text Layouts] Refactor Font class, default themes and controls to use Text Server interface. Implement interface mirroring. Add TextLine and TextParagraph classes. Handle UTF-16 input on macOS and Windows.
2020-09-03 19:22:16 +08:00
#include "core/templates/lru.h"
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 21:04:37 +08:00
#include "core/templates/rb_map.h"
GODOT IS OPEN SOURCE
2014-02-10 09:10:30 +08:00
#include "scene/resources/texture.h"
[Complex Text Layouts] Refactor Font class, default themes and controls to use Text Server interface. Implement interface mirroring. Add TextLine and TextParagraph classes. Handle UTF-16 input on macOS and Windows.
2020-09-03 19:22:16 +08:00
#include "servers/text_server.h"
move Font to BitmapFont so we can add DynamicFont later..
2016-04-29 09:21:18 +08:00
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
class TextLine;
class TextParagraph;
/*************************************************************************/
Implement support for loading system fonts on Linux, macOS / iOS and Windows.
2022-07-08 20:38:30 +08:00
/* Font */
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
/*************************************************************************/
class Font : public Resource {
GDCLASS(Font, Resource);
[Font] Use key structure instead of raw hash for LRU cache to avoid collisions.
2022-12-24 17:46:40 +08:00
struct ShapedTextKey {
String text;
int font_size = 14;
float width = 0.f;
BitField<TextServer::JustificationFlag> jst_flags = TextServer::JUSTIFICATION_NONE;
BitField<TextServer::LineBreakFlag> brk_flags = TextServer::BREAK_MANDATORY;
TextServer::Direction direction = TextServer::DIRECTION_AUTO;
TextServer::Orientation orientation = TextServer::ORIENTATION_HORIZONTAL;
bool operator==(const ShapedTextKey &p_b) const {
return (font_size == p_b.font_size) && (width == p_b.width) && (jst_flags == p_b.jst_flags) && (brk_flags == p_b.brk_flags) && (direction == p_b.direction) && (orientation == p_b.orientation) && (text == p_b.text);
}
ShapedTextKey() {}
ShapedTextKey(const String &p_text, int p_font_size, float p_width, BitField<TextServer::JustificationFlag> p_jst_flags, BitField<TextServer::LineBreakFlag> p_brk_flags, TextServer::Direction p_direction, TextServer::Orientation p_orientation) {
text = p_text;
font_size = p_font_size;
width = p_width;
jst_flags = p_jst_flags;
brk_flags = p_brk_flags;
direction = p_direction;
orientation = p_orientation;
}
};
struct ShapedTextKeyHasher {
_FORCE_INLINE_ static uint32_t hash(const ShapedTextKey &p_a) {
uint32_t hash = p_a.text.hash();
hash = hash_murmur3_one_32(p_a.font_size, hash);
hash = hash_murmur3_one_float(p_a.width, hash);
hash = hash_murmur3_one_32(p_a.brk_flags | (p_a.jst_flags << 6) | (p_a.direction << 12) | (p_a.orientation << 15), hash);
return hash_fmix32(hash);
}
};
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
// Shaped string cache.
[Font] Use key structure instead of raw hash for LRU cache to avoid collisions.
2022-12-24 17:46:40 +08:00
mutable LRUCache<ShapedTextKey, Ref<TextLine>, ShapedTextKeyHasher> cache;
mutable LRUCache<ShapedTextKey, Ref<TextParagraph>, ShapedTextKeyHasher> cache_wrap;
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
protected:
// Output.
mutable TypedArray<RID> rids;
mutable bool dirty_rids = true;
// Fallbacks.
static constexpr int MAX_FALLBACK_DEPTH = 64;
TypedArray<Font> fallbacks;
static void _bind_methods();
virtual void _update_rids_fb(const Ref<Font> &p_f, int p_depth) const;
virtual void _update_rids() const;
virtual void reset_state() override;
[Text Server] Store extra spacing of individual font variations.
2023-08-24 16:56:50 +08:00
#ifndef DISABLE_DEPRECATED
RID _find_variation_compat_80954(const Dictionary &p_variation_coordinates, int p_face_index = 0, float p_strength = 0.0, Transform2D p_transform = Transform2D()) const;
[TextServer / Font] Add support for customizable baseline offset.
2024-01-28 18:34:56 +08:00
RID _find_variation_compat_87668(const Dictionary &p_variation_coordinates, int p_face_index = 0, float p_strength = 0.0, Transform2D p_transform = Transform2D(), int p_spacing_top = 0, int p_spacing_bottom = 0, int p_spacing_space = 0, int p_spacing_glyph = 0) const;
[Text Server] Store extra spacing of individual font variations.
2023-08-24 16:56:50 +08:00
static void _bind_compatibility_methods();
#endif
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
public:
[Font] Add check for cyclic base font dependencies.
2024-08-03 01:46:39 +08:00
virtual bool _is_cyclic(const Ref<Font> &p_f, int p_depth) const;
virtual bool _is_base_cyclic(const Ref<Font> &p_f, int p_depth) const;
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
virtual void _invalidate_rids();
static constexpr int DEFAULT_FONT_SIZE = 16;
// Fallbacks.
virtual void set_fallbacks(const TypedArray<Font> &p_fallbacks);
virtual TypedArray<Font> get_fallbacks() const;
// Output.
[TextServer / Font] Add support for customizable baseline offset.
2024-01-28 18:34:56 +08:00
virtual RID find_variation(const Dictionary &p_variation_coordinates, int p_face_index = 0, float p_strength = 0.0, Transform2D p_transform = Transform2D(), int p_spacing_top = 0, int p_spacing_bottom = 0, int p_spacing_space = 0, int p_spacing_glyph = 0, float p_baseline_offset = 0.0) const { return RID(); }
virtual RID _get_rid() const { return RID(); }
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
virtual TypedArray<RID> get_rids() const;
// Font metrics.
virtual real_t get_height(int p_font_size) const;
virtual real_t get_ascent(int p_font_size) const;
virtual real_t get_descent(int p_font_size) const;
virtual real_t get_underline_position(int p_font_size) const;
virtual real_t get_underline_thickness(int p_font_size) const;
virtual String get_font_name() const;
virtual String get_font_style_name() const;
[TextServer] Add support for retrieving OpenType name strings.
2023-04-05 17:49:38 +08:00
virtual Dictionary get_ot_name_strings() const;
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 17:40:31 +08:00
virtual BitField<TextServer::FontStyle> get_font_style() const;
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 21:04:01 +08:00
virtual int get_font_weight() const;
virtual int get_font_stretch() const;
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
[TextServer / Font] Add support for customizable baseline offset.
2024-01-28 18:34:56 +08:00
virtual int get_spacing(TextServer::SpacingType p_spacing) const { return 0; }
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
virtual Dictionary get_opentype_features() const;
// Drawing string.
virtual void set_cache_capacity(int p_single_line, int p_multi_line);
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 17:40:31 +08:00
virtual Size2 get_string_size(const String &p_text, HorizontalAlignment p_alignment = HORIZONTAL_ALIGNMENT_LEFT, float p_width = -1, int p_font_size = DEFAULT_FONT_SIZE, BitField<TextServer::JustificationFlag> p_jst_flags = TextServer::JUSTIFICATION_KASHIDA | TextServer::JUSTIFICATION_WORD_BOUND, TextServer::Direction p_direction = TextServer::DIRECTION_AUTO, TextServer::Orientation p_orientation = TextServer::ORIENTATION_HORIZONTAL) const;
virtual Size2 get_multiline_string_size(const String &p_text, HorizontalAlignment p_alignment = HORIZONTAL_ALIGNMENT_LEFT, float p_width = -1, int p_font_size = DEFAULT_FONT_SIZE, int p_max_lines = -1, BitField<TextServer::LineBreakFlag> p_brk_flags = TextServer::BREAK_MANDATORY | TextServer::BREAK_WORD_BOUND, BitField<TextServer::JustificationFlag> p_jst_flags = TextServer::JUSTIFICATION_KASHIDA | TextServer::JUSTIFICATION_WORD_BOUND, TextServer::Direction p_direction = TextServer::DIRECTION_AUTO, TextServer::Orientation p_orientation = TextServer::ORIENTATION_HORIZONTAL) const;
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 17:40:31 +08:00
virtual void draw_string(RID p_canvas_item, const Point2 &p_pos, const String &p_text, HorizontalAlignment p_alignment = HORIZONTAL_ALIGNMENT_LEFT, float p_width = -1, int p_font_size = DEFAULT_FONT_SIZE, const Color &p_modulate = Color(1.0, 1.0, 1.0), BitField<TextServer::JustificationFlag> p_jst_flags = TextServer::JUSTIFICATION_KASHIDA | TextServer::JUSTIFICATION_WORD_BOUND, TextServer::Direction p_direction = TextServer::DIRECTION_AUTO, TextServer::Orientation p_orientation = TextServer::ORIENTATION_HORIZONTAL) const;
virtual void draw_multiline_string(RID p_canvas_item, const Point2 &p_pos, const String &p_text, HorizontalAlignment p_alignment = HORIZONTAL_ALIGNMENT_LEFT, float p_width = -1, int p_font_size = DEFAULT_FONT_SIZE, int p_max_lines = -1, const Color &p_modulate = Color(1.0, 1.0, 1.0), BitField<TextServer::LineBreakFlag> p_brk_flags = TextServer::BREAK_MANDATORY | TextServer::BREAK_WORD_BOUND, BitField<TextServer::JustificationFlag> p_jst_flags = TextServer::JUSTIFICATION_KASHIDA | TextServer::JUSTIFICATION_WORD_BOUND, TextServer::Direction p_direction = TextServer::DIRECTION_AUTO, TextServer::Orientation p_orientation = TextServer::ORIENTATION_HORIZONTAL) const;
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 17:40:31 +08:00
virtual void draw_string_outline(RID p_canvas_item, const Point2 &p_pos, const String &p_text, HorizontalAlignment p_alignment = HORIZONTAL_ALIGNMENT_LEFT, float p_width = -1, int p_font_size = DEFAULT_FONT_SIZE, int p_size = 1, const Color &p_modulate = Color(1.0, 1.0, 1.0), BitField<TextServer::JustificationFlag> p_jst_flags = TextServer::JUSTIFICATION_KASHIDA | TextServer::JUSTIFICATION_WORD_BOUND, TextServer::Direction p_direction = TextServer::DIRECTION_AUTO, TextServer::Orientation p_orientation = TextServer::ORIENTATION_HORIZONTAL) const;
virtual void draw_multiline_string_outline(RID p_canvas_item, const Point2 &p_pos, const String &p_text, HorizontalAlignment p_alignment = HORIZONTAL_ALIGNMENT_LEFT, float p_width = -1, int p_font_size = DEFAULT_FONT_SIZE, int p_max_lines = -1, int p_size = 1, const Color &p_modulate = Color(1.0, 1.0, 1.0), BitField<TextServer::LineBreakFlag> p_brk_flags = TextServer::BREAK_MANDATORY | TextServer::BREAK_WORD_BOUND, BitField<TextServer::JustificationFlag> p_jst_flags = TextServer::JUSTIFICATION_KASHIDA | TextServer::JUSTIFICATION_WORD_BOUND, TextServer::Direction p_direction = TextServer::DIRECTION_AUTO, TextServer::Orientation p_orientation = TextServer::ORIENTATION_HORIZONTAL) const;
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
// Drawing char.
virtual Size2 get_char_size(char32_t p_char, int p_font_size = DEFAULT_FONT_SIZE) const;
virtual real_t draw_char(RID p_canvas_item, const Point2 &p_pos, char32_t p_char, int p_font_size = DEFAULT_FONT_SIZE, const Color &p_modulate = Color(1.0, 1.0, 1.0)) const;
virtual real_t draw_char_outline(RID p_canvas_item, const Point2 &p_pos, char32_t p_char, int p_font_size = DEFAULT_FONT_SIZE, int p_size = 1, const Color &p_modulate = Color(1.0, 1.0, 1.0)) const;
// Helper functions.
virtual bool has_char(char32_t p_char) const;
virtual String get_supported_chars() const;
virtual bool is_language_supported(const String &p_language) const;
virtual bool is_script_supported(const String &p_script) const;
virtual Dictionary get_supported_feature_list() const;
virtual Dictionary get_supported_variation_list() const;
virtual int64_t get_face_count() const;
Font();
~Font();
};
/*************************************************************************/
/* FontFile */
[Complex Text Layouts] Refactor Font class, default themes and controls to use Text Server interface. Implement interface mirroring. Add TextLine and TextParagraph classes. Handle UTF-16 input on macOS and Windows.
2020-09-03 19:22:16 +08:00
/*************************************************************************/
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
class FontFile : public Font {
GDCLASS(FontFile, Font);
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 21:30:33 +08:00
RES_BASE_EXTENSION("fontdata");
[Complex Text Layouts] Refactor Font class, default themes and controls to use Text Server interface. Implement interface mirroring. Add TextLine and TextParagraph classes. Handle UTF-16 input on macOS and Windows.
2020-09-03 19:22:16 +08: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 21:30:33 +08:00
// Font source data.
const uint8_t *data_ptr = nullptr;
size_t data_size = 0;
PackedByteArray data;
[TextServer] Restore character and space extra spacing support.
2021-02-15 16:46:23 +08:00
Add font LCD sub-pixel anti-aliasing support.
2022-08-12 19:03:28 +08:00
TextServer::FontAntialiasing antialiasing = TextServer::FONT_ANTIALIASING_GRAY;
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 18:27:18 +08:00
bool mipmaps = false;
[Font] Add option to disable embedded bitmaps loading.
2024-03-11 19:42:16 +08:00
bool disable_embedded_bitmaps = true;
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 21:30:33 +08:00
bool msdf = false;
int msdf_pixel_range = 16;
int msdf_size = 48;
int fixed_size = 0;
[Bitmap fonts] Add support for scaling.
2023-08-14 15:42:49 +08:00
TextServer::FixedSizeScaleMode fixed_size_scale_mode = TextServer::FIXED_SIZE_SCALE_DISABLE;
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 21:30:33 +08:00
bool force_autohinter = false;
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 21:04:01 +08:00
bool allow_system_fallback = true;
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 21:30:33 +08:00
TextServer::Hinting hinting = TextServer::HINTING_LIGHT;
Add sub-pixel glyph positioning support.
2022-01-10 16:13:22 +08:00
TextServer::SubpixelPositioning subpixel_positioning = TextServer::SUBPIXEL_POSITIONING_AUTO;
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 21:30:33 +08:00
real_t oversampling = 0.f;
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
#ifndef DISABLE_DEPRECATED
real_t bmp_height = 0.0;
real_t bmp_ascent = 0.0;
#endif
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 21:30:33 +08:00
// Cache.
mutable Vector<RID> cache;
_FORCE_INLINE_ void _clear_cache();
[TextServer] Store font extra spacing variations without making a full copy of font.
2023-09-28 15:45:09 +08:00
_FORCE_INLINE_ void _ensure_rid(int p_cache_index, int p_make_linked_from = -1) const;
move Font to BitmapFont so we can add DynamicFont later..
2016-04-29 09:21:18 +08:00
Move BMFont parser code from importer to the FontData to allow loading bitmap fonts in the runtime (without importing).
2021-11-09 16:41:45 +08:00
void _convert_packed_8bit(Ref<Image> &p_source, int p_page, int p_sz);
void _convert_packed_4bit(Ref<Image> &p_source, int p_page, int p_sz);
void _convert_rgba_4bit(Ref<Image> &p_source, int p_page, int p_sz);
void _convert_mono_8bit(Ref<Image> &p_source, int p_page, int p_ch, int p_sz, int p_ol);
void _convert_mono_4bit(Ref<Image> &p_source, int p_page, int p_ch, int p_sz, int p_ol);
move Font to BitmapFont so we can add DynamicFont later..
2016-04-29 09:21:18 +08:00
protected:
static void _bind_methods();
Move registration of `fallbacks` property in the base Font class
2023-06-15 22:56:22 +08:00
void _validate_property(PropertyInfo &p_property) const;
move Font to BitmapFont so we can add DynamicFont later..
2016-04-29 09:21:18 +08:00
[Complex Text Layouts] Refactor Font class, default themes and controls to use Text Server interface. Implement interface mirroring. Add TextLine and TextParagraph classes. Handle UTF-16 input on macOS and Windows.
2020-09-03 19:22:16 +08:00
bool _set(const StringName &p_name, const Variant &p_value);
bool _get(const StringName &p_name, Variant &r_ret) const;
void _get_property_list(List<PropertyInfo> *p_list) const;
Improve resource load cache -Added a new method in Resource: reset_state , used for reloading the same resource from disk -Added a new cache mode "replace" in ResourceLoader, which reuses existing loaded sub-resources but resets their data from disk (or replaces them if they chaged type) -Because the correct sub-resource paths are always loaded now, this fixes bugs with subresource folding or subresource ordering when saving.
2021-02-12 01:18:45 +08:00
virtual void reset_state() override;
move Font to BitmapFont so we can add DynamicFont later..
2016-04-29 09:21:18 +08:00
public:
[Import] Add "skip file" import option to skip (and exclude from export) importable formats, auto set it for the images used by bitmap font.
2024-02-05 18:10:37 +08:00
Error _load_bitmap_font(const String &p_path, List<String> *r_image_files);
Move BMFont parser code from importer to the FontData to allow loading bitmap fonts in the runtime (without importing).
2021-11-09 16:41:45 +08:00
Error load_bitmap_font(const String &p_path);
Error load_dynamic_font(const String &p_path);
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 21:30:33 +08:00
// Font source data.
virtual void set_data_ptr(const uint8_t *p_data, size_t p_size);
virtual void set_data(const PackedByteArray &p_data);
virtual PackedByteArray get_data() const;
move Font to BitmapFont so we can add DynamicFont later..
2016-04-29 09:21:18 +08: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 21:30:33 +08:00
// Common properties.
Add functions for getting name and font style from dynamic and bitmap fonts. Add font selection toolbar editor plugin.
2021-10-26 14:40:11 +08:00
virtual void set_font_name(const String &p_name);
virtual void set_font_style_name(const String &p_name);
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 17:40:31 +08:00
virtual void set_font_style(BitField<TextServer::FontStyle> p_style);
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 21:04:01 +08:00
virtual void set_font_weight(int p_weight);
virtual void set_font_stretch(int p_stretch);
Add functions for getting name and font style from dynamic and bitmap fonts. Add font selection toolbar editor plugin.
2021-10-26 14:40:11 +08:00
Add font LCD sub-pixel anti-aliasing support.
2022-08-12 19:03:28 +08:00
virtual void set_antialiasing(TextServer::FontAntialiasing p_antialiasing);
virtual TextServer::FontAntialiasing get_antialiasing() const;
move Font to BitmapFont so we can add DynamicFont later..
2016-04-29 09:21:18 +08:00
[Font] Add option to disable embedded bitmaps loading.
2024-03-11 19:42:16 +08:00
virtual void set_disable_embedded_bitmaps(bool p_disable_embedded_bitmaps);
virtual bool get_disable_embedded_bitmaps() 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 18:27:18 +08:00
virtual void set_generate_mipmaps(bool p_generate_mipmaps);
virtual bool get_generate_mipmaps() const;
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 21:30:33 +08:00
virtual void set_multichannel_signed_distance_field(bool p_msdf);
virtual bool is_multichannel_signed_distance_field() const;
[Text Server] Restores bitmap font dynamic construction functions.
2021-02-06 22:34:06 +08: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 21:30:33 +08:00
virtual void set_msdf_pixel_range(int p_msdf_pixel_range);
virtual int get_msdf_pixel_range() const;
[Text Server] Restores bitmap font dynamic construction functions.
2021-02-06 22:34:06 +08: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 21:30:33 +08:00
virtual void set_msdf_size(int p_msdf_size);
virtual int get_msdf_size() const;
move Font to BitmapFont so we can add DynamicFont later..
2016-04-29 09:21:18 +08: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 21:30:33 +08:00
virtual void set_fixed_size(int p_fixed_size);
virtual int get_fixed_size() const;
move Font to BitmapFont so we can add DynamicFont later..
2016-04-29 09:21:18 +08:00
[Bitmap fonts] Add support for scaling.
2023-08-14 15:42:49 +08:00
virtual void set_fixed_size_scale_mode(TextServer::FixedSizeScaleMode p_fixed_size_scale_mode);
virtual TextServer::FixedSizeScaleMode get_fixed_size_scale_mode() const;
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 21:04:01 +08:00
virtual void set_allow_system_fallback(bool p_allow_system_fallback);
virtual bool is_allow_system_fallback() const;
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 21:30:33 +08:00
virtual void set_force_autohinter(bool p_force_autohinter);
virtual bool is_force_autohinter() const;
[Complex Text Layouts] Add variable fonts support.
2020-10-23 00:40:18 +08: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 21:30:33 +08:00
virtual void set_hinting(TextServer::Hinting p_hinting);
virtual TextServer::Hinting get_hinting() const;
Perfect FreeType-based outlines for DynamicFonts - Implement outlines based on FreeType Stroker API. This allows artifact-free results, similar to what you will see in Web or any text editing tools. Outline is a part of DynamicFont rather than Label, because outlines have to be baked into the font's atlas. Font has a default outline_color and a Label can specify font_outline_modulator that will be multiplied with the Font's color to get the final result. - draw_char now has to be called twice to fully render a text - first with p_outline == true for each character and then with p_outline == false for each character. - Number of draw-calls is reduced from 5 to 2 per outlined character. - Overall cleanup of DynamicFont code, extracted duplicated code pieces into separate methods. - The change is backward-compatible - Labels still have outline properties that work exactly as they worked before. Closes #16279.
2018-03-17 16:44:34 +08:00
Add sub-pixel glyph positioning support.
2022-01-10 16:13:22 +08:00
virtual void set_subpixel_positioning(TextServer::SubpixelPositioning p_subpixel);
virtual TextServer::SubpixelPositioning get_subpixel_positioning() const;
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 21:30:33 +08:00
virtual void set_oversampling(real_t p_oversampling);
virtual real_t get_oversampling() const;
move Font to BitmapFont so we can add DynamicFont later..
2016-04-29 09:21:18 +08: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 21:30:33 +08:00
// Cache.
[TextServer / Font] Add support for customizable baseline offset.
2024-01-28 18:34:56 +08:00
virtual RID find_variation(const Dictionary &p_variation_coordinates, int p_face_index = 0, float p_strength = 0.0, Transform2D p_transform = Transform2D(), int p_spacing_top = 0, int p_spacing_bottom = 0, int p_spacing_space = 0, int p_spacing_glyph = 0, float p_baseline_offset = 0.0) const override;
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
virtual RID _get_rid() const override;
[TextServer] Restore character and space extra spacing support.
2021-02-15 16:46:23 +08: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 21:30:33 +08:00
virtual int get_cache_count() const;
virtual void clear_cache();
virtual void remove_cache(int p_cache_index);
move Font to BitmapFont so we can add DynamicFont later..
2016-04-29 09:21:18 +08:00
Replace Array return types with TypedArray
2022-08-05 09:41:48 +08:00
virtual TypedArray<Vector2i> get_size_cache_list(int p_cache_index) const;
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 21:30:33 +08:00
virtual void clear_size_cache(int p_cache_index);
virtual void remove_size_cache(int p_cache_index, const Vector2i &p_size);
Perfect FreeType-based outlines for DynamicFonts - Implement outlines based on FreeType Stroker API. This allows artifact-free results, similar to what you will see in Web or any text editing tools. Outline is a part of DynamicFont rather than Label, because outlines have to be baked into the font's atlas. Font has a default outline_color and a Label can specify font_outline_modulator that will be multiplied with the Font's color to get the final result. - draw_char now has to be called twice to fully render a text - first with p_outline == true for each character and then with p_outline == false for each character. - Number of draw-calls is reduced from 5 to 2 per outlined character. - Overall cleanup of DynamicFont code, extracted duplicated code pieces into separate methods. - The change is backward-compatible - Labels still have outline properties that work exactly as they worked before. Closes #16279.
2018-03-17 16:44:34 +08: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 21:30:33 +08:00
virtual void set_variation_coordinates(int p_cache_index, const Dictionary &p_variation_coordinates);
virtual Dictionary get_variation_coordinates(int p_cache_index) const;
Perfect FreeType-based outlines for DynamicFonts - Implement outlines based on FreeType Stroker API. This allows artifact-free results, similar to what you will see in Web or any text editing tools. Outline is a part of DynamicFont rather than Label, because outlines have to be baked into the font's atlas. Font has a default outline_color and a Label can specify font_outline_modulator that will be multiplied with the Font's color to get the final result. - draw_char now has to be called twice to fully render a text - first with p_outline == true for each character and then with p_outline == false for each character. - Number of draw-calls is reduced from 5 to 2 per outlined character. - Overall cleanup of DynamicFont code, extracted duplicated code pieces into separate methods. - The change is backward-compatible - Labels still have outline properties that work exactly as they worked before. Closes #16279.
2018-03-17 16:44:34 +08:00
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
virtual void set_embolden(int p_cache_index, float p_strength);
virtual float get_embolden(int p_cache_index) const;
virtual void set_transform(int p_cache_index, Transform2D p_transform);
virtual Transform2D get_transform(int p_cache_index) const;
[Text Server] Store extra spacing of individual font variations.
2023-08-24 16:56:50 +08:00
virtual void set_extra_spacing(int p_cache_index, TextServer::SpacingType p_spacing, int64_t p_value);
virtual int64_t get_extra_spacing(int p_cache_index, TextServer::SpacingType p_spacing) const;
[TextServer / Font] Add support for customizable baseline offset.
2024-01-28 18:34:56 +08:00
virtual float get_extra_baseline_offset(int p_cache_index) const;
virtual void set_extra_baseline_offset(int p_cache_index, float p_baseline_offset);
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
virtual void set_face_index(int p_cache_index, int64_t p_index);
virtual int64_t get_face_index(int p_cache_index) const;
Perfect FreeType-based outlines for DynamicFonts - Implement outlines based on FreeType Stroker API. This allows artifact-free results, similar to what you will see in Web or any text editing tools. Outline is a part of DynamicFont rather than Label, because outlines have to be baked into the font's atlas. Font has a default outline_color and a Label can specify font_outline_modulator that will be multiplied with the Font's color to get the final result. - draw_char now has to be called twice to fully render a text - first with p_outline == true for each character and then with p_outline == false for each character. - Number of draw-calls is reduced from 5 to 2 per outlined character. - Overall cleanup of DynamicFont code, extracted duplicated code pieces into separate methods. - The change is backward-compatible - Labels still have outline properties that work exactly as they worked before. Closes #16279.
2018-03-17 16:44:34 +08:00
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
virtual void set_cache_ascent(int p_cache_index, int p_size, real_t p_ascent);
virtual real_t get_cache_ascent(int p_cache_index, int p_size) const;
remove trailing whitespace
2016-03-09 07:00:52 +08:00
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
virtual void set_cache_descent(int p_cache_index, int p_size, real_t p_descent);
virtual real_t get_cache_descent(int p_cache_index, int p_size) const;
GODOT IS OPEN SOURCE
2014-02-10 09:10:30 +08:00
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
virtual void set_cache_underline_position(int p_cache_index, int p_size, real_t p_underline_position);
virtual real_t get_cache_underline_position(int p_cache_index, int p_size) const;
GODOT IS OPEN SOURCE
2014-02-10 09:10:30 +08:00
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
virtual void set_cache_underline_thickness(int p_cache_index, int p_size, real_t p_underline_thickness);
virtual real_t get_cache_underline_thickness(int p_cache_index, int p_size) const;
GODOT IS OPEN SOURCE
2014-02-10 09:10:30 +08:00
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
virtual void set_cache_scale(int p_cache_index, int p_size, real_t p_scale); // Rendering scale for bitmap fonts (e.g. emoji fonts).
virtual real_t get_cache_scale(int p_cache_index, int p_size) const;
GODOT IS OPEN SOURCE
2014-02-10 09:10:30 +08: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 21:30:33 +08:00
virtual int get_texture_count(int p_cache_index, const Vector2i &p_size) const;
virtual void clear_textures(int p_cache_index, const Vector2i &p_size);
virtual void remove_texture(int p_cache_index, const Vector2i &p_size, int p_texture_index);
[Complex Text Layouts] Refactor Font class, default themes and controls to use Text Server interface. Implement interface mirroring. Add TextLine and TextParagraph classes. Handle UTF-16 input on macOS and Windows.
2020-09-03 19:22:16 +08: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 21:30:33 +08:00
virtual void set_texture_image(int p_cache_index, const Vector2i &p_size, int p_texture_index, const Ref<Image> &p_image);
virtual Ref<Image> get_texture_image(int p_cache_index, const Vector2i &p_size, int p_texture_index) const;
[Complex Text Layouts] Refactor Font class, default themes and controls to use Text Server interface. Implement interface mirroring. Add TextLine and TextParagraph classes. Handle UTF-16 input on macOS and Windows.
2020-09-03 19:22:16 +08: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 21:30:33 +08:00
virtual void set_texture_offsets(int p_cache_index, const Vector2i &p_size, int p_texture_index, const PackedInt32Array &p_offset);
virtual PackedInt32Array get_texture_offsets(int p_cache_index, const Vector2i &p_size, int p_texture_index) const;
Replace Array return types with TypedArray
2022-08-05 09:41:48 +08:00
virtual PackedInt32Array get_glyph_list(int p_cache_index, const Vector2i &p_size) const;
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 21:30:33 +08:00
virtual void clear_glyphs(int p_cache_index, const Vector2i &p_size);
virtual void remove_glyph(int p_cache_index, const Vector2i &p_size, int32_t p_glyph);
virtual void set_glyph_advance(int p_cache_index, int p_size, int32_t p_glyph, const Vector2 &p_advance);
virtual Vector2 get_glyph_advance(int p_cache_index, int p_size, int32_t p_glyph) const;
virtual void set_glyph_offset(int p_cache_index, const Vector2i &p_size, int32_t p_glyph, const Vector2 &p_offset);
virtual Vector2 get_glyph_offset(int p_cache_index, const Vector2i &p_size, int32_t p_glyph) const;
virtual void set_glyph_size(int p_cache_index, const Vector2i &p_size, int32_t p_glyph, const Vector2 &p_gl_size);
virtual Vector2 get_glyph_size(int p_cache_index, const Vector2i &p_size, int32_t p_glyph) const;
virtual void set_glyph_uv_rect(int p_cache_index, const Vector2i &p_size, int32_t p_glyph, const Rect2 &p_uv_rect);
virtual Rect2 get_glyph_uv_rect(int p_cache_index, const Vector2i &p_size, int32_t p_glyph) const;
virtual void set_glyph_texture_idx(int p_cache_index, const Vector2i &p_size, int32_t p_glyph, int p_texture_idx);
virtual int get_glyph_texture_idx(int p_cache_index, const Vector2i &p_size, int32_t p_glyph) const;
[Complex Text Layouts] Refactor Font class, default themes and controls to use Text Server interface. Implement interface mirroring. Add TextLine and TextParagraph classes. Handle UTF-16 input on macOS and Windows.
2020-09-03 19:22:16 +08:00
Replace Array return types with TypedArray
2022-08-05 09:41:48 +08:00
virtual TypedArray<Vector2i> get_kerning_list(int p_cache_index, int p_size) const;
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 21:30:33 +08:00
virtual void clear_kerning_map(int p_cache_index, int p_size);
virtual void remove_kerning(int p_cache_index, int p_size, const Vector2i &p_glyph_pair);
virtual void set_kerning(int p_cache_index, int p_size, const Vector2i &p_glyph_pair, const Vector2 &p_kerning);
virtual Vector2 get_kerning(int p_cache_index, int p_size, const Vector2i &p_glyph_pair) const;
virtual void render_range(int p_cache_index, const Vector2i &p_size, char32_t p_start, char32_t p_end);
virtual void render_glyph(int p_cache_index, const Vector2i &p_size, int32_t p_index);
// Language/script support override.
virtual void set_language_support_override(const String &p_language, bool p_supported);
virtual bool get_language_support_override(const String &p_language) const;
virtual void remove_language_support_override(const String &p_language);
virtual Vector<String> get_language_support_overrides() const;
virtual void set_script_support_override(const String &p_script, bool p_supported);
virtual bool get_script_support_override(const String &p_script) const;
virtual void remove_script_support_override(const String &p_script);
virtual Vector<String> get_script_support_overrides() const;
[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-19 05:36:22 +08:00
virtual void set_opentype_feature_overrides(const Dictionary &p_overrides);
virtual Dictionary get_opentype_feature_overrides() const;
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 21:30:33 +08:00
// Base font properties.
virtual int32_t get_glyph_index(int p_size, char32_t p_char, char32_t p_variation_selector = 0x0000) const;
[Font] Implement `get_char_from_glyph_index` function.
2023-02-27 22:21:28 +08:00
virtual char32_t get_char_from_glyph_index(int p_size, int32_t p_glyph_index) const;
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 21:30:33 +08:00
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
FontFile();
~FontFile();
[Complex Text Layouts] Refactor Font class, default themes and controls to use Text Server interface. Implement interface mirroring. Add TextLine and TextParagraph classes. Handle UTF-16 input on macOS and Windows.
2020-09-03 19:22:16 +08:00
};
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
/*************************************************************************/
/* FontVariation */
[Complex Text Layouts] Refactor Font class, default themes and controls to use Text Server interface. Implement interface mirroring. Add TextLine and TextParagraph classes. Handle UTF-16 input on macOS and Windows.
2020-09-03 19:22:16 +08:00
/*************************************************************************/
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
class FontVariation : public Font {
GDCLASS(FontVariation, Font);
[Complex Text Layouts] Refactor Font class, default themes and controls to use Text Server interface. Implement interface mirroring. Add TextLine and TextParagraph classes. Handle UTF-16 input on macOS and Windows.
2020-09-03 19:22:16 +08:00
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
struct Variation {
Dictionary opentype;
real_t embolden = 0.f;
int face_index = 0;
Transform2D transform;
};
[Complex Text Layouts] Refactor Font class, default themes and controls to use Text Server interface. Implement interface mirroring. Add TextLine and TextParagraph classes. Handle UTF-16 input on macOS and Windows.
2020-09-03 19:22:16 +08:00
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
mutable Ref<Font> theme_font;
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 21:30:33 +08:00
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
Ref<Font> base_font;
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 21:30:33 +08:00
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
Variation variation;
Dictionary opentype_features;
int extra_spacing[TextServer::SPACING_MAX];
[TextServer / Font] Add support for customizable baseline offset.
2024-01-28 18:34:56 +08:00
float baseline_offset = 0.0;
remove trailing whitespace
2016-03-09 07:00:52 +08:00
GODOT IS OPEN SOURCE
2014-02-10 09:10:30 +08:00
protected:
static void _bind_methods();
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
virtual void _update_rids() const override;
remove trailing whitespace
2016-03-09 07:00:52 +08:00
Improve resource load cache -Added a new method in Resource: reset_state , used for reloading the same resource from disk -Added a new cache mode "replace" in ResourceLoader, which reuses existing loaded sub-resources but resets their data from disk (or replaces them if they chaged type) -Because the correct sub-resource paths are always loaded now, this fixes bugs with subresource folding or subresource ordering when saving.
2021-02-12 01:18:45 +08:00
virtual void reset_state() override;
[Complex Text Layouts] Refactor Font class, default themes and controls to use Text Server interface. Implement interface mirroring. Add TextLine and TextParagraph classes. Handle UTF-16 input on macOS and Windows.
2020-09-03 19:22:16 +08:00
public:
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
virtual void set_base_font(const Ref<Font> &p_font);
virtual Ref<Font> get_base_font() const;
virtual Ref<Font> _get_base_font_or_default() const;
remove trailing whitespace
2016-03-09 07:00:52 +08:00
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
virtual void set_variation_opentype(const Dictionary &p_coords);
virtual Dictionary get_variation_opentype() const;
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 21:30:33 +08:00
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
virtual void set_variation_embolden(float p_strength);
virtual float get_variation_embolden() const;
GODOT IS OPEN SOURCE
2014-02-10 09:10:30 +08:00
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
virtual void set_variation_transform(Transform2D p_transform);
virtual Transform2D get_variation_transform() const;
GODOT IS OPEN SOURCE
2014-02-10 09:10:30 +08:00
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
virtual void set_variation_face_index(int p_face_index);
virtual int get_variation_face_index() const;
added fallbacks proprty to fonts
2015-12-11 10:02:40 +08:00
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
virtual void set_opentype_features(const Dictionary &p_features);
virtual Dictionary get_opentype_features() const override;
added fallbacks proprty to fonts
2015-12-11 10:02:40 +08:00
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
virtual void set_spacing(TextServer::SpacingType p_spacing, int p_value);
virtual int get_spacing(TextServer::SpacingType p_spacing) const override;
[Complex Text Layouts] Refactor Font class, default themes and controls to use Text Server interface. Implement interface mirroring. Add TextLine and TextParagraph classes. Handle UTF-16 input on macOS and Windows.
2020-09-03 19:22:16 +08:00
[TextServer / Font] Add support for customizable baseline offset.
2024-01-28 18:34:56 +08:00
virtual float get_baseline_offset() const;
virtual void set_baseline_offset(float p_baseline_offset);
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
// Output.
[TextServer / Font] Add support for customizable baseline offset.
2024-01-28 18:34:56 +08:00
virtual RID find_variation(const Dictionary &p_variation_coordinates, int p_face_index = 0, float p_strength = 0.0, Transform2D p_transform = Transform2D(), int p_spacing_top = 0, int p_spacing_bottom = 0, int p_spacing_space = 0, int p_spacing_glyph = 0, float p_baseline_offset = 0.0) const override;
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
virtual RID _get_rid() const override;
remove trailing whitespace
2016-03-09 07:00:52 +08:00
Refactor Font configuration and import UI, and Font resources.
2022-05-09 17:47:10 +08:00
FontVariation();
~FontVariation();
GODOT IS OPEN SOURCE
2014-02-10 09:10:30 +08:00
};
Implement support for loading system fonts on Linux, macOS / iOS and Windows.
2022-07-08 20:38:30 +08:00
/*************************************************************************/
/* SystemFont */
/*************************************************************************/
class SystemFont : public Font {
GDCLASS(SystemFont, Font);
PackedStringArray names;
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 21:04:01 +08:00
bool italic = false;
int weight = 400;
int stretch = 100;
Implement support for loading system fonts on Linux, macOS / iOS and Windows.
2022-07-08 20:38:30 +08:00
mutable Ref<Font> theme_font;
Ref<FontFile> base_font;
Vector<int> face_indeces;
int ftr_weight = 0;
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 21:04:01 +08:00
int ftr_stretch = 0;
Implement support for loading system fonts on Linux, macOS / iOS and Windows.
2022-07-08 20:38:30 +08:00
int ftr_italic = 0;
Add font LCD sub-pixel anti-aliasing support.
2022-08-12 19:03:28 +08:00
TextServer::FontAntialiasing antialiasing = TextServer::FONT_ANTIALIASING_GRAY;
Implement support for loading system fonts on Linux, macOS / iOS and Windows.
2022-07-08 20:38:30 +08:00
bool mipmaps = false;
[Font] Add option to disable embedded bitmaps loading.
2024-03-11 19:42:16 +08:00
bool disable_embedded_bitmaps = true;
Implement support for loading system fonts on Linux, macOS / iOS and Windows.
2022-07-08 20:38:30 +08:00
bool force_autohinter = false;
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 21:04:01 +08:00
bool allow_system_fallback = true;
Implement support for loading system fonts on Linux, macOS / iOS and Windows.
2022-07-08 20:38:30 +08:00
TextServer::Hinting hinting = TextServer::HINTING_LIGHT;
TextServer::SubpixelPositioning subpixel_positioning = TextServer::SUBPIXEL_POSITIONING_AUTO;
real_t oversampling = 0.f;
Allow MSDF rendering for system fonts, fix crash on loading damaged / unsupported font files.
2022-08-09 19:19:03 +08:00
bool msdf = false;
[SystemFont] Add missing MSDF properties.
2023-01-26 15:23:09 +08:00
int msdf_pixel_range = 16;
int msdf_size = 48;
Implement support for loading system fonts on Linux, macOS / iOS and Windows.
2022-07-08 20:38:30 +08:00
protected:
static void _bind_methods();
virtual void _update_base_font();
virtual void _update_rids() const override;
virtual void reset_state() override;
public:
[Font] Add check for cyclic base font dependencies.
2024-08-03 01:46:39 +08:00
virtual Ref<Font> get_base_font() const { return base_font; }
Implement support for loading system fonts on Linux, macOS / iOS and Windows.
2022-07-08 20:38:30 +08:00
virtual Ref<Font> _get_base_font_or_default() const;
Add font LCD sub-pixel anti-aliasing support.
2022-08-12 19:03:28 +08:00
virtual void set_antialiasing(TextServer::FontAntialiasing p_antialiasing);
virtual TextServer::FontAntialiasing get_antialiasing() const;
Implement support for loading system fonts on Linux, macOS / iOS and Windows.
2022-07-08 20:38:30 +08:00
[Font] Add option to disable embedded bitmaps loading.
2024-03-11 19:42:16 +08:00
virtual void set_disable_embedded_bitmaps(bool p_disable_embedded_bitmaps);
virtual bool get_disable_embedded_bitmaps() const;
Implement support for loading system fonts on Linux, macOS / iOS and Windows.
2022-07-08 20:38:30 +08:00
virtual void set_generate_mipmaps(bool p_generate_mipmaps);
virtual bool get_generate_mipmaps() const;
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 21:04:01 +08:00
virtual void set_allow_system_fallback(bool p_allow_system_fallback);
virtual bool is_allow_system_fallback() const;
Implement support for loading system fonts on Linux, macOS / iOS and Windows.
2022-07-08 20:38:30 +08:00
virtual void set_force_autohinter(bool p_force_autohinter);
virtual bool is_force_autohinter() const;
virtual void set_hinting(TextServer::Hinting p_hinting);
virtual TextServer::Hinting get_hinting() const;
virtual void set_subpixel_positioning(TextServer::SubpixelPositioning p_subpixel);
virtual TextServer::SubpixelPositioning get_subpixel_positioning() const;
virtual void set_oversampling(real_t p_oversampling);
virtual real_t get_oversampling() const;
Allow MSDF rendering for system fonts, fix crash on loading damaged / unsupported font files.
2022-08-09 19:19:03 +08:00
virtual void set_multichannel_signed_distance_field(bool p_msdf);
virtual bool is_multichannel_signed_distance_field() const;
[SystemFont] Add missing MSDF properties.
2023-01-26 15:23:09 +08:00
virtual void set_msdf_pixel_range(int p_msdf_pixel_range);
virtual int get_msdf_pixel_range() const;
virtual void set_msdf_size(int p_msdf_size);
virtual int get_msdf_size() const;
Implement support for loading system fonts on Linux, macOS / iOS and Windows.
2022-07-08 20:38:30 +08:00
virtual void set_font_names(const PackedStringArray &p_names);
virtual PackedStringArray get_font_names() const;
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 21:04:01 +08:00
virtual void set_font_italic(bool p_italic);
virtual bool get_font_italic() const;
virtual void set_font_weight(int p_weight);
virtual int get_font_weight() const override;
virtual void set_font_stretch(int p_stretch);
virtual int get_font_stretch() const override;
Implement support for loading system fonts on Linux, macOS / iOS and Windows.
2022-07-08 20:38:30 +08:00
virtual int get_spacing(TextServer::SpacingType p_spacing) const override;
[TextServer / Font] Add support for customizable baseline offset.
2024-01-28 18:34:56 +08:00
virtual RID find_variation(const Dictionary &p_variation_coordinates, int p_face_index = 0, float p_strength = 0.0, Transform2D p_transform = Transform2D(), int p_spacing_top = 0, int p_spacing_bottom = 0, int p_spacing_space = 0, int p_spacing_glyph = 0, float p_baseline_offset = 0.0) const override;
Implement support for loading system fonts on Linux, macOS / iOS and Windows.
2022-07-08 20:38:30 +08:00
virtual RID _get_rid() const override;
int64_t get_face_count() const override;
SystemFont();
~SystemFont();
};
Code quality: Fix header guards consistency Adds `header_guards.sh` bash script, used in CI to validate future changes. Can be run locally to fix invalid header guards.
2022-07-24 05:41:51 +08:00
#endif // FONT_H
Reference in New Issue Copy Permalink