#include <sycl/image.hpp>

Inheritance diagram for sycl::_V1::sampled_image< Dimensions, AllocatorT >:

[legend]

Collaboration diagram for sycl::_V1::sampled_image< Dimensions, AllocatorT >:

[legend]

Public Member Functions
	sampled_image (const void *HostPointer, image_format Format, image_sampler Sampler, const range< Dimensions > &Range, const property_list &PropList={}, const detail::code_location CodeLoc=detail::code_location::current())

template<bool IsMultiDim = (Dimensions > 1), typename = std::enable_if_t<IsMultiDim>>
	sampled_image (const void *HostPointer, image_format Format, image_sampler Sampler, const range< Dimensions > &Range, const range< Dimensions - 1 > &Pitch, const property_list &PropList={}, const detail::code_location CodeLoc=detail::code_location::current())

	sampled_image (std::shared_ptr< const void > &HostPointer, image_format Format, image_sampler Sampler, const range< Dimensions > &Range, const property_list &PropList={}, const detail::code_location CodeLoc=detail::code_location::current())

template<bool IsMultiDim = (Dimensions > 1), typename = std::enable_if_t<IsMultiDim>>
	sampled_image (std::shared_ptr< const void > &HostPointer, image_format Format, image_sampler Sampler, const range< Dimensions > &Range, const range< Dimensions - 1 > &Pitch, const property_list &PropList={}, const detail::code_location CodeLoc=detail::code_location::current())

	sampled_image (const sampled_image &rhs)=default

	sampled_image (sampled_image &&rhs)=default

sampled_image &	operator= (const sampled_image &rhs)=default

sampled_image &	operator= (sampled_image &&rhs)=default

	~sampled_image ()

bool	operator== (const sampled_image &rhs) const

bool	operator!= (const sampled_image &rhs) const

size_t	byte_size () const noexcept

template<typename DataT , image_target AccessTarget = image_target::device>
sampled_image_accessor< DataT, Dimensions, AccessTarget >	get_access (handler &CommandGroupHandlerRef, const property_list &PropList={}, const detail::code_location CodeLoc=detail::code_location::current())

template<typename DataT >
host_sampled_image_accessor< DataT, Dimensions >	get_host_access (const property_list &PropList={}, const detail::code_location CodeLoc=detail::code_location::current())

Public Member Functions inherited from sycl::_V1::detail::image_common< 1, sycl::image_allocator >
bool	has_property () const noexcept

propertyT	get_property () const

range< Dimensions >	get_range () const

std::enable_if_t< IsMultiDim, range< Dimensions - 1 > >	get_pitch () const

size_t	size () const noexcept

sycl::image_allocator	get_allocator () const

Public Member Functions inherited from sycl::_V1::detail::OwnerLessBase< sampled_image< 1, sycl::image_allocator > >
bool	ext_oneapi_owner_before (const ext::oneapi::detail::weak_object_base< sampled_image< 1, sycl::image_allocator > > &Other) const noexcept
	Compares the object against a weak object using an owner-based implementation-defined ordering. More...

bool	ext_oneapi_owner_before (const sampled_image< 1, sycl::image_allocator > &Other) const noexcept
	Compares the object against another object using an owner-based implementation-defined ordering. More...

Friends
template<typename DataT , int Dims>
class	host_sampled_image_accessor

template<typename DataT , int Dims, image_target AccessTarget>
class	sampled_image_accessor

template<class T >
T	detail::createSyclObjFromImpl (decltype(T::impl) ImplObj)

