sycl::_V1::accessor< DataT, Dimensions, AccessMode, access::target::host_image, IsPlaceholder > Class Template Reference

Host image accessor. More...

#include <sycl/accessor.hpp>

Inheritance diagram for sycl::_V1::accessor< DataT, Dimensions, AccessMode, access::target::host_image, IsPlaceholder >:

Collaboration diagram for sycl::_V1::accessor< DataT, Dimensions, AccessMode, access::target::host_image, IsPlaceholder >:

Public Member Functions
template<typename AllocatorT >
	accessor (sycl::image< Dimensions, AllocatorT > &Image)
template<typename AllocatorT >
	accessor (sycl::image< Dimensions, AllocatorT > &Image, const property_list &propList)
Public Member Functions inherited from sycl::_V1::detail::image_accessor< DataT, Dimensions, AccessMode, access::target::host_image, IsPlaceholder >
	image_accessor (image< Dims, AllocatorT > &ImageRef, int ImageElementSize)
	image_accessor (image< Dims, AllocatorT > &ImageRef, handler &CommandGroupHandlerRef, int ImageElementSize)
bool	operator== (const image_accessor &Rhs) const
bool	operator!= (const image_accessor &Rhs) const
	__SYCL2020_DEPRECATED ("get_count() is deprecated, please use size() instead") size_t get_count() const
size_t	size () const noexcept
range< Dims >	get_range () const
DataT	read (const CoordT &Coords) const
DataT	read (const CoordT &Coords, const sampler &Smpl) const
void	write (const CoordT &Coords, const DataT &Color) const
Public Member Functions inherited from sycl::_V1::detail::AccessorBaseHost
	AccessorBaseHost (id< 3 > Offset, range< 3 > AccessRange, range< 3 > MemoryRange, access::mode AccessMode, void *SYCLMemObject, int Dims, int ElemSize, int OffsetInBytes=0, bool IsSubBuffer=false, const property_list &PropertyList={})
	AccessorBaseHost (id< 3 > Offset, range< 3 > AccessRange, range< 3 > MemoryRange, access::mode AccessMode, void *SYCLMemObject, int Dims, int ElemSize, bool IsPlaceH, int OffsetInBytes=0, bool IsSubBuffer=false, const property_list &PropertyList={})
	AccessorBaseHost (id< 3 > Offset, range< 3 > AccessRange, range< 3 > MemoryRange, access::mode AccessMode, void *SYCLMemObject, int Dims, int ElemSize, size_t OffsetInBytes=0, bool IsSubBuffer=false, const property_list &PropertyList={})
	AccessorBaseHost (id< 3 > Offset, range< 3 > AccessRange, range< 3 > MemoryRange, access::mode AccessMode, void *SYCLMemObject, int Dims, int ElemSize, bool IsPlaceH, size_t OffsetInBytes=0, bool IsSubBuffer=false, const property_list &PropertyList={})
id< 3 > &	getOffset ()
range< 3 > &	getAccessRange ()
range< 3 > &	getMemoryRange ()
void *	getPtr () noexcept
unsigned int	getElemSize () const
const id< 3 > &	getOffset () const
const range< 3 > &	getAccessRange () const
const range< 3 > &	getMemoryRange () const
void *	getPtr () const noexcept
bool	isPlaceholder () const
bool	isMemoryObjectUsedByGraph () const
detail::AccHostDataT &	getAccData ()
const property_list &	getPropList () const
void *	getMemoryObject () const
template<class Obj >
decltype(Obj::impl) friend	getSyclObjImpl (const Obj &SyclObject)
Public Member Functions inherited from sycl::_V1::detail::OwnerLessBase< accessor< DataT, Dimensions, AccessMode, access::target::host_image, IsPlaceholder > >
bool	ext_oneapi_owner_before (const ext::oneapi::detail::weak_object_base< accessor< DataT, Dimensions, AccessMode, access::target::host_image, IsPlaceholder > > &Other) const noexcept
	Compares the object against a weak object using an owner-based implementation-defined ordering. More...
bool	ext_oneapi_owner_before (const accessor< DataT, Dimensions, AccessMode, access::target::host_image, IsPlaceholder > &Other) const noexcept
	Compares the object against another object using an owner-based implementation-defined ordering. More...

Additional Inherited Members
Public Types inherited from sycl::_V1::detail::image_accessor< DataT, Dimensions, AccessMode, access::target::host_image, IsPlaceholder >
using	value_type = DataT
using	reference = DataT &
using	const_reference = const DataT &
Public Attributes inherited from sycl::_V1::detail::AccessorBaseHost
AccessorImplPtr	impl
Protected Member Functions inherited from sycl::_V1::detail::image_accessor< DataT, Dimensions, AccessMode, access::target::host_image, IsPlaceholder >
	image_accessor (const AccessorImplPtr &Impl)
Protected Member Functions inherited from sycl::_V1::detail::AccessorBaseHost
	AccessorBaseHost (const AccessorImplPtr &Impl)

Detailed Description

template<typename DataT, int Dimensions, access::mode AccessMode, access::placeholder IsPlaceholder>
class sycl::_V1::accessor< DataT, Dimensions, AccessMode, access::target::host_image, IsPlaceholder >

Host image accessor.

Available only when accessTarget == access::target::host_image.

See also

image

Definition at line 3297 of file accessor.hpp.

Constructor & Destructor Documentation

accessor() [1/2]

template<typename DataT , int Dimensions, access::mode AccessMode, access::placeholder IsPlaceholder>

template<typename AllocatorT >

sycl::_V1::accessor< DataT, Dimensions, AccessMode, access::target::host_image, IsPlaceholder >::accessor ( sycl::image< Dimensions, AllocatorT > &  Image )

inline

Definition at line 3306 of file accessor.hpp.

accessor() [2/2]

template<typename DataT , int Dimensions, access::mode AccessMode, access::placeholder IsPlaceholder>

template<typename AllocatorT >

sycl::_V1::accessor< DataT, Dimensions, AccessMode, access::target::host_image, IsPlaceholder >::accessor ( sycl::image< Dimensions, AllocatorT > &  Image, const property_list &  propList  )

inline

Definition at line 3312 of file accessor.hpp.

---

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

• include/sycl/accessor.hpp