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

.. _usm-image-class:

USM_Image Class
================


.. rubric:: Description
  :class: sectiontitle

The ``usm_image`` class provides functionality similar to ``oneapi::ipl::image_image`` class 
based on Unified Shared Memory with extended format and 
:ref:`ROI<image-regions-of-interest>` support.
It must be the base class for the :ref:`Image class<image-class>` if format 
is not ``oneapi::ipl::formats::rgba``. This class is not recommended for use as a parameter in 
oneIPL image processing functions, use :ref:`Image class<image-class>` instead.

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


Supported values for Format:

.. list-table::
    :header-rows: 0

    * -     ``rgb``
    * -     ``bgr``
    * -     ``bgra``
    * -     ``nv12``
    * -     ``i420``
    * -     ``plane``
    * -     ``rgbp``


Supported values for DataT:

.. list-table::
    :header-rows: 0

    * -     ``std::int8_t``
    * -     ``std::uint8_t``
    * -     ``std::int16_t``
    * -     ``std::uint16_t``
    * -     ``std::int32_t``
    * -     ``std::uint32_t``
    * -     ``float``