.. index:: pair: class; EE::Graphics::FontSprite .. _doxid-class_e_e_1_1_graphics_1_1_font_sprite: class EE::Graphics::FontSprite ============================== .. toctree:: :hidden: struct_EE_Graphics_FontSprite_Page.rst Overview ~~~~~~~~ Implementation of XNA :ref:`Font ` Sprites. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block #include class FontSprite: public :ref:`EE::Graphics::Font` { public: // structs struct :ref:`Page`; // construction :target:`~FontSprite`(); // methods static FontSprite* :target:`New`(const std::string fontName); static FontSprite* :target:`New`(const std::string fontName, const std::string& filename); bool :target:`loadFromFile`(const std::string& filename, :ref:`Color` key = Color::Fuchsia, :ref:`Uint32` firstChar = 32, int spacing = 0); bool :target:`loadFromMemory`(const void* data, std::size_t sizeInBytes, :ref:`Color` key = Color::Fuchsia, :ref:`Uint32` firstChar = 32, int spacing = 0); bool :target:`loadFromStream`(:ref:`IOStream`& stream, :ref:`Color` key = Color::Fuchsia, :ref:`Uint32` firstChar = 32, int spacing = 0); bool :target:`loadFromPack`(:ref:`Pack`* pack, std::string filePackPath, :ref:`Color` key = Color::Fuchsia, :ref:`Uint32` firstChar = 32, int spacing = 0); virtual bool :target:`isMonospace`() const; virtual bool :target:`isScalable`() const; virtual const :ref:`Font::Info`& :target:`getInfo`() const; virtual const :ref:`Glyph`& :target:`getGlyph`(:ref:`Uint32` codePoint, unsigned int characterSize, bool bold, bool italic, :ref:`Float` outlineThickness = 0, :ref:`Float` maxWidth = 0) const; virtual :ref:`GlyphDrawable`* :ref:`getGlyphDrawable`(:ref:`Uint32` codePoint, unsigned int characterSize, bool bold = false, bool italic = false, :ref:`Float` outlineThickness = 0, const :ref:`Float`& forzeSize = 0) const; virtual :ref:`Float` :target:`getKerning`(:ref:`Uint32` first, :ref:`Uint32` second, unsigned int characterSize, bool bold, bool italic, :ref:`Float` outlineThickness = 0) const; virtual :ref:`Float` :target:`getLineSpacing`(unsigned int characterSize) const; virtual :ref:`Uint32` :ref:`getFontHeight`(const :ref:`Uint32`& characterSize) const; virtual :ref:`Float` :target:`getUnderlinePosition`(unsigned int characterSize) const; virtual :ref:`Float` :target:`getUnderlineThickness`(unsigned int characterSize) const; virtual :ref:`Texture`* :target:`getTexture`(unsigned int characterSize) const; virtual bool :target:`loaded`() const; FontSprite& :target:`operator=`(const FontSprite& right); }; Inherited Members ----------------- .. ref-code-block:: cpp :class: doxyrest-overview-inherited-code-block public: // typedefs typedef std::function`, :ref:`Event`, :ref:`Font`*)> :ref:`FontEventCallback`; // enums enum :ref:`Event`; // structs struct :ref:`Info`; // methods static :ref:`Uint32` :ref:`getHorizontalAlign`(const :ref:`Uint32`& flags); static :ref:`Uint32` :ref:`getVerticalAlign`(const :ref:`Uint32`& flags); static bool :ref:`isEmojiCodePoint`(const :ref:`Uint32`& codePoint); static bool :ref:`containsEmojiCodePoint`(const :ref:`String`& string); static std::vector :ref:`emojiCodePointsPositions`(const :ref:`String`& string); virtual :ref:`Uint32` :ref:`getFontHeight`(const :ref:`Uint32`& characterSize) const = 0; const :ref:`FontType`& :ref:`getType`() const; const std::string& :ref:`getName`() const; void :ref:`setName`(const std::string& setName); const :ref:`String::HashType`& :ref:`getId`(); virtual bool :ref:`isMonospace`() const = 0; virtual bool :ref:`isScalable`() const = 0; virtual const :ref:`Info`& :ref:`getInfo`() const = 0; virtual const :ref:`Glyph`& :ref:`getGlyph`(:ref:`Uint32` codePoint, unsigned int characterSize, bool bold, bool italic, :ref:`Float` outlineThickness = 0, :ref:`Float` maxWidth = 0) const = 0; virtual :ref:`GlyphDrawable`* :ref:`getGlyphDrawable`(:ref:`Uint32` codePoint, unsigned int characterSize, bool bold = false, bool italic = false, :ref:`Float` outlineThickness = 0, const :ref:`Float`& forzeSize = 0) const = 0; virtual :ref:`Float` :ref:`getKerning`(:ref:`Uint32` first, :ref:`Uint32` second, unsigned int characterSize, bool bold, bool italic, :ref:`Float` outlineThickness = 0) const = 0; virtual :ref:`Float` :ref:`getLineSpacing`(unsigned int characterSize) const = 0; virtual :ref:`Float` :ref:`getUnderlinePosition`(unsigned int characterSize) const = 0; virtual :ref:`Float` :ref:`getUnderlineThickness`(unsigned int characterSize) const = 0; virtual :ref:`Texture`* :ref:`getTexture`(unsigned int characterSize) const = 0; virtual :ref:`Uint32` :ref:`getFontStyle`() const; virtual bool :ref:`isRegular`() const; virtual bool :ref:`isBold`() const; virtual bool :ref:`isItalic`() const; virtual bool :ref:`isBoldItalic`() const; virtual bool :ref:`hasBold`() const; virtual bool :ref:`hasItalic`() const; virtual bool :ref:`hasBoldItalic`() const; virtual bool :ref:`loaded`() const = 0; :ref:`Uint32` :ref:`pushFontEventCallback`(const :ref:`FontEventCallback`& cb); void :ref:`popFontEventCallback`(const :ref:`Uint32`& callbackId); .. _details-class_e_e_1_1_graphics_1_1_font_sprite: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Implementation of XNA :ref:`Font ` Sprites. Methods ------- .. index:: pair: function; getGlyphDrawable .. _doxid-class_e_e_1_1_graphics_1_1_font_sprite_1ab700b56afeefc70613dbbbc031f28325: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual :ref:`GlyphDrawable`* getGlyphDrawable(:ref:`Uint32` codePoint, unsigned int characterSize, bool bold = false, bool italic = false, :ref:`Float` outlineThickness = 0, const :ref:`Float`& forzeSize = 0) const .. rubric:: Returns: The glyph drawable that represents the glyph in a texture. The glyph drawable allocation is managed by the font. .. index:: pair: function; getFontHeight .. _doxid-class_e_e_1_1_graphics_1_1_font_sprite_1aec384c535f90a816fdfdbddebf38a1d0: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual :ref:`Uint32` getFontHeight(const :ref:`Uint32`& characterSize) const .. rubric:: Returns: The current font height