.. index:: pair: class; P1::CameraSdk::IImageBuffer
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_image_buffer:

class P1::CameraSdk::IImageBuffer
=================================

.. toctree::
	:hidden:

	enum_P1_CameraSdk_IImageBuffer_Type.rst

Overview
~~~~~~~~

Contains an image buffer, encoded in either in bitmap or JPEG format. :ref:`More...<details-class_p1_1_1_camera_sdk_1_1_i_image_buffer>`


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

	#include <C_P1CameraCommonStructs.h>
	
	class IImageBuffer
	{
	public:
		// enums
	
		enum :ref:`Type<doxid-class_p1_1_1_camera_sdk_1_1_i_image_buffer_1a353ab2d01f8a9012d90d0fcf50c6aa29>`;

		// 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;
	};

	// direct descendants

	class :ref:`IFullImage<doxid-class_p1_1_1_camera_sdk_1_1_i_full_image>`;
	class :ref:`IImageBufferFrame<doxid-class_p1_1_1_camera_sdk_1_1_i_image_buffer_frame>`;
	class :ref:`ImageEnumBuffer<doxid-class_p1_1_1_camera_sdk_1_1_image_enum_buffer>`;
.. _details-class_p1_1_1_camera_sdk_1_1_i_image_buffer:

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

Contains an image buffer, encoded in either in bitmap or JPEG format.

:ref:`Version <doxid-struct_p1_1_1_camera_sdk_1_1_version>` 3.0

Methods
-------

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

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

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

Returns a pointer to the pixel buffer data.

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

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

	virtual size_t DataSizeBytes() const = 0

Returns the size of the pixel buffer in bytes.

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

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

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

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

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

.. 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 = 0

Returns the type of this buffer.

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

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

	virtual char const* BufferTypeStr() const = 0

Returns a string of the type this buffer.

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

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

	virtual char const* FormatStr() const = 0

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