CGUITTFont.h

Go to the documentation of this file.

/*
   CGUITTFont FreeType class for Irrlicht
   Copyright (c) 2009-2010 John Norman
   Copyright (c) 2016 Nathanaëlle Courant
   Copyright (c) 2023 Caleb Butler
   Copyright (c) 2024 Luanti contributors
 
   This software is provided 'as-is', without any express or implied
   warranty. In no event will the authors be held liable for any
   damages arising from the use of this software.
 
   Permission is granted to anyone to use this software for any
   purpose, including commercial applications, and to alter it and
   redistribute it freely, subject to the following restrictions:
 
   1. The origin of this software must not be misrepresented; you
      must not claim that you wrote the original software. If you use
      this software in a product, an acknowledgment in the product
      documentation would be appreciated but is not required.
 
   2. Altered source versions must be plainly marked as such, and
      must not be misrepresented as being the original software.
 
   3. This notice may not be removed or altered from any source
      distribution.
 
   The original version of this class can be located at:
   http://irrlicht.suckerfreegames.com/
 
   John Norman
   john@suckerfreegames.com
*/
 
#pragma once
 
#include <ft2build.h>
#include <freetype/freetype.h>
 
#include "IGUIEnvironment.h"
#include "IGUIFont.h"
#include "IVideoDriver.h"
#include "IrrlichtDevice.h"
#include "util/enriched_string.h"
#include "util/basic_macros.h"
 
#include <map>
#include <optional>
 
namespace irr
{
namespace gui
{
        // Manages the FT_Face cache.
        struct SGUITTFace : public irr::IReferenceCounted
        {
        private:
 
                static std::map<io::path, SGUITTFace*> faces;
                static FT_Library freetype_library;
                static std::size_t n_faces;
 
                static FT_Library getFreeTypeLibrary();
 
        public:
 
                SGUITTFace(std::string &&buffer);
 
                ~SGUITTFace();
 
                std::optional<std::string> filename;
 
                FT_Face face;
                std::string face_buffer;
 
                static SGUITTFace* createFace(std::string &&buffer);
 
                static SGUITTFace* loadFace(const io::path &filename);
 
                void dropFilename();
        };
        class CGUITTFont;
 
        struct SGUITTGlyph
        {
                SGUITTGlyph() :
                        glyph_page(0),
                        source_rect(),
                        offset(),
                        advance(),
                        surface(0)
                {}
 
                DISABLE_CLASS_COPY(SGUITTGlyph);
 
                SGUITTGlyph(SGUITTGlyph &&other) noexcept :
                        glyph_page(other.glyph_page),
                        source_rect(other.source_rect),
                        offset(other.offset),
                        advance(other.advance),
                        surface(other.surface)
                {
                        other.surface = 0;
                }
 
                ~SGUITTGlyph() { unload(); }
 
                inline bool isLoaded() const {
                        return source_rect != core::recti();
                }
 
                void preload(u32 char_index, FT_Face face, CGUITTFont *parent, u32 font_size, const FT_Int32 loadFlags);
 
                void unload();
 
                video::IImage* createGlyphImage(const FT_Bitmap& bits, video::IVideoDriver* driver) const;
 
                u32 glyph_page;
 
                core::recti source_rect;
 
                core::vector2di offset;
 
                core::vector2di advance;
 
                mutable video::IImage* surface;
        };
 
        class CGUITTGlyphPage
        {
                public:
                        CGUITTGlyphPage(video::IVideoDriver* Driver, const io::path& texture_name) :texture(0), available_slots(0), used_slots(0), dirty(false), driver(Driver), name(texture_name) {}
                        ~CGUITTGlyphPage()
                        {
                                if (texture)
                                {
                                        if (driver)
                                                driver->removeTexture(texture);
                                        else
                                                texture->drop();
                                }
                        }
 
