.. index:: pair: class; P1::CameraSdk::ImageEnumBuffer
.. _doxid-class_p1_1_1_camera_sdk_1_1_image_enum_buffer:

class P1::CameraSdk::ImageEnumBuffer
====================================

.. toctree::
	:hidden:

Overview
~~~~~~~~




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

	#include <C_P1CameraPrivStructs.hpp>
	
	class ImageEnumBuffer:
	    public :ref:`P1::CameraSdk::IImageBuffer<doxid-class_p1_1_1_camera_sdk_1_1_i_image_buffer>`,
	    public :ref:`P1::CameraSdk::ImageFileCommonImpl<doxid-class_p1_1_1_camera_sdk_1_1_image_file_common_impl>`
	{
	public:
		// typedefs
	
		typedef P1::IQP::ImageEnumerationAgent::ImageBuffer const :target:`PrivStructType<doxid-class_p1_1_1_camera_sdk_1_1_image_enum_buffer_1ac12a3ab5f9de339edc8617c26270cdad>`;

		// construction
	
		:target:`ImageEnumBuffer<doxid-class_p1_1_1_camera_sdk_1_1_image_enum_buffer_1abe734e075b1e7b4684b5fdd8e63f22b1>`(:ref:`PrivStructType<doxid-class_p1_1_1_camera_sdk_1_1_image_enum_buffer_1ac12a3ab5f9de339edc8617c26270cdad>`*const dataStruct);

		// methods
	
		virtual std::shared_ptr<uint8_t const> :ref:`Data<doxid-class_p1_1_1_camera_sdk_1_1_image_enum_buffer_1a9f8b14443c243c5a9f61d5b13fc5a389>`() const;
		virtual size_t :ref:`DataSizeBytes<doxid-class_p1_1_1_camera_sdk_1_1_image_enum_buffer_1a8ef8d358e6b541eabc2d1af66d172bcd>`() const;
		virtual :ref:`ImageFormat<doxid-namespace_p1_1_1_camera_sdk_1a56985d71dffbf0cd6359e82b0ad7778d>` :ref:`Format<doxid-class_p1_1_1_camera_sdk_1_1_image_enum_buffer_1a1919186c5f924db23cdfd40a360dd8ff>`() const;
		virtual :ref:`Type<doxid-class_p1_1_1_camera_sdk_1_1_i_image_buffer_1a353ab2d01f8a9012d90d0fcf50c6aa29>` :ref:`BufferType<doxid-class_p1_1_1_camera_sdk_1_1_image_enum_buffer_1aa0142a65d131c8bb0e7127e34ec1e50e>`() const;
		virtual char const* :ref:`BufferTypeStr<doxid-class_p1_1_1_camera_sdk_1_1_image_enum_buffer_1a5c95b69497b9de3713d60a3ff807c489>`() const;
		virtual char const* :ref:`FormatStr<doxid-class_p1_1_1_camera_sdk_1_1_image_enum_buffer_1ac2c929290a66a25a82b63d0726567d08>`() const;
	};

	// direct descendants

	class :ref:`PreviewImpl<doxid-class_p1_1_1_camera_sdk_1_1_preview_impl>`;
	class :ref:`TileImpl<doxid-class_p1_1_1_camera_sdk_1_1_tile_impl>`;

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

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

	public:
		// typedefs
	
		typedef P1::IQP::ImageEnumerationAgent::AssembleStatus const :ref:`PrivStructTypeCommon<doxid-class_p1_1_1_camera_sdk_1_1_image_file_common_impl_1a73a10eced42f21a438fc5040dd4a9f32>`;

		// enums
	
		enum :ref:`Type<doxid-class_p1_1_1_camera_sdk_1_1_i_image_buffer_1a353ab2d01f8a9012d90d0fcf50c6aa29>`;
		enum :ref:`Errors<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common_1a5415589ad16ed744046e184d686d60ff>`;

		// methods
	
		virtual std::shared_ptr<uint8_t const> :ref:`Data<doxid-class_p1_1_1_camera_sdk_1_1_i_image_buffer_1aa6f7953c78c76ac4000809bb52ae19c8>`() const = 0;
		virtual size_t :ref:`DataSizeBytes<doxid-class_p1_1_1_camera_sdk_1_1_i_image_buffer_1a085c3678f2263750b6c9523916de429d>`() const = 0;
		virtual :ref:`ImageFormat<doxid-namespace_p1_1_1_camera_sdk_1a56985d71dffbf0cd6359e82b0ad7778d>` :ref:`Format<doxid-class_p1_1_1_camera_sdk_1_1_i_image_buffer_1aa5aaae45266322f219a69ab542a9733b>`() const = 0;
		virtual :ref:`Type<doxid-class_p1_1_1_camera_sdk_1_1_i_image_buffer_1a353ab2d01f8a9012d90d0fcf50c6aa29>` :ref:`BufferType<doxid-class_p1_1_1_camera_sdk_1_1_i_image_buffer_1a8b95966fd34efe064ca1272869306fc8>`() const = 0;
		virtual char const* :ref:`BufferTypeStr<doxid-class_p1_1_1_camera_sdk_1_1_i_image_buffer_1a203a4b12c6b346f470a65d4622e4fd2c>`() const = 0;
		virtual char const* :ref:`FormatStr<doxid-class_p1_1_1_camera_sdk_1_1_i_image_buffer_1ad2680af8228eb0b09a546dfdc5cfbc17>`() const = 0;
		virtual uint32_t :ref:`ImageId<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common_1aa54da65815c373545187a60f0d1c1659>`() const = 0;
		virtual bool :ref:`AnyErrors<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common_1a7a338a7fd5c4097e9035e7e7ebbf268b>`() const = 0;
		virtual :ref:`Errors<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common_1a5415589ad16ed744046e184d686d60ff>` :ref:`ImageFileErrors<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common_1ab55e830b1aeb244af2e27978100690d5>`() const = 0;
		virtual std::string :ref:`ErrorsString<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common_1a3ed0f53f31808c058f0378bd66c25ce0>`() const = 0;
		virtual uint32_t :ref:`ImageId<doxid-class_p1_1_1_camera_sdk_1_1_image_file_common_impl_1aecd0ab32f42bea5ae6d56d6383704b33>`() const;
		virtual bool :ref:`AnyErrors<doxid-class_p1_1_1_camera_sdk_1_1_image_file_common_impl_1a49f82e608e25c1eac52317b04b91cd9a>`() const;
		virtual :ref:`IImageFileCommon::Errors<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common_1a5415589ad16ed744046e184d686d60ff>` :ref:`ImageFileErrors<doxid-class_p1_1_1_camera_sdk_1_1_image_file_common_impl_1ae7796fbcdfd577fb71ac836703aa5b1b>`() const;
		virtual std::string :ref:`ErrorsString<doxid-class_p1_1_1_camera_sdk_1_1_image_file_common_impl_1aaec716951fe748df6b4b88ae548c9d92>`() const;

