USM Image Helper

Description

USM Image helper is a base class for image helper. It provides functionality for working with data in USM-based images.

Include Files

oneapi/ipl.hpp

Domain Dependencies

Headers: oneapi/ipl.hpp

Libraries: oneipl.lib

Syntax

template<formats Format, typename DataT, typename UsmAllocatorT, typename UsmAllocatorT2>
class oneapi::ipl::usm_image_helper

Provides additional functionality for working with data in images based on USM.

Template Parameters

  • Format – the given format of an image

  • DataT – the given type of a pixel component

  • UsmAllocatorT – the first given type of an USM allocator

  • UsmAllocatorT2 – the second given type of an USM allocator

Public Types

using data_t = DataT

Alias for the type of a pixel component.

using usm_allocator_t = UsmAllocatorT

Alias for the first USM allocator.

using usm_allocator_t2 = UsmAllocatorT2

Alias for the second USM allocator.

Public Functions

explicit usm_image_helper(const ipl::usm_image<Format, DataT, UsmAllocatorT> &usm_image, const UsmAllocatorT2 &usm_allocator)

Constructor for the USM image helper class.

Parameters

  • usm_image – the given USM image

  • usm_allocator – [in] the given USM allocator

explicit usm_image_helper(ipl::usm_image<Format, DataT, UsmAllocatorT> &&usm_image, const UsmAllocatorT2 &usm_allocator)

Constructor for the USM image helper class.

Parameters

  • usm_image – the given USM image

  • usm_allocator – [in] the given USM allocator

auto get_pointer() -> data_t*

Returns the pointer with USM image data.

Returns

the pointer with USM image data

auto get_usm_pointer() -> data_t*

Returns the USM pointer to USM image data.

Returns

the USM pointer to USM image data

Public Static Attributes

static constexpr auto format_v = Format

Alias for the format of an image.

previous

Image Image Helper

next

Image Utils