Image Image Helper

Description

image_image helper is a base class for image helper. It provides functionality for working with data in objects of oneapi::ipl::image class using image memory.

Include Files

oneapi/ipl.hpp

Domain Dependencies

Headers: oneapi/ipl.hpp

Libraries: oneipl.lib

Syntax

template<formats Format, typename DataT, typename AllocatorT, typename UsmAllocatorT>
class oneapi::ipl::image_image_helper

Provides additional functionality for working with data in the objects of ipl::image class using image memory.

Template Parameters

  • Format – the given format of an image

  • DataT – the given type of a pixel component

  • AllocatorT – the given type of an image allocator

  • UsmAllocatorT – the given type of an USM allocator

Public Types

using data_t = DataT

Alias for the type of a pixel component.

using allocator_t = AllocatorT

Alias for the image allocator.

using usm_allocator_t = UsmAllocatorT

Alias for the USM allocator.

Public Functions

explicit image_image_helper(const ipl::image_image<Format, DataT, AllocatorT> &image_image, const UsmAllocatorT &usm_allocator)

Constructor for the image_image helper class.

Parameters

  • image_image – the given image

  • usm_allocator – [in] the given USM allocator

explicit image_image_helper(ipl::image_image<Format, DataT, AllocatorT> &&image_image, const UsmAllocatorT &usm_allocator)

Constructor for the image_image helper class.

Parameters

  • image_image – the given image

  • usm_allocator – [in] the given USM allocator

data_t *get_pointer()

Returns the pointer to image data.

Returns

the pointer to image data

data_t *get_usm_pointer()

Returns the USM pointer to image data.

Returns

the USM pointer to image data

Public Static Attributes

static constexpr auto format_v = Format

Alias for the format of an image.

previous

Image Helper

next

USM Image Helper