.. index:: pair: class; EE::UI::UIIcon
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_icon:

class EE::UI::UIIcon
====================

.. toctree::
	:hidden:

Overview
~~~~~~~~




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

	#include <uiicon.hpp>
	
	class UIIcon {
	public:
		// construction
	
		virtual :target:`~UIIcon<doxid-class_e_e_1_1_u_i_1_1_u_i_icon_1a769a673d76c630f675a6b342c1b9fcfe>`();

		// methods
	
		static :ref:`UIIconPtr<doxid-namespace_e_e_1_1_u_i_1ac86d546096b13557407260cd7759d731>` :target:`New<doxid-class_e_e_1_1_u_i_1_1_u_i_icon_1a7da5451c2a0647d038005b603121331b>`(const std::string& name);
		const std::string& :target:`getName<doxid-class_e_e_1_1_u_i_1_1_u_i_icon_1aaf2ac24ac3492645965d4368c984e4da>`() const;
		virtual const :ref:`DrawablePtr<doxid-namespace_e_e_1_1_graphics_1ad265841917d951291169b78d88f1678c>`& :ref:`getSource<doxid-class_e_e_1_1_u_i_1_1_u_i_icon_1ab6da2bdac5e34112b40216d361695791>`(const int& size) const;
		:ref:`DrawablePtr<doxid-namespace_e_e_1_1_graphics_1ad265841917d951291169b78d88f1678c>` :ref:`createDrawable<doxid-class_e_e_1_1_u_i_1_1_u_i_icon_1aa07c7365121ad2188cd59b01ef824059>`(const int& size) const;
		virtual void :target:`setSource<doxid-class_e_e_1_1_u_i_1_1_u_i_icon_1a0a0b99491cf7385fd04612277b195a6c>`(const int& size, :ref:`DrawablePtr<doxid-namespace_e_e_1_1_graphics_1ad265841917d951291169b78d88f1678c>` drawable);
	};
.. _details-class_e_e_1_1_u_i_1_1_u_i_icon:

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



Methods
-------

.. index:: pair: function; getSource
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_icon_1ab6da2bdac5e34112b40216d361695791:

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

	virtual const :ref:`DrawablePtr<doxid-namespace_e_e_1_1_graphics_1ad265841917d951291169b78d88f1678c>`& getSource(const int& size) const

Returns the icon source closest to the requested size.

The returned drawable is shared icon data and must not be mutated by consumers. Use :ref:`createDrawable() <doxid-class_e_e_1_1_u_i_1_1_u_i_icon_1aa07c7365121ad2188cd59b01ef824059>` when a consumer needs its own mutable drawable instance.

.. index:: pair: function; createDrawable
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_icon_1aa07c7365121ad2188cd59b01ef824059:

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

	:ref:`DrawablePtr<doxid-namespace_e_e_1_1_graphics_1ad265841917d951291169b78d88f1678c>` createDrawable(const int& size) const

Creates a private drawable instance for a consumer. This must not be called from a rendering loop; retain the returned instance instead.