.. index:: pair: class; P1::ImageSdk::BitmapImage
.. _doxid-class_p1_1_1_image_sdk_1_1_bitmap_image:

class P1::ImageSdk::BitmapImage
===============================

.. toctree::
	:hidden:

Overview
~~~~~~~~

In-memory representation of an RGB bitmap image. :ref:`More...<details-class_p1_1_1_image_sdk_1_1_bitmap_image>`


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

	#include <P1ImageBitmapImage.hpp>
	
	class BitmapImage: public :ref:`P1::ImageSdk::BitmapBase<doxid-class_p1_1_1_image_sdk_1_1_bitmap_base>`
	{
	public:
		// methods
	
		:ref:`BitmapFormat<doxid-namespace_p1_1_1_image_sdk_1aa5aef9c59675209aad9d961cfa29ba0a>` :ref:`Format<doxid-class_p1_1_1_image_sdk_1_1_bitmap_image_1adee698d96221e62e7a6c9b0890f5c924>`() const;
		:ref:`ColorSpace<doxid-namespace_p1_1_1_image_sdk_1afd1a416009b1638a7faf6ac66bbef929>` :target:`GetColorSpace<doxid-class_p1_1_1_image_sdk_1_1_bitmap_image_1adfce92c0acfd66011285d63c53b60a6d>`() const;
		uint32_t :ref:`Width<doxid-class_p1_1_1_image_sdk_1_1_bitmap_image_1a71d0652e3e101de76c56181987b0cf9e>`() const;
		uint32_t :ref:`Height<doxid-class_p1_1_1_image_sdk_1_1_bitmap_image_1a10e74dc8dab5e922ac479bb27a9f0d05>`() const;
		:ref:`Rect<doxid-struct_p1_1_1_image_sdk_1_1_rect>` :ref:`SourceCrop<doxid-class_p1_1_1_image_sdk_1_1_bitmap_image_1a12233df605e777268f4c0d47fcff84ef>`() const;
	};

	// direct descendants

	template <typename T>
	class :ref:`MutableBitmapImage<doxid-class_p1_1_1_image_sdk_1_1_mutable_bitmap_image>`;

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

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

	public:
		// methods
	
		int64_t :ref:`ByteSize<doxid-class_p1_1_1_image_sdk_1_1_bitmap_base_1a04af92695c1a64c06a7fb9895ba2b5d2>`() const;
		uint32_t :ref:`Stride<doxid-class_p1_1_1_image_sdk_1_1_bitmap_base_1af0616e8d8f2400d88f4c3c63903bae50>`() const;
		uint32_t :ref:`BitsPerSample<doxid-class_p1_1_1_image_sdk_1_1_bitmap_base_1aa12a18797980d4f11dc2ea53dd269f80>`() const;
		uint32_t :ref:`SamplesPerPixel<doxid-class_p1_1_1_image_sdk_1_1_bitmap_base_1ad3a3a8a2678e674929683f3b2746ea2e>`() const;
		:ref:`MSVC_ALLOW_PUBLIC_STL<doxid-class_p1_1_1_image_sdk_1_1_bitmap_base_1acd132389e1d44e76f90a110d9f647f58>`(std::shared_ptr<uint8_t>  Data());

.. _details-class_p1_1_1_image_sdk_1_1_bitmap_image:

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

In-memory representation of an RGB bitmap image.

Methods
-------

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

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

	:ref:`BitmapFormat<doxid-namespace_p1_1_1_image_sdk_1aa5aef9c59675209aad9d961cfa29ba0a>` Format() const

The pixel format of the Data array.

.. index:: pair: function; Width
.. _doxid-class_p1_1_1_image_sdk_1_1_bitmap_image_1a71d0652e3e101de76c56181987b0cf9e:

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

	uint32_t Width() const

Image Width in pixels.

.. index:: pair: function; Height
.. _doxid-class_p1_1_1_image_sdk_1_1_bitmap_image_1a10e74dc8dab5e922ac479bb27a9f0d05:

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

	uint32_t Height() const

Image height in pixels.

.. index:: pair: function; SourceCrop
.. _doxid-class_p1_1_1_image_sdk_1_1_bitmap_image_1a12233df605e777268f4c0d47fcff84ef:

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

	:ref:`Rect<doxid-struct_p1_1_1_image_sdk_1_1_rect>` SourceCrop() const

If this image is cropped from a larger source image, this is the crop in source coordinates.