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

.. _image-utils:

Image Utils
===========


.. rubric:: Description
  :class: sectiontitle

Image utils class provides additional functionality for working with images.


.. 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_utils
  :project: oneIPL
  :members:


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

.. code-block:: cpp

  // Create queue
  sycl::queue queue{};
  
  // Create allocator
  shared_usm_allocator_t allocator{ queue };
  
  // RGB image (usm_image)
  image<formats::rgb, std::uint8_t> usm_image{ queue, src_data_pointer, image_size, allocator };
  
  const auto width  = oneapi::ipl::image_utils::get_width(usm_image);
  const auto height = oneapi::ipl::image_utils::get_height(usm_image);
  
  std::cout << "width = " << width << std::endl;
  std::cout << "height = " << height << std::endl;