Additional Inherited Members
Protected Member Functions inherited from sycl::_V1::detail::image_common< 1, sycl::image_allocator >
	image_plain (const std::shared_ptr< detail::image_impl > &Impl)

	image_plain (image_channel_order Order, image_channel_type Type, const range< 3 > &Range, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList)

	image_plain (image_channel_order Order, image_channel_type Type, const range< 3 > &Range, const range< 2 > &Pitch, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList)

	image_plain (void *HostPointer, image_channel_order Order, image_channel_type Type, const range< 3 > &Range, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList)

	image_plain (const void *HostPointer, image_channel_order Order, image_channel_type Type, const range< 3 > &Range, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList)

	image_plain (void *HostPointer, image_channel_order Order, image_channel_type Type, const range< 3 > &Range, const range< 2 > &Pitch, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList)

	image_plain (const std::shared_ptr< const void > &HostPointer, image_channel_order Order, image_channel_type Type, const range< 3 > &Range, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList, bool IsConstPtr)

	image_plain (const std::shared_ptr< const void > &HostPointer, image_channel_order Order, image_channel_type Type, const range< 3 > &Range, const range< 2 > &Pitch, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList, bool IsConstPtr)

	image_plain (const void *HostPointer, image_channel_order Order, image_channel_type Type, image_sampler Sampler, const range< 3 > &Range, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList)

	image_plain (const void *HostPointer, image_channel_order Order, image_channel_type Type, image_sampler Sampler, const range< 3 > &Range, const range< 2 > &Pitch, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList)

	image_plain (const std::shared_ptr< const void > &HostPointer, image_channel_order Order, image_channel_type Type, image_sampler Sampler, const range< 3 > &Range, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList)

	image_plain (const std::shared_ptr< const void > &HostPointer, image_channel_order Order, image_channel_type Type, image_sampler Sampler, const range< 3 > &Range, const range< 2 > &Pitch, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList)

	image_plain (pi_native_handle MemObject, const context &SyclContext, event AvailableEvent, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, image_channel_order Order, image_channel_type Type, bool OwnNativeHandle, range< 3 > Range3WithOnes)

Protected Member Functions inherited from sycl::_V1::detail::image_plain
	image_plain (const std::shared_ptr< detail::image_impl > &Impl)

	image_plain (image_channel_order Order, image_channel_type Type, const range< 3 > &Range, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList)

	image_plain (image_channel_order Order, image_channel_type Type, const range< 3 > &Range, const range< 2 > &Pitch, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList)

	image_plain (void *HostPointer, image_channel_order Order, image_channel_type Type, const range< 3 > &Range, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList)

	image_plain (const void *HostPointer, image_channel_order Order, image_channel_type Type, const range< 3 > &Range, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList)

	image_plain (void *HostPointer, image_channel_order Order, image_channel_type Type, const range< 3 > &Range, const range< 2 > &Pitch, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList)

	image_plain (const std::shared_ptr< const void > &HostPointer, image_channel_order Order, image_channel_type Type, const range< 3 > &Range, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList, bool IsConstPtr)

	image_plain (const std::shared_ptr< const void > &HostPointer, image_channel_order Order, image_channel_type Type, const range< 3 > &Range, const range< 2 > &Pitch, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList, bool IsConstPtr)

	image_plain (const void *HostPointer, image_channel_order Order, image_channel_type Type, image_sampler Sampler, const range< 3 > &Range, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList)

	image_plain (const void *HostPointer, image_channel_order Order, image_channel_type Type, image_sampler Sampler, const range< 3 > &Range, const range< 2 > &Pitch, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList)

	image_plain (const std::shared_ptr< const void > &HostPointer, image_channel_order Order, image_channel_type Type, image_sampler Sampler, const range< 3 > &Range, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList)

	image_plain (const std::shared_ptr< const void > &HostPointer, image_channel_order Order, image_channel_type Type, image_sampler Sampler, const range< 3 > &Range, const range< 2 > &Pitch, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, const property_list &PropList)

	image_plain (pi_native_handle MemObject, const context &SyclContext, event AvailableEvent, std::unique_ptr< SYCLMemObjAllocator > Allocator, uint8_t Dimensions, image_channel_order Order, image_channel_type Type, bool OwnNativeHandle, range< 3 > Range3WithOnes)

template<typename propertyT >
bool	has_property () const noexcept

template<typename propertyT >
propertyT	get_property () const

range< 3 >	get_range () const

range< 2 >	get_pitch () const

size_t	get_size () const noexcept

size_t	get_count () const noexcept

void	set_final_data_internal ()

void	set_final_data_internal (const std::function< void(const std::function< void(void *const Ptr)> &)> &FinalDataFunc)

void	set_write_back (bool flag)

const std::unique_ptr< SYCLMemObjAllocator > &	get_allocator_internal () const

size_t	getElementSize () const

size_t	getRowPitch () const

size_t	getSlicePitch () const

