Defines a shared image data. More...

#include <CL/sycl/detail/image_impl.hpp>

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 detail::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 detail::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 detail::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 detail::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 detail::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 detail::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

template<typename propertyT >
propertyT	get_property () const

range< Dimensions >	get_range () const

template<bool B = (Dimensions > 1)>
detail::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

size_t	size () const noexcept

AllocatorT	get_allocator () 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 ()

template<typename Destination = std::nullptr_t>
void	set_final_data (Destination finalData=nullptr)

void	set_write_back (bool flag=true)

Detailed Description

template<int Dimensions = 1, typename AllocatorT = cl::sycl::image_allocator>
class cl::sycl::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 29 of file image_impl.hpp.

Constructor & Destructor Documentation

◆ image() [1/16]

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

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

inline

Definition at line 75 of file image.hpp.

◆ image() [2/16]

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

cl::sycl::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 83 of file image.hpp.

◆ image() [3/16]

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

template<bool B = (Dimensions > 1)>

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

inline

Definition at line 95 of file image.hpp.

◆ image() [4/16]

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

template<bool B = (Dimensions > 1)>

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

inline

Definition at line 107 of file image.hpp.

◆ image() [5/16]

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

cl::sycl::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 118 of file image.hpp.

◆ image() [6/16]

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

cl::sycl::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 126 of file image.hpp.

◆ image() [7/16]

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

cl::sycl::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 136 of file image.hpp.

◆ image() [8/16]

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

cl::sycl::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 145 of file image.hpp.

◆ image() [9/16]

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

template<bool B = (Dimensions > 1)>

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

inline

Definition at line 157 of file image.hpp.

◆ image() [10/16]

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

template<bool B = (Dimensions > 1)>

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

inline

Definition at line 169 of file image.hpp.

◆ image() [11/16]

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

cl::sycl::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 180 of file image.hpp.

◆ image() [12/16]

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

cl::sycl::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 189 of file image.hpp.

◆ image() [13/16]

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

template<bool B = (Dimensions > 1)>

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

inline

Definition at line 201 of file image.hpp.

◆ image() [14/16]

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

template<bool B = (Dimensions > 1)>

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

inline

Definition at line 213 of file image.hpp.

◆ image() [15/16]

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

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

default

◆ image() [16/16]

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

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

default

◆ ~image()

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

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

default

Member Function Documentation

◆ __SYCL2020_DEPRECATED()

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

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

inline

Definition at line 270 of file image.hpp.

◆ get_access() [1/2]

template<int Dimensions = 1, typename AllocatorT = cl::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<> > cl::sycl::image< Dimensions, AllocatorT >::get_access ( )

inline

Definition at line 294 of file image.hpp.

References cl::sycl::Dimensions.

◆ get_access() [2/2]

template<int Dimensions = 1, typename AllocatorT = cl::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<> > cl::sycl::image< Dimensions, AllocatorT >::get_access ( handler & commandGroupHandler )

inline

Definition at line 283 of file image.hpp.

References cl::sycl::Dimensions.

◆ get_allocator()

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

AllocatorT cl::sycl::image< Dimensions, AllocatorT >::get_allocator ( ) const

inline

Definition at line 275 of file image.hpp.

◆ get_pitch()

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

template<bool B = (Dimensions > 1)>

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

inline

Definition at line 262 of file image.hpp.

◆ get_property()

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

template<typename propertyT >

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

inline

Definition at line 254 of file image.hpp.

◆ get_range()

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

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

inline

Definition at line 258 of file image.hpp.

◆ get_size()

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

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

inline

Definition at line 267 of file image.hpp.

◆ has_property()

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

template<typename propertyT >

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

inline

Definition at line 250 of file image.hpp.

◆ operator!=()

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

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

inline

Definition at line 247 of file image.hpp.

◆ operator=() [1/2]

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

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

default

◆ operator=() [2/2]

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

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

default

◆ operator==()

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

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

inline

Definition at line 245 of file image.hpp.

◆ set_final_data()

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

template<typename Destination = std::nullptr_t>

void cl::sycl::image< Dimensions, AllocatorT >::set_final_data ( Destination finalData = nullptr )

inline

Definition at line 301 of file image.hpp.

◆ set_write_back()

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

void cl::sycl::image< Dimensions, AllocatorT >::set_write_back ( bool flag = true )

inline

Definition at line 305 of file image.hpp.

◆ size()

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

size_t cl::sycl::image< Dimensions, AllocatorT >::size ( ) const

inlinenoexcept

Definition at line 272 of file image.hpp.

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

include/CL/sycl/detail/image_impl.hpp
include/CL/sycl/image.hpp

Public Member Functions

Detailed Description

template<int Dimensions = 1, typename AllocatorT = cl::sycl::image_allocator> class cl::sycl::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_allocator()

◆ get_pitch()

◆ get_property()

◆ get_range()

◆ get_size()

◆ has_property()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ set_final_data()

◆ set_write_back()

◆ size()

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