Defines a shared image data. More...

#include <sycl/image.hpp>

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

[legend]

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

[legend]

Public Member Functions
	image (image_channel_order Order, image_channel_type Type, const range< Dimensions > &Range, const property_list &PropList={})

	image (image_channel_order Order, image_channel_type Type, const range< Dimensions > &Range, AllocatorT Allocator, const property_list &PropList={})

template<bool B = (Dimensions > 1)>
	image (image_channel_order Order, image_channel_type Type, const range< Dimensions > &Range, const typename std::enable_if_t< B, range< Dimensions - 1 >> &Pitch, const property_list &PropList={})

template<bool B = (Dimensions > 1)>
	image (image_channel_order Order, image_channel_type Type, const range< Dimensions > &Range, const typename std::enable_if_t< B, range< Dimensions - 1 >> &Pitch, AllocatorT Allocator, const property_list &PropList={})

	image (void *HostPointer, image_channel_order Order, image_channel_type Type, const range< Dimensions > &Range, const property_list &PropList={})

	image (void *HostPointer, image_channel_order Order, image_channel_type Type, const range< Dimensions > &Range, AllocatorT Allocator, const property_list &PropList={})

	image (const void *HostPointer, image_channel_order Order, image_channel_type Type, const range< Dimensions > &Range, const property_list &PropList={})

	image (const void *HostPointer, image_channel_order Order, image_channel_type Type, const range< Dimensions > &Range, AllocatorT Allocator, const property_list &PropList={})

template<bool B = (Dimensions > 1)>
	image (void *HostPointer, image_channel_order Order, image_channel_type Type, const range< Dimensions > &Range, const typename std::enable_if_t< B, range< Dimensions - 1 >> &Pitch, const property_list &PropList={})

template<bool B = (Dimensions > 1)>
	image (void *HostPointer, image_channel_order Order, image_channel_type Type, const range< Dimensions > &Range, const typename std::enable_if_t< B, range< Dimensions - 1 >> &Pitch, AllocatorT Allocator, const property_list &PropList={})

	image (std::shared_ptr< void > &HostPointer, image_channel_order Order, image_channel_type Type, const range< Dimensions > &Range, const property_list &PropList={})

	image (std::shared_ptr< void > &HostPointer, image_channel_order Order, image_channel_type Type, const range< Dimensions > &Range, AllocatorT Allocator, const property_list &PropList={})

template<bool B = (Dimensions > 1)>
	image (std::shared_ptr< void > &HostPointer, image_channel_order Order, image_channel_type Type, const range< Dimensions > &Range, const typename std::enable_if_t< B, range< Dimensions - 1 >> &Pitch, const property_list &PropList={})

template<bool B = (Dimensions > 1)>
	image (std::shared_ptr< void > &HostPointer, image_channel_order Order, image_channel_type Type, const range< Dimensions > &Range, const typename std::enable_if_t< B, range< Dimensions - 1 >> &Pitch, AllocatorT Allocator, const property_list &PropList={})

	image (const image &rhs)=default

	image (image &&rhs)=default

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

image &	operator= (image &&rhs)=default

	~image ()=default

bool	operator== (const image &rhs) const

bool	operator!= (const image &rhs) const

template<typename propertyT >
bool	has_property () const noexcept

template<typename propertyT >
propertyT	get_property () const

range< Dimensions >	get_range () const

template<bool B = (Dimensions > 1)>
std::enable_if_t< B, range< Dimensions - 1 > >	get_pitch () const

size_t	get_size () const

	__SYCL2020_DEPRECATED ("get_count() is deprecated, please use size() instead") size_t get_count() const

template<typename DataT , access::mode AccessMode>
accessor< detail::EnableIfImgAccDataT< DataT >, Dimensions, AccessMode, access::target::image, access::placeholder::false_t, ext::oneapi::accessor_property_list<> >	get_access (handler &commandGroupHandler)

template<typename DataT , access::mode AccessMode>
accessor< detail::EnableIfImgAccDataT< DataT >, Dimensions, AccessMode, access::target::host_image, access::placeholder::false_t, ext::oneapi::accessor_property_list<> >	get_access ()