                        bool createPageTexture(const u8& pixel_mode, const core::dimension2du& texture_size)
                        {
                                if( texture )
                                        return false;
 
                                bool flgmip = driver->getTextureCreationFlag(video::ETCF_CREATE_MIP_MAPS);
                                driver->setTextureCreationFlag(video::ETCF_CREATE_MIP_MAPS, false);
                                bool flgcpy = driver->getTextureCreationFlag(video::ETCF_ALLOW_MEMORY_COPY);
                                driver->setTextureCreationFlag(video::ETCF_ALLOW_MEMORY_COPY, true);
 
                                // Set the texture color format.
                                switch (pixel_mode)
                                {
                                        case FT_PIXEL_MODE_MONO:
                                                texture = driver->addTexture(texture_size, name, video::ECF_A1R5G5B5);
                                                break;
                                        case FT_PIXEL_MODE_GRAY:
                                        default:
                                                texture = driver->addTexture(texture_size, name, video::ECF_A8R8G8B8);
                                                break;
                                }
 
                                // Restore our texture creation flags.
                                driver->setTextureCreationFlag(video::ETCF_CREATE_MIP_MAPS, flgmip);
                                driver->setTextureCreationFlag(video::ETCF_ALLOW_MEMORY_COPY, flgcpy);
 
                                return texture ? true : false;
                        }
 
                        void pushGlyphToBePaged(const SGUITTGlyph* glyph)
                        {
                                glyph_to_be_paged.push_back(glyph);
                        }
 
                        void updateTexture()
                        {
                                if (!dirty) return;
 
                                void* ptr = texture->lock();
                                video::ECOLOR_FORMAT format = texture->getColorFormat();
                                core::dimension2du size = texture->getOriginalSize();
                                video::IImage* pageholder = driver->createImageFromData(format, size, ptr, true, false);
 
                                for (u32 i = 0; i < glyph_to_be_paged.size(); ++i)
                                {
                                        const SGUITTGlyph* glyph = glyph_to_be_paged[i];
                                        if (glyph && glyph->surface)
                                        {
                                                glyph->surface->copyTo(pageholder, glyph->source_rect.UpperLeftCorner);
                                                glyph->surface->drop();
                                                glyph->surface = 0;
                                        }
                                }
 
                                pageholder->drop();
                                texture->unlock();
                                glyph_to_be_paged.clear();
                                dirty = false;
                        }
 
                        video::ITexture* texture;
                        u32 available_slots;
                        u32 used_slots;
                        bool dirty;
 
                        core::array<core::vector2di> render_positions;
                        core::array<core::recti> render_source_rects;
                        core::array<video::SColor> render_colors;
 
                private:
                        core::array<const SGUITTGlyph*> glyph_to_be_paged;
                        video::IVideoDriver* driver;
                        io::path name;
        };
 
        class CGUITTFont : public IGUIFont
        {
                public:
                        static CGUITTFont* createTTFont(IGUIEnvironment *env,
                                SGUITTFace *face, u32 size, bool antialias = true,
                                bool transparency = true, u32 shadow = 0, u32 shadow_alpha = 255);
 
                        virtual ~CGUITTFont();
 
                        void setBatchLoadSize(u32 batch_size) { batch_load_size = batch_size; }
 
                        void setMaxPageTextureSize(const core::dimension2du& texture_size) { max_page_texture_size = texture_size; }
 
                        u32 getFontSize() const { return size; }
 
                        bool isTransparent() const { return use_transparency; }
 
                        bool useAutoHinting() const { return use_auto_hinting; }
 
                        bool useHinting()        const { return use_hinting; }
 
                        bool useMonochrome()  const { return use_monochrome; }
 
                        void setTransparency(const bool flag);
 
                        void setMonochrome(const bool flag);
 
                        void setFontHinting(const bool enable, const bool enable_auto_hinting = true);
 
