.. index:: pair: class; EE::Graphics::Font
.. _doxid-class_e_e_1_1_graphics_1_1_font:

class EE::Graphics::Font
========================

.. toctree::
	:hidden:

	enum_EE_Graphics_Font_Event.rst
	struct_EE_Graphics_Font_Info.rst

Overview
~~~~~~~~

:ref:`Font <doxid-class_e_e_1_1_graphics_1_1_font>` interface class. :ref:`More...<details-class_e_e_1_1_graphics_1_1_font>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <font.hpp>
	
	class Font {
	public:
		// typedefs
	
		typedef std::function<void(:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>`, :ref:`Event<doxid-class_e_e_1_1_graphics_1_1_font_1ace111c42704148a547825369f85a03bb>`, Font*)> :target:`FontEventCallback<doxid-class_e_e_1_1_graphics_1_1_font_1a52dd0add68591e1ac93b5660139743d6>`;

		// enums
	
		enum :ref:`Event<doxid-class_e_e_1_1_graphics_1_1_font_1ace111c42704148a547825369f85a03bb>`;

		// structs
	
		struct :ref:`Info<doxid-struct_e_e_1_1_graphics_1_1_font_1_1_info>`;

		// construction
	
		virtual :target:`~Font<doxid-class_e_e_1_1_graphics_1_1_font_1a7e5ec1df304995a5082a3add813488dd>`();

		// methods
	
		static :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` :target:`getHorizontalAlign<doxid-class_e_e_1_1_graphics_1_1_font_1a70126cadcda49f4e3e0558b823d12d55>`(const :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>`& flags);
		static :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` :target:`getVerticalAlign<doxid-class_e_e_1_1_graphics_1_1_font_1a9a943a2962f3459b38d55e4333e4fd1b>`(const :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>`& flags);
		static bool :target:`isEmojiCodePoint<doxid-class_e_e_1_1_graphics_1_1_font_1a6b4d57e1246f9a9748b8a3854f708f32>`(const :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>`& codePoint);
		static bool :target:`containsEmojiCodePoint<doxid-class_e_e_1_1_graphics_1_1_font_1a72812b39c961504633697246f93e16ed>`(const :ref:`String<doxid-class_e_e_1_1_string>`& string);
		static std::vector<std::size_t> :target:`emojiCodePointsPositions<doxid-class_e_e_1_1_graphics_1_1_font_1aff91974010a797060eb4056c59fe9708>`(const :ref:`String<doxid-class_e_e_1_1_string>`& string);
		virtual :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` :ref:`getFontHeight<doxid-class_e_e_1_1_graphics_1_1_font_1a572464f2fbe0de1bf84a3d6265f90247>`(const :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>`& characterSize) const = 0;
		const :ref:`FontType<doxid-namespace_e_e_1_1_graphics_1a2cdb586f7f366ad099e8491d8f3b330e>`& :ref:`getType<doxid-class_e_e_1_1_graphics_1_1_font_1a2dafe4c3ec4dbca406d3e0bf847664af>`() const;
		const std::string& :ref:`getName<doxid-class_e_e_1_1_graphics_1_1_font_1a84eee169817fb268640c82ce30b467ea>`() const;
		void :ref:`setName<doxid-class_e_e_1_1_graphics_1_1_font_1a0fa3aa54feb11e838088ca91bee9c2e8>`(const std::string& setName);
		const :ref:`String::HashType<doxid-class_e_e_1_1_string_1a105c2ab365f2a3085c714617f129b386>`& :ref:`getId<doxid-class_e_e_1_1_graphics_1_1_font_1a2516a3abbe7733e8f1482704c62a9a0a>`();
		virtual bool :target:`isMonospace<doxid-class_e_e_1_1_graphics_1_1_font_1ac85a1184dcf4a5de139444470431d726>`() const = 0;
		virtual bool :target:`isScalable<doxid-class_e_e_1_1_graphics_1_1_font_1a55f69df7864a90bc9d53956e0b38d132>`() const = 0;
		virtual const :ref:`Info<doxid-struct_e_e_1_1_graphics_1_1_font_1_1_info>`& :target:`getInfo<doxid-class_e_e_1_1_graphics_1_1_font_1a96c6115c9074638d5f2081ccefa4d236>`() const = 0;
		virtual const :ref:`Glyph<doxid-class_e_e_1_1_graphics_1_1_glyph>`& :target:`getGlyph<doxid-class_e_e_1_1_graphics_1_1_font_1a8d7f60ceb079a7b33fe44959b1f8188f>`(:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` codePoint, unsigned int characterSize, bool bold, bool italic, :ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` outlineThickness = 0, :ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` maxWidth = 0) const = 0;
		virtual :ref:`GlyphDrawable<doxid-class_e_e_1_1_graphics_1_1_glyph_drawable>`* :ref:`getGlyphDrawable<doxid-class_e_e_1_1_graphics_1_1_font_1a5317e14ccd72ac15cba064cdebfbd23a>`(:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` codePoint, unsigned int characterSize, bool bold = false, bool italic = false, :ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` outlineThickness = 0, const :ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>`& forzeSize = 0) const = 0;
		virtual :ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` :target:`getKerning<doxid-class_e_e_1_1_graphics_1_1_font_1a0aa01c2ec49452ff987a9014421680d9>`(:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` first, :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` second, unsigned int characterSize, bool bold, bool italic, :ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` outlineThickness = 0) const = 0;
		virtual :ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` :target:`getLineSpacing<doxid-class_e_e_1_1_graphics_1_1_font_1a21910dc7a1d219a5cf7327b886ff4cbd>`(unsigned int characterSize) const = 0;
		virtual :ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` :target:`getUnderlinePosition<doxid-class_e_e_1_1_graphics_1_1_font_1ac4efd7cb8e634be5bdbedb1adb6dc911>`(unsigned int characterSize) const = 0;
		virtual :ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` :target:`getUnderlineThickness<doxid-class_e_e_1_1_graphics_1_1_font_1adb21aa03ebe3ac72b63699ff642d5d16>`(unsigned int characterSize) const = 0;
		virtual :ref:`Texture<doxid-class_e_e_1_1_graphics_1_1_texture>`* :target:`getTexture<doxid-class_e_e_1_1_graphics_1_1_font_1a3286728db5195251b4cb6664954120d0>`(unsigned int characterSize) const = 0;
		virtual :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` :target:`getFontStyle<doxid-class_e_e_1_1_graphics_1_1_font_1ab27bbb71f8e02389626ce6c5d222ba71>`() const;
		virtual bool :target:`isRegular<doxid-class_e_e_1_1_graphics_1_1_font_1af41283d083e1309a84e6aaf4817b1805>`() const;
		virtual bool :target:`isBold<doxid-class_e_e_1_1_graphics_1_1_font_1a5456dc4ad995f1e6f322c1b6f9bf4a3a>`() const;
		virtual bool :target:`isItalic<doxid-class_e_e_1_1_graphics_1_1_font_1a9400d3b12c9e5352b60cfd96339a86b7>`() const;
		virtual bool :target:`isBoldItalic<doxid-class_e_e_1_1_graphics_1_1_font_1ab4b1425b59d268b08f2f6e28f268bf43>`() const;
		virtual bool :target:`hasBold<doxid-class_e_e_1_1_graphics_1_1_font_1aade7f1e88d9309871a6c44b82708d9a2>`() const;
		virtual bool :target:`hasItalic<doxid-class_e_e_1_1_graphics_1_1_font_1a9638b5b50daa08a8bd8d46e4d3577d1a>`() const;
		virtual bool :target:`hasBoldItalic<doxid-class_e_e_1_1_graphics_1_1_font_1a78c03b1614723fda02c504d0c1032e13>`() const;
		virtual bool :target:`loaded<doxid-class_e_e_1_1_graphics_1_1_font_1a1cdfd94d2e6a2cc75267336c9848b4d9>`() const = 0;
		:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` :ref:`pushFontEventCallback<doxid-class_e_e_1_1_graphics_1_1_font_1a855c816d23cd7ec5098d90b35cca1fa6>`(const :ref:`FontEventCallback<doxid-class_e_e_1_1_graphics_1_1_font_1a52dd0add68591e1ac93b5660139743d6>`& cb);
		void :ref:`popFontEventCallback<doxid-class_e_e_1_1_graphics_1_1_font_1a5abd41b82e9c9d21cfd8a2b2a291b1e4>`(const :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>`& callbackId);
	};
.. _details-class_e_e_1_1_graphics_1_1_font:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

:ref:`Font <doxid-class_e_e_1_1_graphics_1_1_font>` interface class.

Methods
-------

.. index:: pair: function; getFontHeight
.. _doxid-class_e_e_1_1_graphics_1_1_font_1a572464f2fbe0de1bf84a3d6265f90247:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` getFontHeight(const :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>`& characterSize) const = 0



.. rubric:: Returns:

The current font height

.. index:: pair: function; getType
.. _doxid-class_e_e_1_1_graphics_1_1_font_1a2dafe4c3ec4dbca406d3e0bf847664af:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const :ref:`FontType<doxid-namespace_e_e_1_1_graphics_1a2cdb586f7f366ad099e8491d8f3b330e>`& getType() const



.. rubric:: Returns:

The type of the instance of the font

.. index:: pair: function; getName
.. _doxid-class_e_e_1_1_graphics_1_1_font_1a84eee169817fb268640c82ce30b467ea:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const std::string& getName() const



.. rubric:: Returns:

The font name

.. index:: pair: function; setName
.. _doxid-class_e_e_1_1_graphics_1_1_font_1a0fa3aa54feb11e838088ca91bee9c2e8:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setName(const std::string& setName)

Change the font name ( and id, because it's the font name hash )

.. index:: pair: function; getId
.. _doxid-class_e_e_1_1_graphics_1_1_font_1a2516a3abbe7733e8f1482704c62a9a0a:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const :ref:`String::HashType<doxid-class_e_e_1_1_string_1a105c2ab365f2a3085c714617f129b386>`& getId()



.. rubric:: Returns:

The font id

.. index:: pair: function; getGlyphDrawable
.. _doxid-class_e_e_1_1_graphics_1_1_font_1a5317e14ccd72ac15cba064cdebfbd23a:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual :ref:`GlyphDrawable<doxid-class_e_e_1_1_graphics_1_1_glyph_drawable>`* getGlyphDrawable(:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` codePoint, unsigned int characterSize, bool bold = false, bool italic = false, :ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` outlineThickness = 0, const :ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>`& forzeSize = 0) const = 0



.. rubric:: Returns:

The glyph drawable that represents the glyph in a texture. The glyph drawable allocation is managed by the font.

.. index:: pair: function; pushFontEventCallback
.. _doxid-class_e_e_1_1_graphics_1_1_font_1a855c816d23cd7ec5098d90b35cca1fa6:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` pushFontEventCallback(const :ref:`FontEventCallback<doxid-class_e_e_1_1_graphics_1_1_font_1a52dd0add68591e1ac93b5660139743d6>`& cb)

Push a new on resource change callback.



.. rubric:: Returns:

The Callback Id

.. index:: pair: function; popFontEventCallback
.. _doxid-class_e_e_1_1_graphics_1_1_font_1a5abd41b82e9c9d21cfd8a2b2a291b1e4:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void popFontEventCallback(const :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>`& callbackId)

Pop the on resource change callback id indicated.