.. index:: pair: class; P1::ImageSdk::Jp2Writer
.. _doxid-class_p1_1_1_image_sdk_1_1_jp2_writer:

class P1::ImageSdk::Jp2Writer
=============================

.. toctree::
	:hidden:

Overview
~~~~~~~~




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

	#include <P1ImageJp2Writer.hpp>
	
	class Jp2Writer
	{
	public:
		// construction
	
		:ref:`Jp2Writer<doxid-class_p1_1_1_image_sdk_1_1_jp2_writer_1a17a393b2edb7fa8600f2b6dbb6ace3d4>`(
			std::string filename,
			:ref:`P1::ImageSdk::BitmapImage<doxid-class_p1_1_1_image_sdk_1_1_bitmap_image>`& bitmap,
			:ref:`P1::ImageSdk::RawImage<doxid-class_p1_1_1_image_sdk_1_1_raw_image>`& image,
			:ref:`Jp2Config<doxid-struct_p1_1_1_image_sdk_1_1_jp2_config>`& config
			);
	
		:ref:`Jp2Writer<doxid-class_p1_1_1_image_sdk_1_1_jp2_writer_1ad14edf7fd231fa1c408566220ce9457d>`(
			std::string filename,
			:ref:`P1::ImageSdk::BitmapImage<doxid-class_p1_1_1_image_sdk_1_1_bitmap_image>`& bitmap,
			:ref:`P1::ImageSdk::RawImage<doxid-class_p1_1_1_image_sdk_1_1_raw_image>`& image,
			:ref:`P1::ImageSdkC::P1MetaDataBase<doxid-class_p1_1_1_image_sdk_c_1_1_p1_meta_data_base>`& metadata,
			:ref:`Jp2Config<doxid-struct_p1_1_1_image_sdk_1_1_jp2_config>`& config
			);
	};
.. _details-class_p1_1_1_image_sdk_1_1_jp2_writer:

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



Construction
------------

.. index:: pair: function; Jp2Writer
.. _doxid-class_p1_1_1_image_sdk_1_1_jp2_writer_1a17a393b2edb7fa8600f2b6dbb6ace3d4:

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

	Jp2Writer(
		std::string filename,
		:ref:`P1::ImageSdk::BitmapImage<doxid-class_p1_1_1_image_sdk_1_1_bitmap_image>`& bitmap,
		:ref:`P1::ImageSdk::RawImage<doxid-class_p1_1_1_image_sdk_1_1_raw_image>`& image,
		:ref:`Jp2Config<doxid-struct_p1_1_1_image_sdk_1_1_jp2_config>`& config
		)

Writes a JPEG 2000 file to the disk synchronously.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- filename

		- The path to the output file, it may be a single character string.

	*
		- bitmap

		- The rendered bitmap

	*
		- image

		- The raw image's in memory representation

	*
		- config

		- Describes the JPEG 2000 metadata/preview

	*
		- SDKException

		- The function will throw an exception in case of failure.

.. index:: pair: function; Jp2Writer
.. _doxid-class_p1_1_1_image_sdk_1_1_jp2_writer_1ad14edf7fd231fa1c408566220ce9457d:

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

	Jp2Writer(
		std::string filename,
		:ref:`P1::ImageSdk::BitmapImage<doxid-class_p1_1_1_image_sdk_1_1_bitmap_image>`& bitmap,
		:ref:`P1::ImageSdk::RawImage<doxid-class_p1_1_1_image_sdk_1_1_raw_image>`& image,
		:ref:`P1::ImageSdkC::P1MetaDataBase<doxid-class_p1_1_1_image_sdk_c_1_1_p1_meta_data_base>`& metadata,
		:ref:`Jp2Config<doxid-struct_p1_1_1_image_sdk_1_1_jp2_config>`& config
		)

Writes a JPEG 2000 file to the disk synchronously.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- filename

		- The path to the output file, it may be a single character string.

	*
		- bitmap

		- The rendered bitmap

	*
		- image

		- The raw image's in memory representation

	*
		- metadata

		- The metadatabase to writen into the image file.

	*
		- config

		- Describes the JPEG 2000 metadata/preview

	*
		- SDKException

		- The function will throw an exception in case of failure.