.. index:: pair: class; P1::ImageSdk::JpegWriter
.. _doxid-class_p1_1_1_image_sdk_1_1_jpeg_writer:

class P1::ImageSdk::JpegWriter
==============================

.. toctree::
	:hidden:

Overview
~~~~~~~~




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

	#include <P1ImageJpegWriter.hpp>
	
	class JpegWriter
	{
	public:
		// construction
	
		:ref:`JpegWriter<doxid-class_p1_1_1_image_sdk_1_1_jpeg_writer_1ae047780f6809986d3b018708f072ebb0>`(
			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:`JpegConfig<doxid-struct_p1_1_1_image_sdk_1_1_jpeg_config>`& config
			);
	
		:ref:`JpegWriter<doxid-class_p1_1_1_image_sdk_1_1_jpeg_writer_1a52bb44dce380307f027d053987ea612e>`(
			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:`JpegConfig<doxid-struct_p1_1_1_image_sdk_1_1_jpeg_config>`& config
			);
	};
.. _details-class_p1_1_1_image_sdk_1_1_jpeg_writer:

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



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

.. index:: pair: function; JpegWriter
.. _doxid-class_p1_1_1_image_sdk_1_1_jpeg_writer_1ae047780f6809986d3b018708f072ebb0:

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

	JpegWriter(
		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:`JpegConfig<doxid-struct_p1_1_1_image_sdk_1_1_jpeg_config>`& config
		)

Writes a JPEG 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 metadata/preview

	*
		- SDKException

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

.. index:: pair: function; JpegWriter
.. _doxid-class_p1_1_1_image_sdk_1_1_jpeg_writer_1a52bb44dce380307f027d053987ea612e:

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

	JpegWriter(
		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:`JpegConfig<doxid-struct_p1_1_1_image_sdk_1_1_jpeg_config>`& config
		)

Writes a JPEG 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 metadata/preview

	*
		- SDKException

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