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 (cl_mem ClMemObject, const context &SyclContext, event AvailableEvent={})

	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.