image_sampler	getSampler () const noexcept

image_channel_order	getChannelOrder () const

image_channel_type	getChannelType () const

void	sampledImageConstructorNotification (const detail::code_location &CodeLoc, void UserObj, const void HostObj, uint32_t Dim, size_t Range[3], image_format Format, const image_sampler &Sampler)

void	sampledImageDestructorNotification (void *UserObj)

void	unsampledImageConstructorNotification (const detail::code_location &CodeLoc, void UserObj, const void HostObj, uint32_t Dim, size_t Range[3], image_format Format)

void	unsampledImageDestructorNotification (void *UserObj)

Protected Attributes inherited from sycl::_V1::detail::image_plain
std::shared_ptr< detail::image_impl >	impl

Detailed Description

template<int Dimensions = 1, typename AllocatorT = sycl::image_allocator>
class sycl::_V1::sampled_image< Dimensions, AllocatorT >

Definition at line 1008 of file image.hpp.

Constructor & Destructor Documentation

◆ sampled_image() [1/6]

template<int Dimensions = 1, typename AllocatorT = sycl::image_allocator>

sycl::_V1::sampled_image< Dimensions, AllocatorT >::sampled_image	(	const void *	HostPointer,
		image_format	Format,
		image_sampler	Sampler,
		const range< Dimensions > &	Range,
		const property_list &	PropList = `{}`,
		const detail::code_location	CodeLoc = `detail::code_location::current()`
	)

inline

Definition at line 1018 of file image.hpp.

◆ sampled_image() [2/6]

template<int Dimensions = 1, typename AllocatorT = sycl::image_allocator>

template<bool IsMultiDim = (Dimensions > 1), typename = std::enable_if_t<IsMultiDim>>

sycl::_V1::sampled_image< Dimensions, AllocatorT >::sampled_image	(	const void *	HostPointer,
		image_format	Format,
		image_sampler	Sampler,
		const range< Dimensions > &	Range,
		const range< Dimensions - 1 > &	Pitch,
		const property_list &	PropList = `{}`,
		const detail::code_location	CodeLoc = `detail::code_location::current()`
	)

inline

Definition at line 1035 of file image.hpp.

◆ sampled_image() [3/6]

template<int Dimensions = 1, typename AllocatorT = sycl::image_allocator>

sycl::_V1::sampled_image< Dimensions, AllocatorT >::sampled_image	(	std::shared_ptr< const void > &	HostPointer,
		image_format	Format,
		image_sampler	Sampler,
		const range< Dimensions > &	Range,
		const property_list &	PropList = `{}`,
		const detail::code_location	CodeLoc = `detail::code_location::current()`
	)

inline

Definition at line 1052 of file image.hpp.

◆ sampled_image() [4/6]

template<int Dimensions = 1, typename AllocatorT = sycl::image_allocator>

template<bool IsMultiDim = (Dimensions > 1), typename = std::enable_if_t<IsMultiDim>>

sycl::_V1::sampled_image< Dimensions, AllocatorT >::sampled_image	(	std::shared_ptr< const void > &	HostPointer,
		image_format	Format,
		image_sampler	Sampler,
		const range< Dimensions > &	Range,
		const range< Dimensions - 1 > &	Pitch,
		const property_list &	PropList = `{}`,
		const detail::code_location	CodeLoc = `detail::code_location::current()`
	)

inline

Definition at line 1070 of file image.hpp.

◆ sampled_image() [5/6]

template<int Dimensions = 1, typename AllocatorT = sycl::image_allocator>

sycl::_V1::sampled_image< Dimensions, AllocatorT >::sampled_image ( const sampled_image< Dimensions, AllocatorT > & rhs )

default

◆ sampled_image() [6/6]

template<int Dimensions = 1, typename AllocatorT = sycl::image_allocator>

sycl::_V1::sampled_image< Dimensions, AllocatorT >::sampled_image ( sampled_image< Dimensions, AllocatorT > && rhs )

default

◆ ~sampled_image()

template<int Dimensions = 1, typename AllocatorT = sycl::image_allocator>

sycl::_V1::sampled_image< Dimensions, AllocatorT >::~sampled_image ( )

inline

Definition at line 1097 of file image.hpp.

