.. index:: pair: struct; EE::Window::FrameReadback
.. _doxid-struct_e_e_1_1_window_1_1_frame_readback:

struct EE::Window::FrameReadback
================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Description of caller-owned storage for a framebuffer rectangle readback. :ref:`More...<details-struct_e_e_1_1_window_1_1_frame_readback>`


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

	#include <window.hpp>
	
	struct FrameReadback {
		// fields
	
		:ref:`Uint8<doxid-namespace_e_e_1aa226754e64fe26f32b5526c7cd36fa75>`* :ref:`pixels<doxid-struct_e_e_1_1_window_1_1_frame_readback_1ab22916d9d7dfbf0eb2c46146a99e1b2c>` { nullptr };
		:ref:`Sizei<doxid-namespace_e_e_1_1_math_1a1c93093fd84336325187a22fda66cf51>` :ref:`size<doxid-struct_e_e_1_1_window_1_1_frame_readback_1a10de5dfdfd63a4b15da29591a06d8c28>`;
		size_t :ref:`stride<doxid-struct_e_e_1_1_window_1_1_frame_readback_1a2e914f6d0f658fe94597aa35cb4b8013>` { 0 };
		:ref:`Vector2i<doxid-namespace_e_e_1_1_math_1a239f880abf75c42a0c85201dbae17ff1>` :ref:`position<doxid-struct_e_e_1_1_window_1_1_frame_readback_1ac1c94c766fda106ed770f860d91c7290>`;
		:ref:`FramePixelFormat<doxid-namespace_e_e_1_1_window_1aa23d88233056f72d924e9a0c44b5d4bd>` :ref:`format<doxid-struct_e_e_1_1_window_1_1_frame_readback_1a2c45c28c33af6ab6d82745d089b74aac>` { :ref:`FramePixelFormat::RGB24<doxid-namespace_e_e_1_1_window_1aa23d88233056f72d924e9a0c44b5d4bda08415b81fed4feed7d982c9919ac08ee>` };
		:ref:`FrameOrigin<doxid-namespace_e_e_1_1_window_1ac5491a951e1a7ad49661aa9dd7e842db>` :ref:`origin<doxid-struct_e_e_1_1_window_1_1_frame_readback_1a9c74e568a7672bab158f1c4538af9a75>` { :ref:`FrameOrigin::BottomLeft<doxid-namespace_e_e_1_1_window_1ac5491a951e1a7ad49661aa9dd7e842dba98e5a1c44509157ebcaf46c515c78875>` };
	};
.. _details-struct_e_e_1_1_window_1_1_frame_readback:

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

Description of caller-owned storage for a framebuffer rectangle readback.

Fields
------

.. index:: pair: variable; pixels
.. _doxid-struct_e_e_1_1_window_1_1_frame_readback_1ab22916d9d7dfbf0eb2c46146a99e1b2c:

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

	:ref:`Uint8<doxid-namespace_e_e_1aa226754e64fe26f32b5526c7cd36fa75>`* pixels { nullptr }

Destination pixel storage.

.. index:: pair: variable; size
.. _doxid-struct_e_e_1_1_window_1_1_frame_readback_1a10de5dfdfd63a4b15da29591a06d8c28:

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

	:ref:`Sizei<doxid-namespace_e_e_1_1_math_1a1c93093fd84336325187a22fda66cf51>` size

Rectangle size in pixels.

.. index:: pair: variable; stride
.. _doxid-struct_e_e_1_1_window_1_1_frame_readback_1a2e914f6d0f658fe94597aa35cb4b8013:

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

	size_t stride { 0 }

Destination row stride in bytes.

.. index:: pair: variable; position
.. _doxid-struct_e_e_1_1_window_1_1_frame_readback_1ac1c94c766fda106ed770f860d91c7290:

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

	:ref:`Vector2i<doxid-namespace_e_e_1_1_math_1a239f880abf75c42a0c85201dbae17ff1>` position

Bottom-left framebuffer coordinate of the rectangle.

.. index:: pair: variable; format
.. _doxid-struct_e_e_1_1_window_1_1_frame_readback_1a2c45c28c33af6ab6d82745d089b74aac:

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

	:ref:`FramePixelFormat<doxid-namespace_e_e_1_1_window_1aa23d88233056f72d924e9a0c44b5d4bd>` format { :ref:`FramePixelFormat::RGB24<doxid-namespace_e_e_1_1_window_1aa23d88233056f72d924e9a0c44b5d4bda08415b81fed4feed7d982c9919ac08ee>` }

Destination pixel layout.

.. index:: pair: variable; origin
.. _doxid-struct_e_e_1_1_window_1_1_frame_readback_1a9c74e568a7672bab158f1c4538af9a75:

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

	:ref:`FrameOrigin<doxid-namespace_e_e_1_1_window_1ac5491a951e1a7ad49661aa9dd7e842db>` origin { :ref:`FrameOrigin::BottomLeft<doxid-namespace_e_e_1_1_window_1ac5491a951e1a7ad49661aa9dd7e842dba98e5a1c44509157ebcaf46c515c78875>` }

Requested destination row orientation.