.. SPDX-FileCopyrightText: 2021 Intel Corporation
..
.. SPDX-License-Identifier: CC-BY-4.0

.. _image-helper:

Image Helper
============


.. rubric:: Description
  :class: sectiontitle

Image helper class provides additional functionality for working with image data.


.. rubric:: Include Files
  :class: sectiontitle

``oneapi/ipl.hpp``


.. rubric:: Domain Dependencies
  :class: sectiontitle

Headers: ``oneapi/ipl.hpp``

Libraries: ``oneipl.lib``


.. rubric:: Syntax
   :class: sectiontitle

.. doxygenclass:: oneapi::ipl::image_helper
  :project: oneIPL
  :members:


The code example below demonstrates how to use the
``oneapi::ipl::image_helper``:

.. code-block:: cpp

  // Create queue
  sycl::queue queue{};
  
  // Create allocator
  sycl::usm_allocator<std::uint8_t, sycl::usm::alloc::shared> allocator{ queue };
  
  // Source RGBA image data (image_image)
  image<formats::rgba, std::uint8_t> src_image{ src_data_pointer, image_size };
  // Image helper
  image_helper helper{ src_image, allocator };
  // Destination RGBA image data (image_image)
  image<formats::rgba, std::uint8_t> dst_image{ helper.get_pointer(), image_size };


.. toctree::

   image-image-helper
   usm-image-helper