Public Member Functions inherited from sycl::_V1::detail::unsampled_image_common< 1, sycl::image_allocator >
void	set_final_data (Destination finalData=nullptr)

void	set_write_back (bool flag=true)

Public Member Functions inherited from sycl::_V1::detail::image_common< Dimensions, AllocatorT >
template<typename propertyT >
bool	has_property () const noexcept

template<typename propertyT >
propertyT	get_property () const

range< Dimensions >	get_range () const

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

size_t	size () const noexcept

AllocatorT	get_allocator () const

Friends
template<typename DataT , int Dims, access::mode AccMode, access::target AccTarget, access::placeholder IsPlaceholder, typename PropertyListT >
class	accessor

template<typename DataT , int Dims, access::mode AccMode, access::target AccTarget, access::placeholder IsPlaceholder>
class	detail::image_accessor

template<backend Backend, int D, typename A >
std::enable_if_t< detail::InteropFeatureSupportMap< Backend >::MakeImage==true &&Backend !=backend::ext_oneapi_level_zero, image< D, A > >	make_image (const typename backend_traits< Backend >::template input_type< image< D, A >> &BackendObject, const context &TargetContext, event AvailableEvent)

template<backend Backend, int D, typename A >
std::enable_if_t< Backend==backend::ext_oneapi_level_zero, image< D, A > >	make_image (const backend_input_t< Backend, image< D, A >> &BackendObject, const context &TargetContext, event AvailableEvent)

Additional Inherited Members
Protected Member Functions inherited from sycl::_V1::detail::image_common< Dimensions, AllocatorT >
	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::image< Dimensions, AllocatorT >

Defines a shared image data.

Images can be 1-, 2-, and 3-dimensional. They have to be accessed using the accessor class.

See also: Accessors; sampler

Definition at line 443 of file image.hpp.

Constructor & Destructor Documentation

◆ image() [1/16]

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

sycl::_V1::image< Dimensions, AllocatorT >::image	(	image_channel_order	Order,
		image_channel_type	Type,
		const range< Dimensions > &	Range,
		const property_list &	PropList = `{}`
	)

inline

Definition at line 449 of file image.hpp.

◆ image() [2/16]

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

sycl::_V1::image< Dimensions, AllocatorT >::image	(	image_channel_order	Order,
		image_channel_type	Type,
		const range< Dimensions > &	Range,
		AllocatorT	Allocator,
		const property_list &	PropList = `{}`
	)

inline

Definition at line 456 of file image.hpp.

◆ image() [3/16]

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

template<bool B = (Dimensions > 1)>

sycl::_V1::image< Dimensions, AllocatorT >::image	(	image_channel_order	Order,
		image_channel_type	Type,
		const range< Dimensions > &	Range,
		const typename std::enable_if_t< B, range< Dimensions - 1 >> &	Pitch,
		const property_list &	PropList = `{}`
	)

inline

Definition at line 467 of file image.hpp.

◆ image() [4/16]

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

template<bool B = (Dimensions > 1)>

sycl::_V1::image< Dimensions, AllocatorT >::image	(	image_channel_order	Order,
		image_channel_type	Type,
		const range< Dimensions > &	Range,
		const typename std::enable_if_t< B, range< Dimensions - 1 >> &	Pitch,
		AllocatorT	Allocator,
		const property_list &	PropList = `{}`
	)

inline

Definition at line 479 of file image.hpp.

◆ image() [5/16]

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

sycl::_V1::image< Dimensions, AllocatorT >::image	(	void *	HostPointer,
		image_channel_order	Order,
		image_channel_type	Type,
		const range< Dimensions > &	Range,
		const property_list &	PropList = `{}`
	)

inline

Definition at line 490 of file image.hpp.

◆ image() [6/16]

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

sycl::_V1::image< Dimensions, AllocatorT >::image	(	void *	HostPointer,
		image_channel_order	Order,
		image_channel_type	Type,
		const range< Dimensions > &	Range,
		AllocatorT	Allocator,
		const property_list &	PropList = `{}`
	)

inline

Definition at line 498 of file image.hpp.

◆ image() [7/16]

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

sycl::_V1::image< Dimensions, AllocatorT >::image	(	const void *	HostPointer,
		image_channel_order	Order,
		image_channel_type	Type,
		const range< Dimensions > &	Range,
		const property_list &	PropList = `{}`
	)

