.. _doxcsid-class_p1_1_1_image_sdk_1_1_bitmap_format:

BitmapFormat Class
~~~~~~~~~~~~~~~~~~

Definition
^^^^^^^^^^

*Namespace:* ``P1.ImageSdk``

Define format of the bitmap memory. See :ref:`BitmapFormatTypeCode <doxcsid-namespace_p1_1_1_image_sdk_1acd68c8371039e420c5be7511a6ce7fd1>` for predefined bitmap format. :ref:`More...<csdetails-class_p1_1_1_image_sdk_1_1_bitmap_format>`

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

	public class BitmapFormat


.. _csdetails-class_p1_1_1_image_sdk_1_1_bitmap_format:

Remarks
^^^^^^^

Define format of the bitmap memory. See :ref:`BitmapFormatTypeCode <doxcsid-namespace_p1_1_1_image_sdk_1acd68c8371039e420c5be7511a6ce7fd1>` for predefined bitmap format.


Constructors
^^^^^^^^^^^^

.. toctree::
	:hidden:	

	BitmapFormat <function_P1_ImageSdk_BitmapFormat_BitmapFormat.rst>
	BitmapFormat <function_P1_ImageSdk_BitmapFormat_BitmapFormat-2.rst>
	BitmapFormat <function_P1_ImageSdk_BitmapFormat_BitmapFormat-3.rst>

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

	*
		- :ref:`BitmapFormat() <doxcsid-class_p1_1_1_image_sdk_1_1_bitmap_format_1a6845bdde74001a32b735279c62a2a60e>`
		- Create a :ref:`BitmapFormat <doxcsid-class_p1_1_1_image_sdk_1_1_bitmap_format>` with Unknown format code
	*
		- :ref:`BitmapFormat(BitDepth bitDepth, PixelLayout pixelLayout, params PixelComponent[] pixelComponents) <doxcsid-class_p1_1_1_image_sdk_1_1_bitmap_format_1aa2ee3d30d4c8b263836da35b008858d8>`
		- Create a bitmap format with customized info.
	*
		- :ref:`BitmapFormat(int code) <doxcsid-class_p1_1_1_image_sdk_1_1_bitmap_format_1acecd83dfbcd7afc3935ea3ee2a355b5b>`
		- Create :ref:`BitmapFormat <doxcsid-class_p1_1_1_image_sdk_1_1_bitmap_format>` from BitmapFormatTypeCode

Properties
^^^^^^^^^^

.. toctree::
	:hidden:

	BitmapFormatType <property_P1_ImageSdk_BitmapFormat_BitmapFormatType.rst>
	BitDepth <property_P1_ImageSdk_BitmapFormat_BitDepth.rst>
	PixelLayout <property_P1_ImageSdk_BitmapFormat_PixelLayout.rst>
	PixelComponent <property_P1_ImageSdk_BitmapFormat_PixelComponent.rst>

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

	*
		- :ref:`BitmapFormatType <doxcsid-class_p1_1_1_image_sdk_1_1_bitmap_format_1aa37a6bd19a4bd58ada08ece82cb654b1>`
		- Return predefined format code.
	*
		- :ref:`BitDepth <doxcsid-class_p1_1_1_image_sdk_1_1_bitmap_format_1a4c71d309b5440bb53773cfea60760118>`
		- Data type of each pixel component.
	*
		- :ref:`PixelLayout <doxcsid-class_p1_1_1_image_sdk_1_1_bitmap_format_1a25edf2189f667b53e69fbe32b1a4c047>`
		- Memory layout of the data buffer
	*
		- :ref:`PixelComponent <doxcsid-class_p1_1_1_image_sdk_1_1_bitmap_format_1af9568ff03b41c915107916d70c847c28>`
		- Content of each channel in a pixel.

Methods
^^^^^^^

.. toctree::
	:hidden:

	GetBitsPerSample <function_P1_ImageSdk_BitmapFormat_GetBitsPerSample.rst>
	SetAlignment <function_P1_ImageSdk_BitmapFormat_SetAlignment.rst>
	Equals <function_P1_ImageSdk_BitmapFormat_Equals.rst>
	operator BitmapFormat <function_P1_ImageSdk_BitmapFormat_operator BitmapFormat.rst>
	operator== <function_P1_ImageSdk_BitmapFormat_operator.rst>
	operator!= <function_P1_ImageSdk_BitmapFormat_operator-2.rst>
	operator int <function_P1_ImageSdk_BitmapFormat_operator int.rst>

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

	* 
		- :ref:`GetBitsPerSample() <doxcsid-class_p1_1_1_image_sdk_1_1_bitmap_format_1a2de70eba097ab8f1d346abc580cb44c5>`
		- Number of bit per channel per pixel. See :ref:`BitDepth <doxcsid-class_p1_1_1_image_sdk_1_1_bitmap_format_1a4c71d309b5440bb53773cfea60760118>`.
	* 
		- :ref:`SetAlignment(bool align) <doxcsid-class_p1_1_1_image_sdk_1_1_bitmap_format_1a21b0026428e92436f24f17b7b7b12960>`
		- Set memory buffer alignment (only take effect with 12-bit BitDepth).
	* 
		- :ref:`Equals(object obj) <doxcsid-class_p1_1_1_image_sdk_1_1_bitmap_format_1afe5ed4e1686eaf3ad505213afd47791b>`
		- 
	* 
		- :ref:`operator BitmapFormat(int code) <doxcsid-class_p1_1_1_image_sdk_1_1_bitmap_format_1a6cc2bb9b449bd2750b7e263e490b2e1a>`
		- Implicit cast from BitmapFormatTypeCode
	* 
		- :ref:`operator==(BitmapFormat lhs, BitmapFormat rhs) <doxcsid-class_p1_1_1_image_sdk_1_1_bitmap_format_1a4280555065901444d559e2c52207ef8a>`
		- Check if two :ref:`BitmapFormat <doxcsid-class_p1_1_1_image_sdk_1_1_bitmap_format>` are identical
	* 
		- :ref:`operator!=(BitmapFormat lhs, BitmapFormat rhs) <doxcsid-class_p1_1_1_image_sdk_1_1_bitmap_format_1a58a6130ccd0b1af729338ffd5ef45108>`
		- Check if two :ref:`BitmapFormat <doxcsid-class_p1_1_1_image_sdk_1_1_bitmap_format>` are different
	* 
		- :ref:`operator int(BitmapFormat d) <doxcsid-class_p1_1_1_image_sdk_1_1_bitmap_format_1a264177084ba9e2eb2d33bde22e2a55f1>`
		- Implicit cast bitmapFormat code to int