.. _details-class_p1_1_1_camera_sdk_1_1_image_enum_buffer:

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



Methods
-------

.. index:: pair: function; Data
.. _doxid-class_p1_1_1_camera_sdk_1_1_image_enum_buffer_1a9f8b14443c243c5a9f61d5b13fc5a389:

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

	virtual std::shared_ptr<uint8_t const> Data() const

Returns a pointer to the pixel buffer data.

.. index:: pair: function; DataSizeBytes
.. _doxid-class_p1_1_1_camera_sdk_1_1_image_enum_buffer_1a8ef8d358e6b541eabc2d1af66d172bcd:

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

	virtual size_t DataSizeBytes() const

Returns the size of the pixel buffer in bytes.

.. index:: pair: function; Format
.. _doxid-class_p1_1_1_camera_sdk_1_1_image_enum_buffer_1a1919186c5f924db23cdfd40a360dd8ff:

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

	virtual :ref:`ImageFormat<doxid-namespace_p1_1_1_camera_sdk_1a56985d71dffbf0cd6359e82b0ad7778d>` Format() const

Returns the image encoding type of this buffer (bitmap, jpeg)

.. index:: pair: function; BufferType
.. _doxid-class_p1_1_1_camera_sdk_1_1_image_enum_buffer_1aa0142a65d131c8bb0e7127e34ec1e50e:

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

	virtual :ref:`Type<doxid-class_p1_1_1_camera_sdk_1_1_i_image_buffer_1a353ab2d01f8a9012d90d0fcf50c6aa29>` BufferType() const

Returns the type kind of this buffer, (preview or tile)

.. index:: pair: function; BufferTypeStr
.. _doxid-class_p1_1_1_camera_sdk_1_1_image_enum_buffer_1a5c95b69497b9de3713d60a3ff807c489:

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

	virtual char const* BufferTypeStr() const

Returns a string of the type kind of this buffer, (preview or tile)

.. index:: pair: function; FormatStr
.. _doxid-class_p1_1_1_camera_sdk_1_1_image_enum_buffer_1ac2c929290a66a25a82b63d0726567d08:

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

	virtual char const* FormatStr() const

Returns a string of the type kind of this buffer, (RGB, JPEG, etc.)