inline

Definition at line 507 of file image.hpp.

◆ image() [8/16]

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

sycl::_V1::image< Dimensions, AllocatorT >::image	(	const void *	HostPointer,
		image_channel_order	Order,
		image_channel_type	Type,
		const range< Dimensions > &	Range,
		AllocatorT	Allocator,
		const property_list &	PropList = `{}`
	)

inline

Definition at line 516 of file image.hpp.

◆ image() [9/16]

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

template<bool B = (Dimensions > 1)>

sycl::_V1::image< Dimensions, AllocatorT >::image	(	void *	HostPointer,
		image_channel_order	Order,
		image_channel_type	Type,
		const range< Dimensions > &	Range,
		const typename std::enable_if_t< B, range< Dimensions - 1 >> &	Pitch,
		const property_list &	PropList = `{}`
	)

inline

Definition at line 527 of file image.hpp.

◆ image() [10/16]

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

template<bool B = (Dimensions > 1)>

sycl::_V1::image< Dimensions, AllocatorT >::image	(	void *	HostPointer,
		image_channel_order	Order,
		image_channel_type	Type,
		const range< Dimensions > &	Range,
		const typename std::enable_if_t< B, range< Dimensions - 1 >> &	Pitch,
		AllocatorT	Allocator,
		const property_list &	PropList = `{}`
	)

inline

Definition at line 540 of file image.hpp.

◆ image() [11/16]

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

sycl::_V1::image< Dimensions, AllocatorT >::image	(	std::shared_ptr< void > &	HostPointer,
		image_channel_order	Order,
		image_channel_type	Type,
		const range< Dimensions > &	Range,
		const property_list &	PropList = `{}`
	)

inline

Definition at line 551 of file image.hpp.

◆ image() [12/16]

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

sycl::_V1::image< Dimensions, AllocatorT >::image	(	std::shared_ptr< void > &	HostPointer,
		image_channel_order	Order,
		image_channel_type	Type,
		const range< Dimensions > &	Range,
		AllocatorT	Allocator,
		const property_list &	PropList = `{}`
	)

inline

Definition at line 560 of file image.hpp.

◆ image() [13/16]

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

template<bool B = (Dimensions > 1)>

sycl::_V1::image< Dimensions, AllocatorT >::image	(	std::shared_ptr< void > &	HostPointer,
		image_channel_order	Order,
		image_channel_type	Type,
		const range< Dimensions > &	Range,
		const typename std::enable_if_t< B, range< Dimensions - 1 >> &	Pitch,
		const property_list &	PropList = `{}`
	)

inline

Definition at line 571 of file image.hpp.

◆ image() [14/16]

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

template<bool B = (Dimensions > 1)>

sycl::_V1::image< Dimensions, AllocatorT >::image	(	std::shared_ptr< void > &	HostPointer,
		image_channel_order	Order,
		image_channel_type	Type,
		const range< Dimensions > &	Range,
		const typename std::enable_if_t< B, range< Dimensions - 1 >> &	Pitch,
		AllocatorT	Allocator,
		const property_list &	PropList = `{}`
	)

inline

Definition at line 584 of file image.hpp.

◆ image() [15/16]

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

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

default

◆ image() [16/16]

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

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

default

◆ ~image()

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

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

default

Member Function Documentation

◆ __SYCL2020_DEPRECATED()

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

sycl::_V1::image< Dimensions, AllocatorT >::__SYCL2020_DEPRECATED	(	"get_count() is	deprecated,
		please use size() instead"
	)		const

inline

Definition at line 644 of file image.hpp.

◆ get_access() [1/2]

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

template<typename DataT , access::mode AccessMode>

accessor<detail::EnableIfImgAccDataT<DataT>, Dimensions, AccessMode, access::target::host_image, access::placeholder::false_t, ext::oneapi::accessor_property_list<> > sycl::_V1::image< Dimensions, AllocatorT >::get_access ( )

inline

Definition at line 662 of file image.hpp.

References sycl::_V1::AccessMode, sycl::_V1::Dimensions, sycl::_V1::access::false_t, and sycl::_V1::access::host_image.