Member Function Documentation

◆ byte_size()

template<int Dimensions = 1, typename AllocatorT = sycl::image_allocator>

size_t sycl::_V1::sampled_image< Dimensions, AllocatorT >::byte_size ( ) const

inlinenoexcept

Definition at line 1107 of file image.hpp.

◆ get_access()

template<int Dimensions = 1, typename AllocatorT = sycl::image_allocator>

template<typename DataT , image_target AccessTarget = image_target::device>

sampled_image_accessor<DataT, Dimensions, AccessTarget> sycl::_V1::sampled_image< Dimensions, AllocatorT >::get_access	(	handler &	CommandGroupHandlerRef,
		const property_list &	PropList = `{}`,
		const detail::code_location	CodeLoc = `detail::code_location::current()`
	)

inline

Definition at line 1110 of file image.hpp.

◆ get_host_access()

template<int Dimensions = 1, typename AllocatorT = sycl::image_allocator>

template<typename DataT >

host_sampled_image_accessor<DataT, Dimensions> sycl::_V1::sampled_image< Dimensions, AllocatorT >::get_host_access	(	const property_list &	PropList = `{}`,
		const detail::code_location	CodeLoc = `detail::code_location::current()`
	)

inline

Definition at line 1117 of file image.hpp.

◆ operator!=()

template<int Dimensions = 1, typename AllocatorT = sycl::image_allocator>

bool sycl::_V1::sampled_image< Dimensions, AllocatorT >::operator!= ( const sampled_image< Dimensions, AllocatorT > & rhs ) const

inline

Definition at line 1105 of file image.hpp.

◆ operator=() [1/2]

template<int Dimensions = 1, typename AllocatorT = sycl::image_allocator>

sampled_image& sycl::_V1::sampled_image< Dimensions, AllocatorT >::operator= ( const sampled_image< Dimensions, AllocatorT > & rhs )

default

◆ operator=() [2/2]

template<int Dimensions = 1, typename AllocatorT = sycl::image_allocator>

sampled_image& sycl::_V1::sampled_image< Dimensions, AllocatorT >::operator= ( sampled_image< Dimensions, AllocatorT > && rhs )

default

◆ operator==()

template<int Dimensions = 1, typename AllocatorT = sycl::image_allocator>

bool sycl::_V1::sampled_image< Dimensions, AllocatorT >::operator== ( const sampled_image< Dimensions, AllocatorT > & rhs ) const

inline

Definition at line 1101 of file image.hpp.

References sycl::_V1::detail::image_plain::impl.

Friends And Related Function Documentation

◆ detail::createSyclObjFromImpl

template<int Dimensions = 1, typename AllocatorT = sycl::image_allocator>

template<class T >

T detail::createSyclObjFromImpl ( decltype(T::impl) ImplObj )

friend

◆ host_sampled_image_accessor

template<int Dimensions = 1, typename AllocatorT = sycl::image_allocator>

template<typename DataT , int Dims>

friend class host_sampled_image_accessor

friend

Definition at line 1130 of file image.hpp.

◆ sampled_image_accessor

template<int Dimensions = 1, typename AllocatorT = sycl::image_allocator>

template<typename DataT , int Dims, image_target AccessTarget>

friend class sampled_image_accessor

friend

Definition at line 1133 of file image.hpp.

The documentation for this class was generated from the following file:

include/sycl/image.hpp

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

template<int Dimensions = 1, typename AllocatorT = sycl::image_allocator> class sycl::_V1::sampled_image< Dimensions, AllocatorT >

Constructor & Destructor Documentation

◆ sampled_image() [1/6]

◆ sampled_image() [2/6]

◆ sampled_image() [3/6]

◆ sampled_image() [4/6]

◆ sampled_image() [5/6]

◆ sampled_image() [6/6]

◆ ~sampled_image()

Member Function Documentation

◆ byte_size()

◆ get_access()

◆ get_host_access()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

Friends And Related Function Documentation

◆ detail::createSyclObjFromImpl

◆ host_sampled_image_accessor

◆ sampled_image_accessor

template<int Dimensions = 1, typename AllocatorT = sycl::image_allocator>
class sycl::_V1::sampled_image< Dimensions, AllocatorT >