.. _doxcsid-class_p1_1_1_image_sdk_1_1_huge_bitmap_image:

HugeBitmapImage Class
~~~~~~~~~~~~~~~~~~~~~

Definition
^^^^^^^^^^

*Namespace:* ``P1.ImageSdk``

An unmanaged memory bitmap image, too large to be stored as a *byte[]* object. Represented using a defined pixel format, width and height :ref:`More...<csdetails-class_p1_1_1_image_sdk_1_1_huge_bitmap_image>`

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

	public class HugeBitmapImage :  :ref:`P1::ImageSdk::IBitmapImage<doxcsid-interface_p1_1_1_image_sdk_1_1_i_bitmap_image>`


.. _csdetails-class_p1_1_1_image_sdk_1_1_huge_bitmap_image:

Remarks
^^^^^^^

An unmanaged memory bitmap image, too large to be stored as a *byte[]* object. Represented using a defined pixel format, width and height

Always use this class inside *using* contexts, to ensure proper (timely) disposal of the referenced unmanaged memory.

Also, be careful if you use the :ref:`NativeMemoryRef.ToArray <doxcsid-class_p1_1_1_image_sdk_1_1_native_memory_ref_1a0dc347eb5aeb2ef038e0e8a4216edd1d>` method, since it **will** truncate the returned data to fit inside an array with a signed 32-bit integer index. Meaning it can *only* return the first 2.1 GB of image data.


Properties
^^^^^^^^^^

.. toctree::
	:hidden:

	Data <property_P1_ImageSdk_HugeBitmapImage_Data.rst>
	ByteSize <property_P1_ImageSdk_HugeBitmapImage_ByteSize.rst>
	Format <property_P1_ImageSdk_HugeBitmapImage_Format.rst>
	Width <property_P1_ImageSdk_HugeBitmapImage_Width.rst>
	BitsPerSample <property_P1_ImageSdk_HugeBitmapImage_BitsPerSample.rst>
	SamplesPerPixel <property_P1_ImageSdk_HugeBitmapImage_SamplesPerPixel.rst>
	Height <property_P1_ImageSdk_HugeBitmapImage_Height.rst>
	Stride <property_P1_ImageSdk_HugeBitmapImage_Stride.rst>
	SourceCrop <property_P1_ImageSdk_HugeBitmapImage_SourceCrop.rst>
	ColorSpace <property_P1_ImageSdk_HugeBitmapImage_ColorSpace.rst>

.. list-table::
	:widths: 30 70

	*
		- :ref:`Data <doxcsid-class_p1_1_1_image_sdk_1_1_huge_bitmap_image_1a0895d6911deee910d8a8978c2c47be0c>`
		- Reference to the image data contained in unmanaged memory
	*
		- :ref:`ByteSize <doxcsid-class_p1_1_1_image_sdk_1_1_huge_bitmap_image_1a080504a81fbd6b8be3aae8c5af20531f>`
		- 
	*
		- :ref:`Format <doxcsid-class_p1_1_1_image_sdk_1_1_huge_bitmap_image_1acb9d19fc4031eb5f970dc2e6df67c957>`
		- 
	*
		- :ref:`Width <doxcsid-class_p1_1_1_image_sdk_1_1_huge_bitmap_image_1adbc77a787b2f898b5fba5e50d1a8d73b>`
		- 
	*
		- :ref:`BitsPerSample <doxcsid-class_p1_1_1_image_sdk_1_1_huge_bitmap_image_1a9db42e57a06680d460b242e7a7f57090>`
		- 
	*
		- :ref:`SamplesPerPixel <doxcsid-class_p1_1_1_image_sdk_1_1_huge_bitmap_image_1a8b162253038695f704a87f771d4edc3a>`
		- 
	*
		- :ref:`Height <doxcsid-class_p1_1_1_image_sdk_1_1_huge_bitmap_image_1af13a6f3a2c4e88c5ac11afad3955774e>`
		- 
	*
		- :ref:`Stride <doxcsid-class_p1_1_1_image_sdk_1_1_huge_bitmap_image_1a424d72a0aaf59c32b701ab430ff83c54>`
		- 
	*
		- :ref:`SourceCrop <doxcsid-class_p1_1_1_image_sdk_1_1_huge_bitmap_image_1aaa322b4cf95f3cba10ec65069a04f0f4>`
		- 
	*
		- :ref:`ColorSpace <doxcsid-class_p1_1_1_image_sdk_1_1_huge_bitmap_image_1a69918e5608c6f3d3ec88d7259b61fa95>`
		- 

Methods
^^^^^^^

.. toctree::
	:hidden:

	GetIntPtr <function_P1_ImageSdk_HugeBitmapImage_GetIntPtr.rst>
	Dispose <function_P1_ImageSdk_HugeBitmapImage_Dispose.rst>
	PromoteToBitmapImage <function_P1_ImageSdk_HugeBitmapImage_PromoteToBitmapImage.rst>

.. list-table::
	:widths: 33 67

	* 
		- :ref:`GetIntPtr() <doxcsid-class_p1_1_1_image_sdk_1_1_huge_bitmap_image_1a56edf7b7dabc61b3c96423c41802d995>`
		- Get a IntPtr provider that creates and destroys handles to the underlying data buffer with the image data
	* 
		- :ref:`Dispose() <doxcsid-class_p1_1_1_image_sdk_1_1_huge_bitmap_image_1ab9b87e2d444b90ccecead827fe690cdc>`
		- 
	* 
		- :ref:`PromoteToBitmapImage() <doxcsid-class_p1_1_1_image_sdk_1_1_huge_bitmap_image_1a7a8b9eeb9d3c7a1132369a21fb8054bb>`
		-