◆ get_access() [2/2]

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

template<typename DataT , access::mode AccessMode>

accessor<detail::EnableIfImgAccDataT<DataT>, Dimensions, AccessMode, access::target::image, access::placeholder::false_t, ext::oneapi::accessor_property_list<> > sycl::_V1::image< Dimensions, AllocatorT >::get_access ( handler & commandGroupHandler )

inline

Definition at line 651 of file image.hpp.

References sycl::_V1::AccessMode, sycl::_V1::Dimensions, sycl::_V1::access::false_t, and sycl::_V1::access::image.

◆ get_pitch()

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

template<bool B = (Dimensions > 1)>

std::enable_if_t<B, range<Dimensions - 1> > sycl::_V1::image< Dimensions, AllocatorT >::get_pitch ( ) const

inline

Definition at line 635 of file image.hpp.

References sycl::_V1::detail::convertToArrayOfN(), sycl::_V1::Dimensions, and syclcompat::detail::get_pitch().

◆ get_property()

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

template<typename propertyT >

propertyT sycl::_V1::image< Dimensions, AllocatorT >::get_property ( ) const

inline

Definition at line 625 of file image.hpp.

◆ get_range()

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

range<Dimensions> sycl::_V1::image< Dimensions, AllocatorT >::get_range ( ) const

inline

Definition at line 629 of file image.hpp.

◆ get_size()

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

size_t sycl::_V1::image< Dimensions, AllocatorT >::get_size ( ) const

inline

Definition at line 641 of file image.hpp.

◆ has_property()

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

template<typename propertyT >

bool sycl::_V1::image< Dimensions, AllocatorT >::has_property ( ) const

inlinenoexcept

Definition at line 621 of file image.hpp.

◆ operator!=()

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

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

inline

Definition at line 618 of file image.hpp.

◆ operator=() [1/2]

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

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

default

◆ operator=() [2/2]

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

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

default

◆ operator==()

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

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

inline

Definition at line 616 of file image.hpp.

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

Friends And Related Function Documentation

◆ accessor

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

template<typename DataT , int Dims, access::mode AccMode, access::target AccTarget, access::placeholder IsPlaceholder, typename PropertyListT >

friend class accessor

friend

Definition at line 718 of file image.hpp.

◆ detail::image_accessor

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

template<typename DataT , int Dims, access::mode AccMode, access::target AccTarget, access::placeholder IsPlaceholder>

friend class detail::image_accessor

friend

Definition at line 722 of file image.hpp.

◆ make_image [1/2]

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

template<backend Backend, int D, typename A >

std::enable_if_t<Backend == backend::ext_oneapi_level_zero, image<D, A> > make_image	(	const backend_input_t< Backend, image< D, A >> &	BackendObject,
		const context &	TargetContext,
		event	AvailableEvent
	)

friend

◆ make_image [2/2]

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

template<backend Backend, int D, typename A >

std::enable_if_t< detail::InteropFeatureSupportMap<Backend>::MakeImage == true && Backend != backend::ext_oneapi_level_zero, image<D, A> > make_image	(	const typename backend_traits< Backend >::template input_type< image< D, A >> &	BackendObject,
		const context &	TargetContext,
		event	AvailableEvent
	)

friend

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::image< Dimensions, AllocatorT >

Constructor & Destructor Documentation

◆ image() [1/16]

◆ image() [2/16]

◆ image() [3/16]

◆ image() [4/16]

◆ image() [5/16]

◆ image() [6/16]

◆ image() [7/16]

◆ image() [8/16]

◆ image() [9/16]

◆ image() [10/16]

◆ image() [11/16]

◆ image() [12/16]

◆ image() [13/16]

◆ image() [14/16]

◆ image() [15/16]

◆ image() [16/16]

◆ ~image()

Member Function Documentation

◆ __SYCL2020_DEPRECATED()

◆ get_access() [1/2]

◆ get_access() [2/2]

◆ get_pitch()

◆ get_property()

◆ get_range()

◆ get_size()

◆ has_property()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

Friends And Related Function Documentation

◆ accessor

◆ detail::image_accessor

◆ make_image [1/2]

◆ make_image [2/2]

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