                        virtual void draw(const core::stringw& text, const core::rect<s32>& position,
                                video::SColor color, bool hcenter=false, bool vcenter=false,
                                const core::rect<s32>* clip=0) override;
 
                        void draw(const EnrichedString& text, const core::rect<s32>& position,
                                bool hcenter=false, bool vcenter=false,
                                const core::rect<s32>* clip=0);
 
                        virtual core::dimension2du getDimension(const wchar_t* text) const override;
 
                        virtual s32 getCharacterFromPos(const wchar_t* text, s32 pixel_x) const override;
 
                        virtual void setKerningWidth(s32 kerning) override;
 
                        virtual void setKerningHeight(s32 kerning) override;
 
                        virtual core::vector2di getKerning(const wchar_t thisLetter, const wchar_t previousLetter) const override;
 
                        virtual void setInvisibleCharacters(const wchar_t *s) override;
 
                        CGUITTGlyphPage* getLastGlyphPage() const;
 
                        //should be better typed. fix later.
                        CGUITTGlyphPage* createGlyphPage(const u8 pixel_mode);
 
                        u32 getLastGlyphPageIndex() const { return Glyph_Pages.size() - 1; }
 
                        void setFallback(gui::IGUIFont* font) { fallback = font; }
 
                        video::IImage* createTextureFromChar(const char32_t& ch);
 
                        video::ITexture* getPageTextureByIndex(const u32& page_index) const;
 
                        inline video::IVideoDriver *getDriver() const { return Driver; }
 
                        inline s32 getAscender() const { return font_metrics.ascender; }
 
                protected:
                        bool use_monochrome;
                        bool use_transparency;
                        bool use_hinting;
                        bool use_auto_hinting;
                        u32 size;
                        u32 batch_load_size;
                        core::dimension2du max_page_texture_size;
 
                private:
                        // Helper functions for the same-named public member functions above
                        // (Since std::u32string is nicer to work with than wchar_t *)
                        core::dimension2d<u32> getDimension(const std::u32string& text) const;
                        s32 getCharacterFromPos(const std::u32string& text, s32 pixel_x) const;
 
                        // Helper function for the above helper functions :P
                        std::u32string convertWCharToU32String(const wchar_t* const) const;
 
                        CGUITTFont(IGUIEnvironment *env);
                        bool load(SGUITTFace *face, const u32 size, const bool antialias, const bool transparency);
                        void reset_images();
                        void update_glyph_pages() const;
                        void update_load_flags()
                        {
                                // Set up our loading flags.
                                load_flags = FT_LOAD_DEFAULT | FT_LOAD_RENDER;
                                if (!useHinting()) load_flags |= FT_LOAD_NO_HINTING;
                                if (!useAutoHinting()) load_flags |= FT_LOAD_NO_AUTOHINT;
                                if (useMonochrome()) load_flags |= FT_LOAD_MONOCHROME | FT_LOAD_TARGET_MONO;
                                else load_flags |= FT_LOAD_TARGET_NORMAL;
                        }
                        u32 getWidthFromCharacter(char32_t c) const;
                        u32 getHeightFromCharacter(char32_t c) const;
                        u32 getGlyphIndexByChar(char32_t c) const;
                        core::vector2di getKerning(const char32_t thisLetter, const char32_t previousLetter) const;
 
                        video::IVideoDriver* Driver;
                        std::optional<io::path> filename;
                        FT_Face tt_face;
                        FT_Size_Metrics font_metrics;
                        FT_Int32 load_flags;
 
                        mutable core::array<CGUITTGlyphPage*> Glyph_Pages;
                        mutable core::array<SGUITTGlyph> Glyphs;
 
                        s32 GlobalKerningWidth;
                        s32 GlobalKerningHeight;
                        std::u32string Invisible;
                        u32 shadow_offset;
                        u32 shadow_alpha;
 
                        gui::IGUIFont* fallback;
        };
 
} // end namespace gui
} // end namespace irr