/**************************************************************************/ /* dynamic_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. */ /**************************************************************************/ #ifndef DYNAMIC_FONT_H #define DYNAMIC_FONT_H #include "modules/modules_enabled.gen.h" // For freetype. #ifdef MODULE_FREETYPE_ENABLED #include "core/io/resource_loader.h" #include "core/os/mutex.h" #include "core/os/thread_safe.h" #include "core/pair.h" #include "scene/resources/font.h" #include <ft2build.h> #include FT_FREETYPE_H class DynamicFontAtSize; class DynamicFont; class DynamicFontData : public Resource { GDCLASS(DynamicFontData, Resource); public: struct CacheID { union { struct { uint32_t size : 16; uint32_t outline_size : 8; uint32_t mipmaps : 1; uint32_t filter : 1; uint32_t unused : 6; }; uint32_t key; }; bool operator<(CacheID right) const; CacheID() { key = 0; } }; enum Hinting { HINTING_NONE, HINTING_LIGHT, HINTING_NORMAL }; bool is_antialiased() const; void set_antialiased(bool p_antialiased); Hinting get_hinting() const; void set_hinting(Hinting p_hinting); private: const uint8_t *font_mem; int font_mem_size; bool antialiased; bool force_autohinter; Hinting hinting; Vector<uint8_t> _fontdata; float override_oversampling; String font_path; Map<CacheID, DynamicFontAtSize *> size_cache; friend class DynamicFontAtSize; friend class DynamicFont; Ref<DynamicFontAtSize> _get_dynamic_font_at_size(CacheID p_cache_id); protected: static void _bind_methods(); public: void set_font_ptr(const uint8_t *p_font_mem, int p_font_mem_size); void set_font_path(const String &p_path); String get_font_path() const; void set_force_autohinter(bool p_force); float get_override_oversampling() const; void set_override_oversampling(float p_oversampling); DynamicFontData(); ~DynamicFontData(); }; VARIANT_ENUM_CAST(DynamicFontData::Hinting); class DynamicFontAtSize : public Reference { GDCLASS(DynamicFontAtSize, Reference); _THREAD_SAFE_CLASS_ FT_Library library; /* handle to library */ FT_Face face; /* handle to face object */ FT_StreamRec stream; float ascent; float descent; float linegap; float rect_margin; float oversampling; float scale_color_font; uint32_t texture_flags; bool valid; struct FontTexturePosition { int32_t index = -1; int32_t x = 0; int32_t y = 0; FontTexturePosition() {} FontTexturePosition(int32_t p_id, int32_t p_x, int32_t p_y) : index(p_id), x(p_x), y(p_y) {} }; struct Shelf { int32_t x = 0; int32_t y = 0; int32_t w = 0; int32_t h = 0; FontTexturePosition alloc_shelf(int32_t p_id, int32_t p_w, int32_t p_h) { if (p_w > w || p_h > h) { return FontTexturePosition(-1, 0, 0); } int32_t xx = x; x += p_w; w -= p_w; return FontTexturePosition(p_id, xx, y); } Shelf() {} Shelf(int32_t p_x, int32_t p_y, int32_t p_w, int32_t p_h) : x(p_x), y(p_y), w(p_w), h(p_h) {} }; struct ShelfPackTexture { int32_t texture_size = 1024; PoolVector<uint8_t> imgdata; Ref<ImageTexture> texture; List<Shelf> shelves; Image::Format format; bool dirty = true; FontTexturePosition pack_rect(int32_t p_id, int32_t p_h, int32_t p_w) { int32_t y = 0; int32_t waste = 0; List<Shelf>::Element *best_shelf = nullptr; int32_t best_waste = std::numeric_limits<std::int32_t>::max(); for (List<Shelf>::Element *E = shelves.front(); E; E = E->next()) { y += E->get().h; if (p_w > E->get().w) { continue; } if (p_h == E->get().h) { return E->get().alloc_shelf(p_id, p_w, p_h); } if (p_h > E->get().h) { continue; } if (p_h < E->get().h) { waste = (E->get().h - p_h) * p_w; if (waste < best_waste) { best_waste = waste; best_shelf = E; } } } if (best_shelf) { return best_shelf->get().alloc_shelf(p_id, p_w, p_h); } if (p_h <= (texture_size - y) && p_w <= texture_size) { List<Shelf>::Element *E = shelves.push_back(Shelf(0, y, texture_size, p_h)); return E->get().alloc_shelf(p_id, p_w, p_h); } return FontTexturePosition(-1, 0, 0); } ShelfPackTexture() {} ShelfPackTexture(int32_t p_size) : texture_size(p_size) {} }; Vector<ShelfPackTexture> textures; struct Character { bool found; int texture_idx; Rect2 rect; Rect2 rect_uv; float v_align; float h_align; float advance; Character() { texture_idx = 0; v_align = 0; } static Character not_found(); }; const Pair<const Character *, DynamicFontAtSize *> _find_char_with_font(int32_t p_char, const Vector<Ref<DynamicFontAtSize>> &p_fallbacks) const; Character _make_outline_char(int32_t p_char); float _get_kerning_advance(const DynamicFontAtSize *font, int32_t p_char, int32_t p_next) const; FontTexturePosition _find_texture_pos_for_glyph(int p_color_size, Image::Format p_image_format, int p_width, int p_height); Character _bitmap_to_character(FT_Bitmap bitmap, int yofs, int xofs, float advance); HashMap<int32_t, Character> char_map; _FORCE_INLINE_ void _update_char(int32_t p_char); friend class DynamicFontData; Ref<DynamicFontData> font; DynamicFontData::CacheID id; Error _load(); public: static float font_oversampling; float get_height() const; float get_ascent() const; float get_descent() const; Size2 get_char_size(CharType p_char, CharType p_next, const Vector<Ref<DynamicFontAtSize>> &p_fallbacks) const; String get_available_chars() const; float draw_char(RID p_canvas_item, const Point2 &p_pos, CharType p_char, CharType p_next, const Color &p_modulate, const Vector<Ref<DynamicFontAtSize>> &p_fallbacks, bool p_advance_only = false, bool p_outline = false, MultiRect *p_multirect = nullptr) const; RID get_char_texture(CharType p_char, CharType p_next, const Vector<Ref<DynamicFontAtSize>> &p_fallbacks) const; Size2 get_char_texture_size(CharType p_char, CharType p_next, const Vector<Ref<DynamicFontAtSize>> &p_fallbacks) const; Vector2 get_char_tx_offset(CharType p_char, CharType p_next, const Vector<Ref<DynamicFontAtSize>> &p_fallbacks) const; Size2 get_char_tx_size(CharType p_char, CharType p_next, const Vector<Ref<DynamicFontAtSize>> &p_fallbacks) const; Rect2 get_char_tx_uv_rect(CharType p_char, CharType p_next, const Vector<Ref<DynamicFontAtSize>> &p_fallbacks) const; void set_texture_flags(uint32_t p_flags); void update_oversampling(); Dictionary get_char_contours(CharType p_char, CharType p_next, const Vector<Ref<DynamicFontAtSize>> &p_fallbacks) const; DynamicFontAtSize(); ~DynamicFontAtSize(); }; /////////////// class DynamicFont : public Font { GDCLASS(DynamicFont, Font); public: enum SpacingType { SPACING_TOP, SPACING_BOTTOM, SPACING_CHAR, SPACING_SPACE }; private: Ref<DynamicFontData> data; Ref<DynamicFontAtSize> data_at_size; Ref<DynamicFontAtSize> outline_data_at_size; Vector<Ref<DynamicFontData>> fallbacks; Vector<Ref<DynamicFontAtSize>> fallback_data_at_size; Vector<Ref<DynamicFontAtSize>> fallback_outline_data_at_size; DynamicFontData::CacheID cache_id; DynamicFontData::CacheID outline_cache_id; bool valid; int spacing_top; int spacing_bottom; int spacing_char; int spacing_space; Color outline_color; protected: void _reload_cache(const char *p_triggering_property = ""); 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; static void _bind_methods(); public: void set_font_data(const Ref<DynamicFontData> &p_data); Ref<DynamicFontData> get_font_data() const; void set_size(int p_size); int get_size() const; void set_outline_size(int p_size); int get_outline_size() const; void set_outline_color(Color p_color); Color get_outline_color() const; bool get_use_mipmaps() const; void set_use_mipmaps(bool p_enable); bool get_use_filter() const; void set_use_filter(bool p_enable); int get_spacing(int p_type) const; void set_spacing(int p_type, int p_value); void add_fallback(const Ref<DynamicFontData> &p_data); void set_fallback(int p_idx, const Ref<DynamicFontData> &p_data); int get_fallback_count() const; Ref<DynamicFontData> get_fallback(int p_idx) const; void remove_fallback(int p_idx); virtual float get_height() const; virtual float get_ascent() const; virtual float get_descent() const; virtual int get_spacing_char() const; virtual Size2 get_char_size(CharType p_char, CharType p_next = 0) const; String get_available_chars() const; virtual bool is_distance_field_hint() const; virtual bool has_outline() const; virtual float draw_char_ex(RID p_canvas_item, const Point2 &p_pos, CharType p_char, CharType p_next = 0, const Color &p_modulate = Color(1, 1, 1), bool p_outline = false, MultiRect *p_multirect = nullptr) const; RID get_char_texture(CharType p_char, CharType p_next, bool p_outline) const; Size2 get_char_texture_size(CharType p_char, CharType p_next, bool p_outline) const; Vector2 get_char_tx_offset(CharType p_char, CharType p_next, bool p_outline) const; Size2 get_char_tx_size(CharType p_char, CharType p_next, bool p_outline) const; Rect2 get_char_tx_uv_rect(CharType p_char, CharType p_next, bool p_outline) const; Dictionary get_char_contours(CharType p_char, CharType p_next) const; SelfList<DynamicFont> font_list; static Mutex dynamic_font_mutex; static SelfList<DynamicFont>::List *dynamic_fonts; static void initialize_dynamic_fonts(); static void finish_dynamic_fonts(); static void update_oversampling(); DynamicFont(); ~DynamicFont(); }; VARIANT_ENUM_CAST(DynamicFont::SpacingType); ///////////// class ResourceFormatLoaderDynamicFont : public ResourceFormatLoader { public: virtual RES load(const String &p_path, const String &p_original_path = "", Error *r_error = nullptr, bool p_no_subresource_cache = false); virtual void get_recognized_extensions(List<String> *p_extensions) const; virtual bool handles_type(const String &p_type) const; virtual String get_resource_type(const String &p_path) const; }; #endif // MODULE_FREETYPE_ENABLED #endif // DYNAMIC_FONT_H