.. index:: pair: class; EE::Window::KittyFramePresenter
.. _doxid-class_e_e_1_1_window_1_1_kitty_frame_presenter:

class EE::Window::KittyFramePresenter
=====================================

.. toctree::
	:hidden:

	struct_EE_Window_KittyFramePresenter_DamageRectangle.rst
	struct_EE_Window_KittyFramePresenter_Frame.rst

Overview
~~~~~~~~

Presents completed window frames using the Kitty graphics protocol. :ref:`More...<details-class_e_e_1_1_window_1_1_kitty_frame_presenter>`


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

	#include <kittyframepresenter.hpp>
	
	class KittyFramePresenter: public :ref:`EE::Window::FramePresenter<doxid-class_e_e_1_1_window_1_1_frame_presenter>` {
	public:
		// structs
	
		struct :ref:`DamageRectangle<doxid-struct_e_e_1_1_window_1_1_kitty_frame_presenter_1_1_damage_rectangle>`;
		struct :ref:`Frame<doxid-struct_e_e_1_1_window_1_1_kitty_frame_presenter_1_1_frame>`;

		// construction
	
		:target:`~KittyFramePresenter<doxid-class_e_e_1_1_window_1_1_kitty_frame_presenter_1aecbb025fa6bf68ae6ede285a6f38bcb0>`();

		// methods
	
		virtual bool :ref:`initialize<doxid-class_e_e_1_1_window_1_1_kitty_frame_presenter_1ae0256d3be12b554625c7b09de0800eba>`(:ref:`Window<doxid-class_e_e_1_1_window_1_1_window>`&);
		virtual void :ref:`present<doxid-class_e_e_1_1_window_1_1_kitty_frame_presenter_1aa54e0157f4c13a4b118439a9b61a7567>`(:ref:`Window<doxid-class_e_e_1_1_window_1_1_window>`&);
		virtual void :ref:`shutdown<doxid-class_e_e_1_1_window_1_1_kitty_frame_presenter_1a24cf5c9ee272af18f47e2c4f176d5ec8>`(:ref:`Window<doxid-class_e_e_1_1_window_1_1_window>`&);
	};

Inherited Members
-----------------

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

	public:
		// methods
	
		virtual bool :ref:`initialize<doxid-class_e_e_1_1_window_1_1_frame_presenter_1a748b75c87c230945cde78fb8be777339>`(:ref:`Window<doxid-class_e_e_1_1_window_1_1_window>`&) = 0;
		virtual void :ref:`present<doxid-class_e_e_1_1_window_1_1_frame_presenter_1ae8fab37e4fec5d340d1408cc2fd439b5>`(:ref:`Window<doxid-class_e_e_1_1_window_1_1_window>`&) = 0;
		virtual void :ref:`resized<doxid-class_e_e_1_1_window_1_1_frame_presenter_1a61d4bd5c78a48f76d5224b609cf0a0f5>`(:ref:`Window<doxid-class_e_e_1_1_window_1_1_window>`&, const :ref:`Math::Sizei<doxid-namespace_e_e_1_1_math_1a1c93093fd84336325187a22fda66cf51>`&);
		virtual void :ref:`shutdown<doxid-class_e_e_1_1_window_1_1_frame_presenter_1a0ce3e369c501fecfa971f1fb645f4561>`(:ref:`Window<doxid-class_e_e_1_1_window_1_1_window>`&);

.. _details-class_e_e_1_1_window_1_1_kitty_frame_presenter:

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

Presents completed window frames using the Kitty graphics protocol.

Presentation policy can be configured before initialization with ``EEPP_TERMINAL_DAMAGE_UPDATES``, ``EEPP_TERMINAL_PERSISTENT_UPDATES``, and ``EEPP_TERMINAL_ZLIB_LEVEL``. Damage and persistent updates default to enabled. The zlib level defaults to 1, accepts levels 1 through 9, and can be set to 0 to disable compression. Disabling persistent updates also disables damage updates because rectangles require a persistent image.

Methods
-------

.. index:: pair: function; initialize
.. _doxid-class_e_e_1_1_window_1_1_kitty_frame_presenter_1ae0256d3be12b554625c7b09de0800eba:

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

	virtual bool initialize(:ref:`Window<doxid-class_e_e_1_1_window_1_1_window>`&)

Initializes the terminal transport and sender worker.

.. index:: pair: function; present
.. _doxid-class_e_e_1_1_window_1_1_kitty_frame_presenter_1aa54e0157f4c13a4b118439a9b61a7567:

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

	virtual void present(:ref:`Window<doxid-class_e_e_1_1_window_1_1_window>`&)

Captures and queues the newest complete RGB24 frame.

.. index:: pair: function; shutdown
.. _doxid-class_e_e_1_1_window_1_1_kitty_frame_presenter_1a24cf5c9ee272af18f47e2c4f176d5ec8:

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

	virtual void shutdown(:ref:`Window<doxid-class_e_e_1_1_window_1_1_window>`&)

Stops the sender worker and restores the terminal transport.